cargo/diagnostics/rules/
non_kebab_case_features.rs

1use std::path::Path;
2
3use cargo_util_schemas::manifest::TomlToolLints;
4use cargo_util_terminal::report::AnnotationKind;
5use cargo_util_terminal::report::Group;
6use cargo_util_terminal::report::Level;
7use cargo_util_terminal::report::Origin;
8use cargo_util_terminal::report::Patch;
9use cargo_util_terminal::report::Snippet;
10use tracing::instrument;
11
12use super::RESTRICTION;
13use crate::CargoResult;
14use crate::GlobalContext;
15use crate::core::Package;
16use crate::diagnostics::DiagnosticStats;
17use crate::diagnostics::Lint;
18use crate::diagnostics::LintLevel;
19use crate::diagnostics::LintLevelSource;
20use crate::diagnostics::get_key_value_span;
21use crate::diagnostics::rel_cwd_manifest_path;
22
23pub static LINT: &Lint = &Lint {
24    name: "non_kebab_case_features",
25    desc: "features should have a kebab-case name",
26    primary_group: &RESTRICTION,
27    msrv: None,
28    feature_gate: None,
29    docs: Some(
30        r#"
31### What it does
32
33Detect feature names that are not kebab-case.
34
35### Why it is bad
36
37Having multiple naming styles within a workspace can be confusing.
38
39### Drawbacks
40
41Users would expect that a feature tightly coupled to a dependency would match the dependency's name.
42
43### Example
44
45```toml
46[features]
47foo_bar = []
48```
49
50Should be written as:
51
52```toml
53[features]
54foo-bar = []
55```
56"#,
57    ),
58};
59
60#[instrument(skip_all)]
61pub fn non_kebab_case_features(
62    pkg: &Package,
63    manifest_path: &Path,
64    cargo_lints: &TomlToolLints,
65    stats: &mut DiagnosticStats,
66    gctx: &GlobalContext,
67) -> CargoResult<()> {
68    let (lint_level, source) = LINT.level(
69        cargo_lints,
70        pkg.rust_version(),
71        pkg.manifest().unstable_features(),
72    );
73
74    if lint_level == LintLevel::Allow {
75        return Ok(());
76    }
77
78    let manifest_path = rel_cwd_manifest_path(manifest_path, gctx);
79
80    lint_package(pkg, &manifest_path, lint_level, source, stats, gctx)
81}
82
83fn lint_package(
84    pkg: &Package,
85    manifest_path: &str,
86    lint_level: LintLevel,
87    source: LintLevelSource,
88    stats: &mut DiagnosticStats,
89    gctx: &GlobalContext,
90) -> CargoResult<()> {
91    for original_name in pkg.summary().features().keys() {
92        let original_name = &**original_name;
93        let kebab_case = heck::ToKebabCase::to_kebab_case(original_name);
94        if kebab_case == original_name {
95            continue;
96        }
97
98        let manifest = pkg.manifest();
99        let document = manifest.document();
100        let contents = manifest.contents();
101        let level = lint_level.to_diagnostic_level();
102        let emitted_source = LINT.emitted_source(lint_level, source);
103
104        let mut primary = Group::with_title(level.primary_title(LINT.desc));
105        if let Some(document) = document
106            && let Some(contents) = contents
107            && let Some(span) = get_key_value_span(document, &["features", original_name])
108        {
109            primary = primary.element(
110                Snippet::source(contents)
111                    .path(manifest_path)
112                    .annotation(AnnotationKind::Primary.span(span.key)),
113            );
114        } else if let Some(document) = document
115            && let Some(contents) = contents
116            && let Some(dep_span) = get_key_value_span(document, &["dependencies", original_name])
117            && let Some(optional_span) =
118                get_key_value_span(document, &["dependencies", original_name, "optional"])
119        {
120            primary = primary.element(
121                Snippet::source(contents)
122                    .path(manifest_path)
123                    .annotation(AnnotationKind::Primary.span(dep_span.key).label("source of feature name"))
124                    .annotation(
125                        AnnotationKind::Context
126                            .span(optional_span.key.start..optional_span.value.end)
127                            .label("cause of feature"),
128                    ),
129            ).element(Level::NOTE.message("see also <https://doc.rust-lang.org/cargo/reference/features.html#optional-dependencies>"));
130        } else {
131            primary = primary.element(Origin::path(manifest_path));
132        }
133        primary = primary.element(Level::NOTE.message(emitted_source));
134        let mut report = vec![primary];
135        if let Some(document) = document
136            && let Some(contents) = contents
137            && let Some(span) = get_key_value_span(document, &["features", original_name])
138        {
139            let mut help = Group::with_title(Level::HELP.secondary_title(
140                "to change the feature name to kebab case, convert the `features` key",
141            ));
142            help = help.element(
143                Snippet::source(contents)
144                    .path(manifest_path)
145                    .patch(Patch::new(span.key, kebab_case.as_str())),
146            );
147            report.push(help);
148        }
149
150        stats.record_lint(lint_level);
151        gctx.shell().print_report(&report, lint_level.force())?;
152    }
153
154    Ok(())
155}
cargo/diagnostics/rules/non_kebab_case_features.rs

cargo/diagnostics/rules/
non_kebab_case_features.rs
