cargo/diagnostics/rules/
non_kebab_case_packages.rs

1use std::path::Path;
2
3use cargo_util_terminal::report::AnnotationKind;
4use cargo_util_terminal::report::Group;
5use cargo_util_terminal::report::Level;
6use cargo_util_terminal::report::Origin;
7use cargo_util_terminal::report::Patch;
8use cargo_util_terminal::report::Snippet;
9use tracing::instrument;
10
11use super::RESTRICTION;
12use crate::CargoResult;
13use crate::GlobalContext;
14use crate::diagnostics::Lint;
15use crate::diagnostics::LintLevel;
16use crate::diagnostics::LintLevelProduct;
17use crate::diagnostics::LintLevelSource;
18use crate::diagnostics::ScopedDiagnosticStats;
19use crate::diagnostics::get_key_value_span;
20use crate::diagnostics::workspace_rel_path;
21use crate::workspace::Package;
22use crate::workspace::Workspace;
23
24pub static LINT: &Lint = &Lint {
25    name: "non_kebab_case_packages",
26    primary_group: &RESTRICTION,
27    msrv: None,
28    feature_gate: None,
29    docs: Some(
30        r#"
31### What it does
32
33Detect package names that are not kebab-case.
34
35### Why restrict this?
36
37Having multiple naming styles within a workspace can be confusing.
38
39### Drawbacks
40
41Users have to mentally translate package names to namespaces in Rust.
42
43### Example
44
45```toml
46[package]
47name = "foo_bar"
48```
49
50Should be written as:
51
52```toml
53[package]
54name = "foo-bar"
55```
56"#,
57    ),
58};
59
60#[instrument(skip_all)]
61pub(crate) fn lint_package(
62    ws: &Workspace<'_>,
63    pkg: &Package,
64    manifest_path: &Path,
65    level: LintLevelProduct,
66    pkg_stats: &mut ScopedDiagnosticStats<'_>,
67    gctx: &GlobalContext,
68) -> CargoResult<()> {
69    let LintLevelProduct {
70        level: lint_level,
71        source,
72    } = level;
73
74    let manifest_path = workspace_rel_path(ws, manifest_path);
75
76    lint_package_inner(pkg, &manifest_path, lint_level, source, pkg_stats, gctx)
77}
78
79fn lint_package_inner(
80    pkg: &Package,
81    manifest_path: &str,
82    lint_level: LintLevel,
83    source: LintLevelSource,
84    pkg_stats: &mut ScopedDiagnosticStats<'_>,
85    gctx: &GlobalContext,
86) -> CargoResult<()> {
87    let manifest = pkg.manifest();
88
89    let original_name = &*manifest.name();
90    let kebab_case = heck::ToKebabCase::to_kebab_case(original_name);
91    if kebab_case == original_name {
92        return Ok(());
93    }
94
95    let document = manifest.document();
96    let contents = manifest.contents();
97    let level = lint_level.to_diagnostic_level();
98    let emitted_source = LINT.emitted_source(lint_level, source);
99
100    let mut primary = Group::with_title(level.primary_title(format!(
101        "package `{original_name}` should have a kebab-case name"
102    )));
103    if let Some(document) = document
104        && let Some(contents) = contents
105        && let Some(span) = get_key_value_span(document, &["package", "name"])
106    {
107        primary = primary.element(
108            Snippet::source(contents)
109                .path(manifest_path)
110                .annotation(AnnotationKind::Primary.span(span.value)),
111        );
112    } else {
113        primary = primary.element(Origin::path(manifest_path));
114    }
115    primary = primary.element(Level::NOTE.message(emitted_source));
116    let mut report = vec![primary];
117    if let Some(document) = document
118        && let Some(contents) = contents
119        && let Some(span) = get_key_value_span(document, &["package", "name"])
120    {
121        let mut help = Group::with_title(Level::HELP.secondary_title(format!(
122            "to change the package name to `{kebab_case}`, convert `package.name`"
123        )));
124        help = help.element(
125            Snippet::source(contents)
126                .path(manifest_path)
127                .patch(Patch::new(span.value, format!("\"{kebab_case}\""))),
128        );
129        report.push(help);
130    } else {
131        let path = pkg.manifest_path();
132        let display_path = path.as_os_str().to_string_lossy();
133        let end = display_path.len() - if display_path.ends_with(".rs") { 3 } else { 0 };
134        let start = path
135            .parent()
136            .map(|p| {
137                let p = p.as_os_str().to_string_lossy();
138                // Account for trailing slash that was removed
139                p.len() + if p.is_empty() { 0 } else { 1 }
140            })
141            .unwrap_or(0);
142        let help = Level::HELP
143            .secondary_title(format!(
144                "to change the package name to `{kebab_case}`, convert the file stem"
145            ))
146            .element(Snippet::source(display_path).patch(Patch::new(start..end, kebab_case)));
147        report.push(help);
148    }
149
150    pkg_stats.record_lint(lint_level);
151    gctx.shell().print_report(&report, lint_level.force())?;
152
153    Ok(())
154}
cargo/diagnostics/rules/non_kebab_case_packages.rs

cargo/diagnostics/rules/
non_kebab_case_packages.rs
