cargo/diagnostics/rules/
unused_workspace_package_fields.rs

1use std::path::Path;
2
3use crate::util::data_structures::IndexSet;
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::Snippet;
9use tracing::instrument;
10
11use super::SUSPICIOUS;
12use crate::CargoResult;
13use crate::GlobalContext;
14use crate::core::MaybePackage;
15use crate::core::Workspace;
16use crate::diagnostics::Lint;
17use crate::diagnostics::LintLevelProduct;
18use crate::diagnostics::ScopedDiagnosticStats;
19use crate::diagnostics::get_key_value_span;
20use crate::diagnostics::workspace_rel_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    feature_gate: None,
28    docs: Some(
29        r#"
30### What it does
31Checks for any fields in `[workspace.package]` that has not been inherited
32
33### Why it is bad
34They can give the false impression that these fields are used
35
36### Example
37```toml
38[workspace.package]
39edition = "2024"
40
41[package]
42name = "foo"
43```
44"#,
45    ),
46};
47
48#[instrument(skip_all)]
49pub(crate) fn lint_workspace(
50    ws: &Workspace<'_>,
51    maybe_pkg: &MaybePackage,
52    manifest_path: &Path,
53    level: LintLevelProduct,
54    pkg_stats: &mut ScopedDiagnosticStats<'_>,
55    gctx: &GlobalContext,
56) -> CargoResult<()> {
57    let LintLevelProduct {
58        level: lint_level,
59        source,
60    } = level;
61
62    let workspace_package_fields: IndexSet<_> = maybe_pkg
63        .document()
64        .and_then(|d| d.get_ref().get("workspace"))
65        .and_then(|w| w.get_ref().get("package"))
66        .and_then(|p| p.get_ref().as_table())
67        .iter()
68        .flat_map(|d| d.keys())
69        .collect();
70
71    let mut inherited_fields = IndexSet::default();
72    for member in ws.members() {
73        inherited_fields.extend(
74            member
75                .manifest()
76                .document()
77                .and_then(|w| w.get_ref().get("package"))
78                .and_then(|p| p.get_ref().as_table())
79                .iter()
80                .flat_map(|d| {
81                    d.iter()
82                        .filter(|(_, v)| {
83                            v.get_ref()
84                                .get("workspace")
85                                .and_then(|w| w.get_ref().as_bool())
86                                == Some(true)
87                        })
88                        .map(|(k, _)| k)
89                }),
90        );
91    }
92
93    for (i, unused) in workspace_package_fields
94        .difference(&inherited_fields)
95        .enumerate()
96    {
97        let document = maybe_pkg.document();
98        let contents = maybe_pkg.contents();
99        let level = lint_level.to_diagnostic_level();
100        let manifest_path = workspace_rel_path(ws, manifest_path);
101        let emitted_source = LINT.emitted_source(lint_level, source);
102
103        let mut primary = Group::with_title(level.primary_title(LINT.desc));
104        if let Some(document) = document
105            && let Some(contents) = contents
106        {
107            let mut snippet = Snippet::source(contents).path(&manifest_path);
108            if let Some(span) =
109                get_key_value_span(document, &["workspace", "package", unused.as_ref()])
110            {
111                snippet = snippet.annotation(AnnotationKind::Primary.span(span.key));
112            }
113            primary = primary.element(snippet);
114        } else {
115            primary = primary.element(Origin::path(&manifest_path));
116        }
117        if i == 0 {
118            primary = primary.element(Level::NOTE.message(emitted_source));
119        }
120        let mut report = vec![primary];
121        let help =
122            Group::with_title(Level::HELP.secondary_title("consider removing the unused field"));
123        report.push(help);
124
125        pkg_stats.record_lint(lint_level);
126        gctx.shell().print_report(&report, lint_level.force())?;
127    }
128
129    Ok(())
130}
cargo/diagnostics/rules/unused_workspace_package_fields.rs

cargo/diagnostics/rules/
unused_workspace_package_fields.rs
