///
/// ### Example
/// ```ignore
- /// // Bad
/// #[deny(dead_code)]
/// extern crate foo;
/// #[forbid(dead_code)]
/// use foo::bar;
+ /// ```
///
- /// // Ok
+ /// Use instead:
+ /// ```rust,ignore
/// #[allow(unused_imports)]
/// use foo::baz;
/// #[allow(unused_imports)]
///
/// ### Example
/// ```rust
+ /// #[allow(dead_code)]
+ ///
+ /// fn not_quite_good_code() { }
+ /// ```
+ ///
+ /// Use instead:
+ /// ```rust
/// // Good (as inner attribute)
/// #![allow(dead_code)]
///
/// fn this_is_fine() { }
///
- /// // Bad
- /// #[allow(dead_code)]
- ///
- /// fn not_quite_good_code() { }
+ /// // or
///
/// // Good (as outer attribute)
/// #[allow(dead_code)]
/// These lints should only be enabled on a lint-by-lint basis and with careful consideration.
///
/// ### Example
- /// Bad:
/// ```rust
/// #![deny(clippy::restriction)]
/// ```
///
- /// Good:
+ /// Use instead:
/// ```rust
/// #![deny(clippy::as_conversions)]
/// ```
/// [#3123](https://github.com/rust-lang/rust-clippy/pull/3123#issuecomment-422321765)
///
/// ### Example
- /// Bad:
/// ```rust
/// #[cfg_attr(rustfmt, rustfmt_skip)]
/// fn main() { }
/// ```
///
- /// Good:
+ /// Use instead:
/// ```rust
/// #[rustfmt::skip]
/// fn main() { }
/// by the conditional compilation engine.
///
/// ### Example
- /// Bad:
/// ```rust
/// #[cfg(linux)]
/// fn conditional() { }
/// ```
///
- /// Good:
+ /// Use instead:
/// ```rust
+ /// # mod hidden {
/// #[cfg(target_os = "linux")]
/// fn conditional() { }
- /// ```
+ /// # }
+ ///
+ /// // or
///
- /// Or:
- /// ```rust
/// #[cfg(unix)]
/// fn conditional() { }
/// ```
"usage of `cfg(operating_system)` instead of `cfg(target_os = \"operating_system\")`"
}
+declare_clippy_lint! {
+ /// ### What it does
+ /// Checks for attributes that allow lints without a reason.
+ ///
+ /// (This requires the `lint_reasons` feature)
+ ///
+ /// ### Why is this bad?
+ /// Allowing a lint should always have a reason. This reason should be documented to
+ /// ensure that others understand the reasoning
+ ///
+ /// ### Example
+ /// ```rust
+ /// #![feature(lint_reasons)]
+ ///
+ /// #![allow(clippy::some_lint)]
+ /// ```
+ ///
+ /// Use instead:
+ /// ```rust
+ /// #![feature(lint_reasons)]
+ ///
+ /// #![allow(clippy::some_lint, reason = "False positive rust-lang/rust-clippy#1002020")]
+ /// ```
+ #[clippy::version = "1.61.0"]
+ pub ALLOW_ATTRIBUTES_WITHOUT_REASON,
+ restriction,
+ "ensures that all `allow` and `expect` attributes have a reason"
+}
+
declare_lint_pass!(Attributes => [
+ ALLOW_ATTRIBUTES_WITHOUT_REASON,
INLINE_ALWAYS,
DEPRECATED_SEMVER,
USELESS_ATTRIBUTE,
if is_lint_level(ident.name) {
check_clippy_lint_names(cx, ident.name, items);
}
+ if matches!(ident.name, sym::allow | sym::expect) {
+ check_lint_reason(cx, ident.name, items, attr);
+ }
if items.is_empty() || !attr.has_name(sym::deprecated) {
return;
}
}
if let Some(lint_list) = &attr.meta_item_list() {
if attr.ident().map_or(false, |ident| is_lint_level(ident.name)) {
- // permit `unused_imports`, `deprecated`, `unreachable_pub`,
- // `clippy::wildcard_imports`, and `clippy::enum_glob_use` for `use` items
- // and `unused_imports` for `extern crate` items with `macro_use`
for lint in lint_list {
match item.kind {
ItemKind::Use(..) => {
|| is_word(lint, sym::deprecated)
|| is_word(lint, sym!(unreachable_pub))
|| is_word(lint, sym!(unused))
- || extract_clippy_lint(lint)
- .map_or(false, |s| s.as_str() == "wildcard_imports")
- || extract_clippy_lint(lint)
- .map_or(false, |s| s.as_str() == "enum_glob_use")
+ || extract_clippy_lint(lint).map_or(false, |s| {
+ matches!(
+ s.as_str(),
+ "wildcard_imports" | "enum_glob_use" | "redundant_pub_crate",
+ )
+ })
{
return;
}
}
}
+fn check_lint_reason(cx: &LateContext<'_>, name: Symbol, items: &[NestedMetaItem], attr: &'_ Attribute) {
+ // Check for the feature
+ if !cx.tcx.sess.features_untracked().lint_reasons {
+ return;
+ }
+
+ // Check if the reason is present
+ if let Some(item) = items.last().and_then(NestedMetaItem::meta_item)
+ && let MetaItemKind::NameValue(_) = &item.kind
+ && item.path == sym::reason
+ {
+ return;
+ }
+
+ span_lint_and_help(
+ cx,
+ ALLOW_ATTRIBUTES_WITHOUT_REASON,
+ attr.span,
+ &format!("`{}` attribute without specifying a reason", name.as_str()),
+ None,
+ "try adding a reason at the end with `, reason = \"..\"`",
+ );
+}
+
fn is_relevant_item(cx: &LateContext<'_>, item: &Item<'_>) -> bool {
if let ItemKind::Fn(_, _, eid) = item.kind {
is_relevant_expr(cx, cx.tcx.typeck_body(eid), &cx.tcx.hir().body(eid).value)
}
fn check_empty_line_after_outer_attr(cx: &EarlyContext<'_>, item: &rustc_ast::Item) {
- for attr in &item.attrs {
- let attr_item = if let AttrKind::Normal(ref attr, _) = attr.kind {
- attr
- } else {
- return;
- };
-
- if attr.style == AttrStyle::Outer {
- if attr_item.args.inner_tokens().is_empty() || !is_present_in_source(cx, attr.span) {
- return;
- }
-
+ let mut iter = item.attrs.iter().peekable();
+ while let Some(attr) = iter.next() {
+ if matches!(attr.kind, AttrKind::Normal(..))
+ && attr.style == AttrStyle::Outer
+ && is_present_in_source(cx, attr.span)
+ {
let begin_of_attr_to_item = Span::new(attr.span.lo(), item.span.lo(), item.span.ctxt(), item.span.parent());
- let end_of_attr_to_item = Span::new(attr.span.hi(), item.span.lo(), item.span.ctxt(), item.span.parent());
+ let end_of_attr_to_next_attr_or_item = Span::new(
+ attr.span.hi(),
+ iter.peek().map_or(item.span.lo(), |next_attr| next_attr.span.lo()),
+ item.span.ctxt(),
+ item.span.parent(),
+ );
- if let Some(snippet) = snippet_opt(cx, end_of_attr_to_item) {
+ if let Some(snippet) = snippet_opt(cx, end_of_attr_to_next_attr_or_item) {
let lines = snippet.split('\n').collect::<Vec<_>>();
let lines = without_block_comments(lines);
fn check_deprecated_cfg_attr(cx: &EarlyContext<'_>, attr: &Attribute, msrv: Option<RustcVersion>) {
if_chain! {
- if meets_msrv(msrv.as_ref(), &msrvs::TOOL_ATTRIBUTES);
+ if meets_msrv(msrv, msrvs::TOOL_ATTRIBUTES);
// check cfg_attr
if attr.has_name(sym::cfg_attr);
if let Some(items) = attr.meta_item_list();
if feature_item.has_name(sym::rustfmt);
// check for `rustfmt_skip` and `rustfmt::skip`
if let Some(skip_item) = &items[1].meta_item();
- if skip_item.has_name(sym!(rustfmt_skip)) ||
- skip_item.path.segments.last().expect("empty path in attribute").ident.name == sym::skip;
+ if skip_item.has_name(sym!(rustfmt_skip))
+ || skip_item
+ .path
+ .segments
+ .last()
+ .expect("empty path in attribute")
+ .ident
+ .name
+ == sym::skip;
// Only lint outer attributes, because custom inner attributes are unstable
// Tracking issue: https://github.com/rust-lang/rust/issues/54726
if attr.style == AttrStyle::Outer;
}
fn is_lint_level(symbol: Symbol) -> bool {
- matches!(symbol, sym::allow | sym::warn | sym::deny | sym::forbid)
+ matches!(symbol, sym::allow | sym::expect | sym::warn | sym::deny | sym::forbid)
}
projects / rust.git / blobdiff