Crate convention_lint

Expand description

§convention-lint

A file-naming convention linter for Rust projects, configurable via Cargo.toml metadata.

It enforces naming conventions (like snake_case or CamelCase) for any files in your project, not just Rust source files. It uses parallel directory traversal (same as ripgrep) and respects .gitignore.

§Configuration

Add [[package.metadata.convention-lint.checks]] or [[workspace.metadata.convention-lint.checks]] entries to your Cargo.toml.

§Example

[[workspace.metadata.convention-lint.checks]]
dirs      = ["src/idl", "proto"]
include   = ["*.idl", "*.proto"]
exclude   = ["**/legacy_*.proto"]
format    = "snake_case"
recursive = true

§Configuration Fields

Field	Required	Default	Description
`dirs`	Yes	—	Directories to scan. Supports globs like `src//tests`. Cannot be empty.*
`include`	No	`["*"]`	Glob patterns for files to check (e.g. `["*.rs"]`).
`exclude`	No	`[]`	Glob patterns for files to skip (takes priority over `include`).
`format`	Yes	—	Convention to enforce: `snake_case`, `CamelCase`, `camelCase`, `SCREAMING_SNAKE_CASE`, `kebab-case`.
`recursive`	No	`true`	If `false`, the linter won’t enter subdirectories.

§Pattern Matching Rules

Patterns in include and exclude are matched against the full relative path //! from the project root.

Pattern	Match Type	Description
`*.rs`	Extension	Any `.rs` file in any directory.
`generated.rs`	Exact File	Only `generated.rs` in the project root.
`**/generated.rs`	Floating File	Any file named `generated.rs` anywhere in the project.
`/tests/`	Directory	Entire directory and all its contents.

Note: To exclude an entire directory, always end the pattern with /**.

§Supported Conventions

Identifier	Example
`snake_case`	`my_service`
`CamelCase`	`MyService` (Alias: `PascalCase`)
`camelCase`	`myService`
`SCREAMING_SNAKE_CASE`	`MY_SERVICE`
`kebab-case`	`my-service`

§Usage

Install the tool:

cargo install convention-lint

Run it in your project root:

cargo convention-lint

§Library Usage

use convention_lint::{config::load_config, lint::run};
use std::path::Path;

let manifest_path = Path::new("Cargo.toml");
let project_root = Path::new(".");

let cfg = load_config(manifest_path)?;
let violations = run(&cfg, project_root);

for v in &violations {
    eprintln!("{v}");
}

if !violations.is_empty() {
    std::process::exit(1);
}

Re-exports§

pub use crate::core::Convention;
pub use crate::error::Error;
pub use crate::lint::Violation;

Modules§

config: Configuration loading from Cargo.toml metadata.
core: Naming convention definitions and stem validation.
error: Error types for convention-lint.
lint: Core linting logic — filesystem walk and violation collection.