cargo/lints/rules/
unused_workspace_package_fields.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;
10use indexmap::IndexSet;
11
12use crate::CargoResult;
13use crate::GlobalContext;
14use crate::core::MaybePackage;
15use crate::core::Workspace;
16use crate::lints::Lint;
17use crate::lints::LintLevel;
18use crate::lints::SUSPICIOUS;
19use crate::lints::get_key_value_span;
20use crate::lints::rel_cwd_manifest_path;
21
22pub static LINT: &Lint = &Lint {
23    name: "unused_workspace_package_fields",
24    desc: "unused field in `workspace.package`",
25    primary_group: &SUSPICIOUS,
26    msrv: Some(super::CARGO_LINTS_MSRV),
27    edition_lint_opts: None,
28    feature_gate: None,
29    docs: Some(
30        r#"
31### What it does
32Checks for any fields in `[workspace.package]` that has not been inherited
33
34### Why it is bad
35They can give the false impression that these fields are used
36
37### Example
38```toml
39[workspace.package]
40edition = "2024"
41
42[package]
43name = "foo"
44```
45"#,
46    ),
47};
48
49pub fn unused_workspace_package_fields(
50    ws: &Workspace<'_>,
51    maybe_pkg: &MaybePackage,
52    manifest_path: &Path,
53    cargo_lints: &TomlToolLints,
54    error_count: &mut usize,
55    gctx: &GlobalContext,
56) -> CargoResult<()> {
57    let (lint_level, reason) = LINT.level(
58        cargo_lints,
59        ws.lowest_rust_version(),
60        maybe_pkg.edition(),
61        maybe_pkg.unstable_features(),
62    );
63    if lint_level == LintLevel::Allow {
64        return Ok(());
65    }
66
67    let workspace_package_fields: IndexSet<_> = maybe_pkg
68        .document()
69        .and_then(|d| d.get_ref().get("workspace"))
70        .and_then(|w| w.get_ref().get("package"))
71        .and_then(|p| p.get_ref().as_table())
72        .iter()
73        .flat_map(|d| d.keys())
74        .collect();
75
76    let mut inherited_fields = IndexSet::new();
77    for member in ws.members() {
78        inherited_fields.extend(
79            member
80                .manifest()
81                .document()
82                .and_then(|w| w.get_ref().get("package"))
83                .and_then(|p| p.get_ref().as_table())
84                .iter()
85                .flat_map(|d| {
86                    d.iter()
87                        .filter(|(_, v)| {
88                            v.get_ref()
89                                .get("workspace")
90                                .and_then(|w| w.get_ref().as_bool())
91                                == Some(true)
92                        })
93                        .map(|(k, _)| k)
94                }),
95        );
96    }
97
98    for (i, unused) in workspace_package_fields
99        .difference(&inherited_fields)
100        .enumerate()
101    {
102        let document = maybe_pkg.document();
103        let contents = maybe_pkg.contents();
104        let level = lint_level.to_diagnostic_level();
105        let manifest_path = rel_cwd_manifest_path(manifest_path, gctx);
106        let emitted_source = LINT.emitted_source(lint_level, reason);
107
108        let mut primary = Group::with_title(level.primary_title(LINT.desc));
109        if let Some(document) = document
110            && let Some(contents) = contents
111        {
112            let mut snippet = Snippet::source(contents).path(&manifest_path);
113            if let Some(span) =
114                get_key_value_span(document, &["workspace", "package", unused.as_ref()])
115            {
116                snippet = snippet.annotation(AnnotationKind::Primary.span(span.key));
117            }
118            primary = primary.element(snippet);
119        } else {
120            primary = primary.element(Origin::path(&manifest_path));
121        }
122        if i == 0 {
123            primary = primary.element(Level::NOTE.message(emitted_source));
124        }
125        let mut report = vec![primary];
126        if let Some(document) = document
127            && let Some(contents) = contents
128        {
129            let mut help = Group::with_title(
130                Level::HELP.secondary_title("consider removing the unused field"),
131            );
132            let mut snippet = Snippet::source(contents).path(&manifest_path);
133            if let Some(span) =
134                get_key_value_span(document, &["workspace", "package", unused.as_ref()])
135            {
136                snippet = snippet.patch(Patch::new(span.key.start..span.value.end, ""));
137            }
138            help = help.element(snippet);
139            report.push(help);
140        }
141
142        if lint_level.is_error() {
143            *error_count += 1;
144        }
145        gctx.shell().print_report(&report, lint_level.force())?;
146    }
147
148    Ok(())
149}
cargo/lints/rules/unused_workspace_package_fields.rs

cargo/lints/rules/
unused_workspace_package_fields.rs
