cargo/lints/rules/
non_kebab_case_packages.rs

1use std::path::Path;
2
3use annotate_snippets::AnnotationKind;
4use annotate_snippets::Group;
5use annotate_snippets::Level;
6use annotate_snippets::Origin;
7use annotate_snippets::Patch;
8use annotate_snippets::Snippet;
9use cargo_util_schemas::manifest::TomlToolLints;
10
11use crate::CargoResult;
12use crate::GlobalContext;
13use crate::core::Package;
14use crate::lints::Lint;
15use crate::lints::LintLevel;
16use crate::lints::LintLevelReason;
17use crate::lints::RESTRICTION;
18use crate::lints::get_key_value_span;
19use crate::lints::rel_cwd_manifest_path;
20
21pub const LINT: Lint = Lint {
22    name: "non_kebab_case_packages",
23    desc: "packages should have a kebab-case name",
24    primary_group: &RESTRICTION,
25    edition_lint_opts: None,
26    feature_gate: None,
27    docs: Some(
28        r#"
29### What it does
30
31Detect package names that are not kebab-case.
32
33### Why it is bad
34
35Having multiple naming styles within a workspace can be confusing.
36
37### Drawbacks
38
39Users have to mentally translate package names to namespaces in Rust.
40
41### Example
42
43```toml
44[package]
45name = "foo_bar"
46```
47
48Should be written as:
49
50```toml
51[package]
52name = "foo-bar"
53```
54"#,
55    ),
56};
57
58pub fn non_kebab_case_packages(
59    pkg: &Package,
60    manifest_path: &Path,
61    cargo_lints: &TomlToolLints,
62    error_count: &mut usize,
63    gctx: &GlobalContext,
64) -> CargoResult<()> {
65    let (lint_level, reason) = LINT.level(
66        cargo_lints,
67        pkg.manifest().edition(),
68        pkg.manifest().unstable_features(),
69    );
70
71    if lint_level == LintLevel::Allow {
72        return Ok(());
73    }
74
75    let manifest_path = rel_cwd_manifest_path(manifest_path, gctx);
76
77    lint_package(pkg, &manifest_path, lint_level, reason, error_count, gctx)
78}
79
80pub fn lint_package(
81    pkg: &Package,
82    manifest_path: &str,
83    lint_level: LintLevel,
84    reason: LintLevelReason,
85    error_count: &mut usize,
86    gctx: &GlobalContext,
87) -> CargoResult<()> {
88    let manifest = pkg.manifest();
89
90    let original_name = &*manifest.name();
91    let kebab_case = heck::ToKebabCase::to_kebab_case(original_name);
92    if kebab_case == original_name {
93        return Ok(());
94    }
95
96    let document = manifest.document();
97    let contents = manifest.contents();
98    let level = lint_level.to_diagnostic_level();
99    let emitted_source = LINT.emitted_source(lint_level, reason);
100
101    let mut primary = Group::with_title(level.primary_title(LINT.desc));
102    if let Some(document) = document
103        && let Some(contents) = contents
104        && let Some(span) = get_key_value_span(document, &["package", "name"])
105    {
106        primary = primary.element(
107            Snippet::source(contents)
108                .path(manifest_path)
109                .annotation(AnnotationKind::Primary.span(span.value)),
110        );
111    } else {
112        primary = primary.element(Origin::path(manifest_path));
113    }
114    primary = primary.element(Level::NOTE.message(emitted_source));
115    let mut report = vec![primary];
116    if let Some(document) = document
117        && let Some(contents) = contents
118        && let Some(span) = get_key_value_span(document, &["package", "name"])
119    {
120        let mut help =
121            Group::with_title(Level::HELP.secondary_title(
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("to change the package name to kebab case, convert the file stem")
144            .element(Snippet::source(display_path).patch(Patch::new(start..end, kebab_case)));
145        report.push(help);
146    }
147
148    if lint_level.is_error() {
149        *error_count += 1;
150    }
151    gctx.shell().print_report(&report, lint_level.force())?;
152
153    Ok(())
154}
cargo/lints/rules/non_kebab_case_packages.rs

cargo/lints/rules/
non_kebab_case_packages.rs
