mirror of https://github.com/leonardomso/rust-skills.git synced 2026-09-14 19:33:21 +08:00

Files

T

Leonardo Maldonado 0016d5cfb2 Add comprehensive Rust best practices skill with 179 rules

Includes rules for:
- Ownership and borrowing patterns
- Error handling with thiserror/anyhow
- Memory management and allocation
- API design following Rust guidelines
- Async/Tokio patterns
- Performance optimization
- Naming conventions
- Type safety
- Testing strategies
- Documentation standards
- Project structure
- Linting configuration
- Common anti-patterns to avoid

2026-01-19 10:23:19 -03:00

3.1 KiB

Raw Blame History

lint-pedantic-selective

Enable clippy::pedantic selectively

Why It Matters

The clippy::pedantic group contains opinionated lints that aren't universally applicable. Enabling it wholesale produces noise; selectively enabling useful pedantic lints improves code quality without false positives.

Bad

// Too noisy - will fight you constantly
#![warn(clippy::pedantic)]

Good

# Cargo.toml - cherry-pick useful pedantic lints
[lints.clippy]
# Enable pedantic as baseline
pedantic = "warn"

# Disable noisy ones
missing_errors_doc = "allow"      # Document errors separately
missing_panics_doc = "allow"      # Document panics separately
module_name_repetitions = "allow" # Allow Foo::FooError pattern
too_many_lines = "allow"          # Function length varies
must_use_candidate = "allow"      # Too many suggestions

Recommended Pedantic Lints

Lint	Why Enable
`doc_markdown`	Catch unmarked code in docs
`match_wildcard_for_single_variants`	Explicit variant matching
`semicolon_if_nothing_returned`	Consistent semicolons
`string_add_assign`	Use `+=` for string concatenation
`unnested_or_patterns`	Simplify match patterns
`unused_self`	Catch methods that should be functions
`used_underscore_binding`	Warn on using `_var`
`wildcard_imports`	Avoid glob imports

Often Disabled

Lint	Why Disable
`missing_errors_doc`	Handle with `#[doc]` policy
`missing_panics_doc`	Handle with `#[doc]` policy
`module_name_repetitions`	Sometimes intentional
`must_use_candidate`	Too aggressive
`too_many_lines`	Arbitrary threshold
`struct_excessive_bools`	Valid for config structs

Full Configuration

# Cargo.toml
[lints.clippy]
# Start with pedantic
pedantic = "warn"

# Keep these
doc_markdown = "warn"
match_wildcard_for_single_variants = "warn"
semicolon_if_nothing_returned = "warn"
unused_self = "warn"
wildcard_imports = "warn"

# Disable these
missing_errors_doc = "allow"
missing_panics_doc = "allow"
module_name_repetitions = "allow"
must_use_candidate = "allow"
too_many_lines = "allow"
similar_names = "allow"
struct_excessive_bools = "allow"

Alternative: Explicit Opt-in

# Only enable specific lints, not the group
[lints.clippy]
# From pedantic, only these:
doc_markdown = "warn"
semicolon_if_nothing_returned = "warn"
unused_self = "warn"
wildcard_imports = "warn"

Module-Level Overrides

// Allow specific lint for a module
#![allow(clippy::module_name_repetitions)]

// Or for specific items
#[allow(clippy::too_many_arguments)]
fn complex_function(/* many args */) { }

Team Consensus

Pedantic lints are style choices. Agree as a team:

Enable pedantic as baseline
Run cargo clippy on codebase
Discuss each warning category
Disable ones that don't fit your style
Document decisions in clippy.toml

3.1 KiB Raw Blame History