Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
94 changes: 73 additions & 21 deletions src/cargo/lints/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ pub enum ManifestFor<'a> {
}

impl ManifestFor<'_> {
fn lint_level(&self, pkg_lints: &TomlToolLints, lint: &Lint) -> (LintLevel, LintLevelReason) {
fn lint_level(&self, pkg_lints: &TomlToolLints, lint: &Lint) -> (LintLevel, LintLevelSource) {
lint.level(pkg_lints, self.rust_version(), self.unstable_features())
}

Expand Down Expand Up @@ -111,10 +111,10 @@ pub fn analyze_cargo_lints_table(
continue;
};

let (_, reason, _) = level_priority(name, *default_level, cargo_lints);
let (_, source, _) = level_priority(name, *default_level, cargo_lints);

// Only run analysis on user-specified lints
if !reason.is_user_specified() {
if !source.is_user_specified() {
continue;
}

Expand Down Expand Up @@ -423,20 +423,20 @@ impl Lint {
pkg_lints: &TomlToolLints,
pkg_rust_version: Option<&RustVersion>,
unstable_features: &Features,
) -> (LintLevel, LintLevelReason) {
) -> (LintLevel, LintLevelSource) {
// We should return `Allow` if a lint is behind a feature, but it is
// not enabled, that way the lint does not run.
if self
.feature_gate
.is_some_and(|f| !unstable_features.is_enabled(f))
{
return (LintLevel::Allow, LintLevelReason::Default);
return (LintLevel::Allow, LintLevelSource::Default);
}

if let (Some(msrv), Some(pkg_rust_version)) = (&self.msrv, pkg_rust_version) {
let pkg_rust_version = pkg_rust_version.to_partial();
if !msrv.is_compatible_with(&pkg_rust_version) {
return (LintLevel::Allow, LintLevelReason::Default);
return (LintLevel::Allow, LintLevelSource::Default);
}
}

Expand All @@ -449,16 +449,23 @@ impl Lint {
pkg_lints,
);

let (_, (l, r, _)) = max_by_key(
let (_, (l, s, _)) = max_by_key(
(self.name, lint_level_priority),
(self.primary_group.name, group_level_priority),
|(n, (l, _, p))| (l == &LintLevel::Forbid, *p, Reverse(*n)),
|(n, (l, s, p))| {
(
l == &LintLevel::Forbid,
*s != LintLevelSource::Default,
*p,
Reverse(*n),
)
},
);
(l, r)
(l, s)
}

pub fn emitted_source(&self, lint_level: LintLevel, reason: LintLevelReason) -> String {
format!("`cargo::{}` is set to `{lint_level}` {reason}", self.name,)
pub fn emitted_source(&self, lint_level: LintLevel, source: LintLevelSource) -> String {
format!("`cargo::{}` is set to `{lint_level}` {source}", self.name,)
}
}

Expand Down Expand Up @@ -521,25 +528,25 @@ impl From<TomlLintLevel> for LintLevel {
}

#[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub enum LintLevelReason {
pub enum LintLevelSource {
Default,
Package,
}

impl Display for LintLevelReason {
impl Display for LintLevelSource {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
LintLevelReason::Default => write!(f, "by default"),
LintLevelReason::Package => write!(f, "in `[lints]`"),
LintLevelSource::Default => write!(f, "by default"),
LintLevelSource::Package => write!(f, "in `[lints]`"),
}
}
}

impl LintLevelReason {
impl LintLevelSource {
fn is_user_specified(&self) -> bool {
match self {
LintLevelReason::Default => false,
LintLevelReason::Package => true,
LintLevelSource::Default => false,
LintLevelSource::Package => true,
}
}
}
Expand All @@ -548,15 +555,15 @@ fn level_priority(
name: &str,
default_level: LintLevel,
pkg_lints: &TomlToolLints,
) -> (LintLevel, LintLevelReason, i8) {
) -> (LintLevel, LintLevelSource, i8) {
if let Some(defined_level) = pkg_lints.get(name) {
(
defined_level.level().into(),
LintLevelReason::Package,
LintLevelSource::Package,
defined_level.priority(),
)
} else {
(default_level, LintLevelReason::Default, 0)
(default_level, LintLevelSource::Default, 0)
}
}

Expand All @@ -566,6 +573,51 @@ mod tests {
use snapbox::ToDebug;
use std::collections::HashSet;

use super::*;

fn test_lint(name: &'static str, group: &'static LintGroup) -> Lint {
Lint {
name,
desc: "test lint",
primary_group: group,
msrv: None,
feature_gate: None,
docs: None,
}
}

#[test]
fn lint_level_prefers_user_specified_over_default() {
let lint = test_lint("unused_dependencies", &STYLE);

let mut pkg_lints = TomlToolLints::new();
pkg_lints.insert(
"unused_dependencies".to_string(),
cargo_util_schemas::manifest::TomlLint::Level(TomlLintLevel::Deny),
);
let features = Features::default();

let (level, source) = lint.level(&pkg_lints, None, &features);
assert_eq!(level, LintLevel::Deny);
assert_eq!(source, LintLevelSource::Package);
}

#[test]
fn lint_level_group_overrides_default() {
let lint = test_lint("non_kebab_case_bins", &STYLE);

let mut pkg_lints = TomlToolLints::new();
pkg_lints.insert(
"style".to_string(),
cargo_util_schemas::manifest::TomlLint::Level(TomlLintLevel::Deny),
);
let features = Features::default();

let (level, source) = lint.level(&pkg_lints, None, &features);
assert_eq!(level, LintLevel::Deny);
assert_eq!(source, LintLevelSource::Package);
}

#[test]
fn ensure_lint_groups_do_not_default_to_forbid() {
let forbid_groups = super::LINT_GROUPS
Expand Down
4 changes: 2 additions & 2 deletions src/cargo/lints/rules/blanket_hint_mostly_unused.rs
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ pub fn blanket_hint_mostly_unused(
error_count: &mut usize,
gctx: &GlobalContext,
) -> CargoResult<()> {
let (lint_level, reason) = LINT.level(
let (lint_level, source) = LINT.level(
pkg_lints,
ws.lowest_rust_version(),
maybe_pkg.unstable_features(),
Expand Down Expand Up @@ -169,7 +169,7 @@ pub fn blanket_hint_mostly_unused(

if i == 0 {
primary_group =
primary_group.element(Level::NOTE.message(LINT.emitted_source(lint_level, reason)));
primary_group.element(Level::NOTE.message(LINT.emitted_source(lint_level, source)));
}

// The primary group should always be first
Expand Down
6 changes: 3 additions & 3 deletions src/cargo/lints/rules/im_a_teapot.rs
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ pub fn check_im_a_teapot(
gctx: &GlobalContext,
) -> CargoResult<()> {
let manifest = pkg.manifest();
let (lint_level, reason) =
let (lint_level, source) =
LINT.level(pkg_lints, pkg.rust_version(), manifest.unstable_features());

if lint_level == LintLevel::Allow {
Expand All @@ -52,7 +52,7 @@ 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 = LINT.emitted_source(lint_level, reason);
let emitted_source = LINT.emitted_source(lint_level, source);

let mut desc = Group::with_title(level.primary_title(LINT.desc));

Expand All @@ -70,7 +70,7 @@ pub fn check_im_a_teapot(
desc = desc.element(Origin::path(&manifest_path));
}

let report = &[desc.element(Level::NOTE.message(&emitted_reason))];
let report = &[desc.element(Level::NOTE.message(&emitted_source))];

gctx.shell().print_report(report, lint_level.force())?;
}
Expand Down
14 changes: 7 additions & 7 deletions src/cargo/lints/rules/implicit_minimum_version_req.rs
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ use crate::core::Package;
use crate::core::Workspace;
use crate::lints::Lint;
use crate::lints::LintLevel;
use crate::lints::LintLevelReason;
use crate::lints::LintLevelSource;
use crate::lints::PEDANTIC;
use crate::lints::get_key_value;
use crate::lints::rel_cwd_manifest_path;
Expand Down Expand Up @@ -89,7 +89,7 @@ pub fn implicit_minimum_version_req_pkg(
error_count: &mut usize,
gctx: &GlobalContext,
) -> CargoResult<()> {
let (lint_level, reason) = LINT.level(
let (lint_level, source) = LINT.level(
cargo_lints,
pkg.rust_version(),
pkg.manifest().unstable_features(),
Expand Down Expand Up @@ -124,7 +124,7 @@ pub fn implicit_minimum_version_req_pkg(

let Some(report) = report(
lint_level,
reason,
source,
contents,
document,
key_path,
Expand Down Expand Up @@ -156,7 +156,7 @@ pub fn implicit_minimum_version_req_ws(
error_count: &mut usize,
gctx: &GlobalContext,
) -> CargoResult<()> {
let (lint_level, reason) = LINT.level(
let (lint_level, source) = LINT.level(
cargo_lints,
ws.lowest_rust_version(),
maybe_pkg.unstable_features(),
Expand Down Expand Up @@ -207,7 +207,7 @@ pub fn implicit_minimum_version_req_ws(

let Some(report) = report(
lint_level,
reason,
source,
contents,
document,
&key_path,
Expand Down Expand Up @@ -255,7 +255,7 @@ pub fn span_of_version_req<'doc>(

fn report<'a>(
lint_level: LintLevel,
reason: LintLevelReason,
source: LintLevelSource,
contents: Option<&'a str>,
document: Option<&toml::Spanned<toml::de::DeTable<'static>>>,
key_path: &[&str],
Expand All @@ -264,7 +264,7 @@ fn report<'a>(
emit_source: bool,
) -> Option<[Group<'a>; 2]> {
let level = lint_level.to_diagnostic_level();
let emitted_source = LINT.emitted_source(lint_level, reason);
let emitted_source = LINT.emitted_source(lint_level, source);
let replacement = format!(r#""{suggested_req}""#);
let label = "missing full version components";
let secondary_title = "consider specifying full `major.minor.patch` version components";
Expand Down
4 changes: 2 additions & 2 deletions src/cargo/lints/rules/missing_lints_inheritance.rs
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ pub fn missing_lints_inheritance(
error_count: &mut usize,
gctx: &GlobalContext,
) -> CargoResult<()> {
let (lint_level, reason) = LINT.level(
let (lint_level, source) = LINT.level(
cargo_lints,
pkg.rust_version(),
pkg.manifest().unstable_features(),
Expand Down Expand Up @@ -89,7 +89,7 @@ pub fn missing_lints_inheritance(
let manifest = pkg.manifest();
let contents = manifest.contents();
let level = lint_level.to_diagnostic_level();
let emitted_source = LINT.emitted_source(lint_level, reason);
let emitted_source = LINT.emitted_source(lint_level, source);
let manifest_path = rel_cwd_manifest_path(manifest_path, gctx);

let mut primary = Group::with_title(level.primary_title(LINT.desc));
Expand Down
10 changes: 5 additions & 5 deletions src/cargo/lints/rules/non_kebab_case_bins.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ use crate::core::Workspace;
use crate::lints::AsIndex;
use crate::lints::Lint;
use crate::lints::LintLevel;
use crate::lints::LintLevelReason;
use crate::lints::LintLevelSource;
use crate::lints::STYLE;
use crate::lints::get_key_value_span;
use crate::lints::rel_cwd_manifest_path;
Expand Down Expand Up @@ -69,7 +69,7 @@ pub fn non_kebab_case_bins(
error_count: &mut usize,
gctx: &GlobalContext,
) -> CargoResult<()> {
let (lint_level, reason) = LINT.level(
let (lint_level, source) = LINT.level(
cargo_lints,
pkg.rust_version(),
pkg.manifest().unstable_features(),
Expand All @@ -86,7 +86,7 @@ pub fn non_kebab_case_bins(
pkg,
&manifest_path,
lint_level,
reason,
source,
error_count,
gctx,
)
Expand All @@ -97,7 +97,7 @@ pub fn lint_package(
pkg: &Package,
manifest_path: &str,
lint_level: LintLevel,
reason: LintLevelReason,
source: LintLevelSource,
error_count: &mut usize,
gctx: &GlobalContext,
) -> CargoResult<()> {
Expand All @@ -115,7 +115,7 @@ pub fn lint_package(
let document = manifest.document();
let contents = manifest.contents();
let level = lint_level.to_diagnostic_level();
let emitted_source = LINT.emitted_source(lint_level, reason);
let emitted_source = LINT.emitted_source(lint_level, source);

let mut primary_source = ws.target_dir().as_path_unlocked().to_owned();
// Elide profile/platform as we don't have that context
Expand Down
10 changes: 5 additions & 5 deletions src/cargo/lints/rules/non_kebab_case_features.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ use crate::GlobalContext;
use crate::core::Package;
use crate::lints::Lint;
use crate::lints::LintLevel;
use crate::lints::LintLevelReason;
use crate::lints::LintLevelSource;
use crate::lints::RESTRICTION;
use crate::lints::get_key_value_span;
use crate::lints::rel_cwd_manifest_path;
Expand Down Expand Up @@ -62,7 +62,7 @@ pub fn non_kebab_case_features(
error_count: &mut usize,
gctx: &GlobalContext,
) -> CargoResult<()> {
let (lint_level, reason) = LINT.level(
let (lint_level, source) = LINT.level(
cargo_lints,
pkg.rust_version(),
pkg.manifest().unstable_features(),
Expand All @@ -74,14 +74,14 @@ pub fn non_kebab_case_features(

let manifest_path = rel_cwd_manifest_path(manifest_path, gctx);

lint_package(pkg, &manifest_path, lint_level, reason, error_count, gctx)
lint_package(pkg, &manifest_path, lint_level, source, error_count, gctx)
}

pub fn lint_package(
pkg: &Package,
manifest_path: &str,
lint_level: LintLevel,
reason: LintLevelReason,
source: LintLevelSource,
error_count: &mut usize,
gctx: &GlobalContext,
) -> CargoResult<()> {
Expand All @@ -96,7 +96,7 @@ pub fn lint_package(
let document = manifest.document();
let contents = manifest.contents();
let level = lint_level.to_diagnostic_level();
let emitted_source = LINT.emitted_source(lint_level, reason);
let emitted_source = LINT.emitted_source(lint_level, source);

let mut primary = Group::with_title(level.primary_title(LINT.desc));
if let Some(document) = document
Expand Down
Loading