feat(lints): Add `non_*_case_features` #16560

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

weihanglo merged 3 commits into rust-lang:master from epage:features

Jan 26, 2026

+582 −0

src/cargo/core/workspace.rs

-Original file line number
+Diff line change
@@ Expand Up / @@ -26,7 +26,9 @@ use crate::lints::rules::blanket_hint_mostly_unused; @@
     use crate::lints::rules::check_im_a_teapot;
     use crate::lints::rules::implicit_minimum_version_req;
     use crate::lints::rules::non_kebab_case_bins;
+    use crate::lints::rules::non_kebab_case_features;
     use crate::lints::rules::non_kebab_case_packages;
+    use crate::lints::rules::non_snake_case_features;
     use crate::lints::rules::non_snake_case_packages;
     use crate::lints::rules::redundant_readme;
     use crate::ops;
@@ Expand Down Expand Up / @@ -1380,6 +1382,20 @@ impl<'gctx> Workspace<'gctx> { @@
                     &mut run_error_count,
                     self.gctx,
                 )?;
+                non_kebab_case_features(
+                    pkg.into(),
+                    &path,
+                    &cargo_lints,
+                    &mut run_error_count,
+                    self.gctx,
+                )?;
+                non_snake_case_features(
+                    pkg.into(),
+                    &path,
+                    &cargo_lints,
+                    &mut run_error_count,
+                    self.gctx,
+                )?;
                 redundant_readme(
                     pkg.into(),
                     &path,
@@ Expand Down @@

src/cargo/lints/rules/mod.rs

-Original file line number
+Diff line change
@@ Expand Up / @@ -2,7 +2,9 @@ mod blanket_hint_mostly_unused; @@
     mod im_a_teapot;
     mod implicit_minimum_version_req;
     mod non_kebab_case_bins;
+    mod non_kebab_case_features;
     mod non_kebab_case_packages;
+    mod non_snake_case_features;
     mod non_snake_case_packages;
     mod redundant_readme;
     mod unknown_lints;
@@ Expand All @@
     pub use im_a_teapot::check_im_a_teapot;
     pub use implicit_minimum_version_req::implicit_minimum_version_req;
     pub use non_kebab_case_bins::non_kebab_case_bins;
+    pub use non_kebab_case_features::non_kebab_case_features;
     pub use non_kebab_case_packages::non_kebab_case_packages;
+    pub use non_snake_case_features::non_snake_case_features;
     pub use non_snake_case_packages::non_snake_case_packages;
     pub use redundant_readme::redundant_readme;
     pub use unknown_lints::output_unknown_lints;
@@ Expand All / @@ -21,7 +25,9 @@ pub const LINTS: &[crate::lints::Lint] = &[ @@
         implicit_minimum_version_req::LINT,
         im_a_teapot::LINT,
         non_kebab_case_bins::LINT,
+        non_kebab_case_features::LINT,
         non_kebab_case_packages::LINT,
+        non_snake_case_features::LINT,
         non_snake_case_packages::LINT,
         redundant_readme::LINT,
         unknown_lints::LINT,
@@ Expand Down @@

src/cargo/lints/rules/non_kebab_case_features.rs

-Original file line number
+Diff line change
@@ -0,0 +1,154 @@
+    use std::path::Path;
+    use annotate_snippets::AnnotationKind;
+    use annotate_snippets::Group;
+    use annotate_snippets::Level;
+    use annotate_snippets::Origin;
+    use annotate_snippets::Patch;
+    use annotate_snippets::Snippet;
+    use cargo_util_schemas::manifest::TomlToolLints;
+    use crate::CargoResult;
+    use crate::GlobalContext;
+    use crate::core::Package;
+    use crate::lints::Lint;
+    use crate::lints::LintLevel;
+    use crate::lints::LintLevelReason;
+    use crate::lints::RESTRICTION;
+    use crate::lints::get_key_value_span;
+    use crate::lints::rel_cwd_manifest_path;
+    pub const LINT: Lint = Lint {
+        name: "non_kebab_case_features",
+        desc: "features should have a kebab-case name",
+        primary_group: &RESTRICTION,
+        edition_lint_opts: None,
+        feature_gate: None,
+        docs: Some(
+            r#"
+    ### What it does
+    Detect feature names that are not kebab-case.
+    ### Why it is bad
+    Having multiple naming styles within a workspace can be confusing.
+    ### Drawbacks
+    Users would expect that a feature tightly coupled to a dependency would match the dependency's name.
+    ### Example
+    ```toml
+    [features]
+    foo_bar = []
+    ```
+    Should be written as:
+    ```toml
+    [features]
+    foo-bar = []
+    ```
+    "#,
+        ),
+    };
+    pub fn non_kebab_case_features(
+        pkg: &Package,
+        manifest_path: &Path,
+        cargo_lints: &TomlToolLints,
+        error_count: &mut usize,
+        gctx: &GlobalContext,
+    ) -> CargoResult<()> {
+        let (lint_level, reason) = LINT.level(
+            cargo_lints,
+            pkg.manifest().edition(),
+            pkg.manifest().unstable_features(),
+        );
+        if lint_level == LintLevel::Allow {
+            return Ok(());
+        }
+        let manifest_path = rel_cwd_manifest_path(manifest_path, gctx);
+        lint_package(pkg, &manifest_path, lint_level, reason, error_count, gctx)
+    }
+    pub fn lint_package(
+        pkg: &Package,
+        manifest_path: &str,
+        lint_level: LintLevel,
+        reason: LintLevelReason,
+        error_count: &mut usize,
+        gctx: &GlobalContext,
+    ) -> CargoResult<()> {
+        for original_name in pkg.summary().features().keys() {
+            let original_name = &**original_name;
+            let kebab_case = heck::ToKebabCase::to_kebab_case(original_name);
+            if kebab_case == original_name {
+                continue;
+            }
+            let manifest = pkg.manifest();
+            let document = manifest.document();
+            let contents = manifest.contents();
+            let level = lint_level.to_diagnostic_level();
+            let emitted_source = LINT.emitted_source(lint_level, reason);
+            let mut primary = Group::with_title(level.primary_title(LINT.desc));
+            if let Some(document) = document
+                && let Some(contents) = contents
+                && let Some(span) = get_key_value_span(document, &["features", original_name])
+            {
+                primary = primary.element(
+                    Snippet::source(contents)
+                        .path(manifest_path)
+                        .annotation(AnnotationKind::Primary.span(span.key)),
+                );
+            } else if let Some(document) = document
+                && let Some(contents) = contents
+                && let Some(dep_span) = get_key_value_span(document, &["dependencies", original_name])
+                && let Some(optional_span) =
+                    get_key_value_span(document, &["dependencies", original_name, "optional"])
+            {
+                primary = primary.element(
+                    Snippet::source(contents)
+                        .path(manifest_path)
+                        .annotation(AnnotationKind::Primary.span(dep_span.key).label("source of feature name"))
+                        .annotation(
+                            AnnotationKind::Context
+                                .span(optional_span.key.start..optional_span.value.end)
+                                .label("cause of feature"),
+                        ),
+                ).element(Level::NOTE.message("see also <https://doc.rust-lang.org/cargo/reference/features.html#optional-dependencies>"));
+            } else {
+                primary = primary.element(Origin::path(manifest_path));
+            }
+            primary = primary.element(Level::NOTE.message(emitted_source));
+            let mut report = vec![primary];
+            if let Some(document) = document
+                && let Some(contents) = contents
+                && let Some(span) = get_key_value_span(document, &["features", original_name])
+            {
+                let mut help = Group::with_title(Level::HELP.secondary_title(
+                    "to change the feature name to kebab case, convert the `features` key",
+                ));
+                help = help.element(
+                    Snippet::source(contents)
+                        .path(manifest_path)
+                        .patch(Patch::new(span.key, kebab_case.as_str())),
+                );
+                report.push(help);
+            }
+            if lint_level.is_error() {
+                *error_count += 1;
+            }
+            gctx.shell().print_report(&report, lint_level.force())?;
+        }
+        Ok(())
+    }

src/cargo/lints/rules/non_snake_case_features.rs

-Original file line number
+Diff line change
@@ -0,0 +1,154 @@
+    use std::path::Path;
+    use annotate_snippets::AnnotationKind;
+    use annotate_snippets::Group;
+    use annotate_snippets::Level;
+    use annotate_snippets::Origin;
+    use annotate_snippets::Patch;
+    use annotate_snippets::Snippet;
+    use cargo_util_schemas::manifest::TomlToolLints;
+    use crate::CargoResult;
+    use crate::GlobalContext;
+    use crate::core::Package;
+    use crate::lints::Lint;
+    use crate::lints::LintLevel;
+    use crate::lints::LintLevelReason;
+    use crate::lints::RESTRICTION;
+    use crate::lints::get_key_value_span;
+    use crate::lints::rel_cwd_manifest_path;
+    pub const LINT: Lint = Lint {
+        name: "non_snake_case_features",
+        desc: "features should have a snake-case name",
+        primary_group: &RESTRICTION,
+        edition_lint_opts: None,
+        feature_gate: None,
+        docs: Some(
+            r#"
+    ### What it does
+    Detect feature names that are not snake-case.
+    ### Why it is bad
+    Having multiple naming styles within a workspace can be confusing.
+    ### Drawbacks
+    Users would expect that a feature tightly coupled to a dependency would match the dependency's name.
+    ### Example
+    ```toml
+    [features]
+    foo-bar = []
+    ```
+    Should be written as:
+    ```toml
+    [features]
+    foo_bar = []
+    ```
+    "#,
+        ),
+    };
+    pub fn non_snake_case_features(
+        pkg: &Package,
+        manifest_path: &Path,
+        cargo_lints: &TomlToolLints,
+        error_count: &mut usize,
+        gctx: &GlobalContext,
+    ) -> CargoResult<()> {
+        let (lint_level, reason) = LINT.level(
+            cargo_lints,
+            pkg.manifest().edition(),
+            pkg.manifest().unstable_features(),
+        );
+        if lint_level == LintLevel::Allow {
+            return Ok(());
+        }
+        let manifest_path = rel_cwd_manifest_path(manifest_path, gctx);
+        lint_package(pkg, &manifest_path, lint_level, reason, error_count, gctx)
+    }
+    pub fn lint_package(
+        pkg: &Package,
+        manifest_path: &str,
+        lint_level: LintLevel,
+        reason: LintLevelReason,
+        error_count: &mut usize,
+        gctx: &GlobalContext,
+    ) -> CargoResult<()> {
+        for original_name in pkg.summary().features().keys() {
+            let original_name = &**original_name;
+            let snake_case = heck::ToSnakeCase::to_snake_case(original_name);
+            if snake_case == original_name {
+                continue;
+            }
+            let manifest = pkg.manifest();
+            let document = manifest.document();
+            let contents = manifest.contents();
+            let level = lint_level.to_diagnostic_level();
+            let emitted_source = LINT.emitted_source(lint_level, reason);
+            let mut primary = Group::with_title(level.primary_title(LINT.desc));
+            if let Some(document) = document
+                && let Some(contents) = contents
+                && let Some(span) = get_key_value_span(document, &["features", original_name])
+            {
+                primary = primary.element(
+                    Snippet::source(contents)
+                        .path(manifest_path)
+                        .annotation(AnnotationKind::Primary.span(span.key)),
+                );
+            } else if let Some(document) = document
+                && let Some(contents) = contents
+                && let Some(dep_span) = get_key_value_span(document, &["dependencies", original_name])
+                && let Some(optional_span) =
+                    get_key_value_span(document, &["dependencies", original_name, "optional"])
+            {
+                primary = primary.element(
+                    Snippet::source(contents)
+                        .path(manifest_path)
+                        .annotation(AnnotationKind::Primary.span(dep_span.key).label("source of feature name"))
+                        .annotation(
+                            AnnotationKind::Context
+                                .span(optional_span.key.start..optional_span.value.end)
+                                .label("cause of feature"),
+                        ),
+                ).element(Level::NOTE.message("see also <https://doc.rust-lang.org/cargo/reference/features.html#optional-dependencies>"));
+            } else {
+                primary = primary.element(Origin::path(manifest_path));
+            }
+            primary = primary.element(Level::NOTE.message(emitted_source));
+            let mut report = vec![primary];
+            if let Some(document) = document
+                && let Some(contents) = contents
+                && let Some(span) = get_key_value_span(document, &["features", original_name])
+            {
+                let mut help = Group::with_title(Level::HELP.secondary_title(
+                    "to change the feature name to snake case, convert the `features` key",
+                ));
+                help = help.element(
+                    Snippet::source(contents)
+                        .path(manifest_path)
+                        .patch(Patch::new(span.key, snake_case.as_str())),
+                );
+                report.push(help);
+            }
+            if lint_level.is_error() {
+                *error_count += 1;
+            }
+            gctx.shell().print_report(&report, lint_level.force())?;
+        }
+        Ok(())
+    }

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(lints): Add `non_*_case_features` #16560

Diff view

Diff view

There are no files selected for viewing

Uh oh!

feat(lints): Add non_*_case_features #16560

feat(lints): Add non_*_case_features #16560

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

feat(lints): Add `non_*_case_features` #16560

feat(lints): Add `non_*_case_features` #16560