From dfc9bd2068a2ee022369530b8ddc4fd9a1b7177d Mon Sep 17 00:00:00 2001 From: Scott Schafer Date: Wed, 24 Apr 2024 14:04:00 -0600 Subject: [PATCH] feat(lints): Add where lint level was set --- src/cargo/util/lints.rs | 64 ++++++++++++++----- .../edition_2021_warn/stderr.term.svg | 2 +- .../edition_2024/stderr.term.svg | 2 +- .../renamed_deps/stderr.term.svg | 2 +- tests/testsuite/lints_table.rs | 8 +-- 5 files changed, 54 insertions(+), 24 deletions(-) diff --git a/src/cargo/util/lints.rs b/src/cargo/util/lints.rs index 453d8bd0c55..f177dac48e4 100644 --- a/src/cargo/util/lints.rs +++ b/src/cargo/util/lints.rs @@ -90,7 +90,7 @@ impl Lint { pkg_lints: &TomlToolLints, ws_lints: &TomlToolLints, edition: Edition, - ) -> LintLevel { + ) -> (LintLevel, LintLevelReason) { self.groups .iter() .map(|g| { @@ -117,8 +117,8 @@ impl Lint { edition, ), ))) - .max_by_key(|(n, (l, p))| (l == &LintLevel::Forbid, *p, std::cmp::Reverse(*n))) - .map(|(_, (l, _))| l) + .max_by_key(|(n, (l, _, p))| (l == &LintLevel::Forbid, *p, std::cmp::Reverse(*n))) + .map(|(_, (l, r, _))| (l, r)) .unwrap() } } @@ -164,6 +164,25 @@ impl From for LintLevel { } } +#[derive(Copy, Clone, Debug)] +pub enum LintLevelReason { + Default, + Edition(Edition), + Package, + Workspace, +} + +impl Display for LintLevelReason { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + match self { + LintLevelReason::Default => write!(f, "by default"), + LintLevelReason::Edition(edition) => write!(f, "in edition {}", edition), + LintLevelReason::Package => write!(f, "in `[lints]`"), + LintLevelReason::Workspace => write!(f, "in `[workspace.lints]`"), + } + } +} + fn level_priority( name: &str, default_level: LintLevel, @@ -171,27 +190,35 @@ fn level_priority( pkg_lints: &TomlToolLints, ws_lints: &TomlToolLints, edition: Edition, -) -> (LintLevel, i8) { - let unspecified_level = if let Some(level) = edition_lint_opts +) -> (LintLevel, LintLevelReason, i8) { + let (unspecified_level, reason) = if let Some(level) = edition_lint_opts .filter(|(e, _)| edition >= *e) .map(|(_, l)| l) { - level + (level, LintLevelReason::Edition(edition)) } else { - default_level + (default_level, LintLevelReason::Default) }; // Don't allow the group to be overridden if the level is `Forbid` if unspecified_level == LintLevel::Forbid { - return (unspecified_level, 0); + return (unspecified_level, reason, 0); } if let Some(defined_level) = pkg_lints.get(name) { - (defined_level.level().into(), defined_level.priority()) + ( + defined_level.level().into(), + LintLevelReason::Package, + defined_level.priority(), + ) } else if let Some(defined_level) = ws_lints.get(name) { - (defined_level.level().into(), defined_level.priority()) + ( + defined_level.level().into(), + LintLevelReason::Workspace, + defined_level.priority(), + ) } else { - (unspecified_level, 0) + (unspecified_level, reason, 0) } } @@ -212,7 +239,7 @@ pub fn check_im_a_teapot( gctx: &GlobalContext, ) -> CargoResult<()> { let manifest = pkg.manifest(); - let lint_level = IM_A_TEAPOT.level(pkg_lints, ws_lints, manifest.edition()); + let (lint_level, reason) = IM_A_TEAPOT.level(pkg_lints, ws_lints, manifest.edition()); if lint_level == LintLevel::Allow { return Ok(()); } @@ -227,7 +254,10 @@ pub fn check_im_a_teapot( } let level = lint_level.to_diagnostic_level(); let manifest_path = rel_cwd_manifest_path(path, gctx); - let emitted_reason = format!("`cargo::{}` is set to `{lint_level}`", IM_A_TEAPOT.name); + let emitted_reason = format!( + "`cargo::{}` is set to `{lint_level}` {reason}", + IM_A_TEAPOT.name + ); let key_span = get_span(manifest.document(), &["package", "im-a-teapot"], false).unwrap(); let value_span = get_span(manifest.document(), &["package", "im-a-teapot"], true).unwrap(); @@ -287,7 +317,7 @@ pub fn check_implicit_features( return Ok(()); } - let lint_level = IMPLICIT_FEATURES.level(pkg_lints, ws_lints, edition); + let (lint_level, reason) = IMPLICIT_FEATURES.level(pkg_lints, ws_lints, edition); if lint_level == LintLevel::Allow { return Ok(()); } @@ -332,7 +362,7 @@ pub fn check_implicit_features( ); if emitted_source.is_none() { emitted_source = Some(format!( - "`cargo::{}` is set to `{lint_level}`", + "`cargo::{}` is set to `{lint_level}` {reason}", IMPLICIT_FEATURES.name )); message = message.footer(Level::Note.title(emitted_source.as_ref().unwrap())); @@ -370,7 +400,7 @@ pub fn unused_dependencies( return Ok(()); } - let lint_level = UNUSED_OPTIONAL_DEPENDENCY.level(pkg_lints, ws_lints, edition); + let (lint_level, reason) = UNUSED_OPTIONAL_DEPENDENCY.level(pkg_lints, ws_lints, edition); if lint_level == LintLevel::Allow { return Ok(()); } @@ -436,7 +466,7 @@ pub fn unused_dependencies( ); if emitted_source.is_none() { emitted_source = Some(format!( - "`cargo::{}` is set to `{lint_level}`", + "`cargo::{}` is set to `{lint_level}` {reason}", UNUSED_OPTIONAL_DEPENDENCY.name )); message = diff --git a/tests/testsuite/lints/implicit_features/edition_2021_warn/stderr.term.svg b/tests/testsuite/lints/implicit_features/edition_2021_warn/stderr.term.svg index 75040932d82..11affcc2ee0 100644 --- a/tests/testsuite/lints/implicit_features/edition_2021_warn/stderr.term.svg +++ b/tests/testsuite/lints/implicit_features/edition_2021_warn/stderr.term.svg @@ -33,7 +33,7 @@ | - = note: `cargo::implicit_features` is set to `warn` + = note: `cargo::implicit_features` is set to `warn` in `[lints]` warning: implicit features for optional dependencies is deprecated and will be unavailable in the 2024 edition diff --git a/tests/testsuite/lints/unused_optional_dependencies/edition_2024/stderr.term.svg b/tests/testsuite/lints/unused_optional_dependencies/edition_2024/stderr.term.svg index 1b93aa050e5..84eddf6de57 100644 --- a/tests/testsuite/lints/unused_optional_dependencies/edition_2024/stderr.term.svg +++ b/tests/testsuite/lints/unused_optional_dependencies/edition_2024/stderr.term.svg @@ -34,7 +34,7 @@ | - = note: `cargo::unused_optional_dependency` is set to `warn` + = note: `cargo::unused_optional_dependency` is set to `warn` by default = help: remove the dependency or activate it in a feature with `dep:bar` diff --git a/tests/testsuite/lints/unused_optional_dependencies/renamed_deps/stderr.term.svg b/tests/testsuite/lints/unused_optional_dependencies/renamed_deps/stderr.term.svg index 4d76be9bfbe..2f1c99bec30 100644 --- a/tests/testsuite/lints/unused_optional_dependencies/renamed_deps/stderr.term.svg +++ b/tests/testsuite/lints/unused_optional_dependencies/renamed_deps/stderr.term.svg @@ -34,7 +34,7 @@ | - = note: `cargo::unused_optional_dependency` is set to `warn` + = note: `cargo::unused_optional_dependency` is set to `warn` by default = help: remove the dependency or activate it in a feature with `dep:bar` diff --git a/tests/testsuite/lints_table.rs b/tests/testsuite/lints_table.rs index ad55849e4f2..75d0de4ee27 100644 --- a/tests/testsuite/lints_table.rs +++ b/tests/testsuite/lints_table.rs @@ -852,7 +852,7 @@ warning: `im_a_teapot` is specified 9 | im-a-teapot = true | ------------------ | - = note: `cargo::im_a_teapot` is set to `warn` + = note: `cargo::im_a_teapot` is set to `warn` in `[lints]` [CHECKING] foo v0.0.1 ([CWD]) [FINISHED] [..] ", @@ -892,7 +892,7 @@ warning: `im_a_teapot` is specified 9 | im-a-teapot = true | ------------------ | - = note: `cargo::im_a_teapot` is set to `warn` + = note: `cargo::im_a_teapot` is set to `warn` in `[lints]` [CHECKING] foo v0.0.1 ([CWD]) [FINISHED] [..] ", @@ -934,7 +934,7 @@ error: `im_a_teapot` is specified 9 | im-a-teapot = true | ^^^^^^^^^^^^^^^^^^ | - = note: `cargo::im_a_teapot` is set to `forbid` + = note: `cargo::im_a_teapot` is set to `forbid` in `[lints]` ", ) .run(); @@ -977,7 +977,7 @@ error: `im_a_teapot` is specified 13 | im-a-teapot = true | ^^^^^^^^^^^^^^^^^^ | - = note: `cargo::im_a_teapot` is set to `forbid` + = note: `cargo::im_a_teapot` is set to `forbid` in `[workspace.lints]` ", ) .run();