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

cargo/diagnostics/rules/
unused_workspace_package_fields.rs
