1 //! checks for attributes
3 use crate::reexport::Name;
5 first_line_of_span, is_present_in_source, match_def_path, paths, snippet_opt, span_lint, span_lint_and_help,
6 span_lint_and_sugg, span_lint_and_then, without_block_comments,
8 use if_chain::if_chain;
9 use rustc_ast::ast::{AttrKind, AttrStyle, Attribute, Lit, LitKind, MetaItemKind, NestedMetaItem};
10 use rustc_ast::util::lev_distance::find_best_match_for_name;
11 use rustc_errors::Applicability;
13 Block, Expr, ExprKind, ImplItem, ImplItemKind, Item, ItemKind, StmtKind, TraitFn, TraitItem, TraitItemKind,
15 use rustc_lint::{CheckLintNameResult, EarlyContext, EarlyLintPass, LateContext, LateLintPass, LintContext};
16 use rustc_middle::lint::in_external_macro;
18 use rustc_session::{declare_lint_pass, declare_tool_lint};
19 use rustc_span::source_map::Span;
20 use rustc_span::symbol::{Symbol, SymbolStr};
23 static UNIX_SYSTEMS: &[&str] = &[
42 // NOTE: windows is excluded from the list because it's also a valid target family.
43 static NON_UNIX_SYSTEMS: &[&str] = &["cloudabi", "hermit", "none", "wasi"];
45 declare_clippy_lint! {
46 /// **What it does:** Checks for items annotated with `#[inline(always)]`,
47 /// unless the annotated function is empty or simply panics.
49 /// **Why is this bad?** While there are valid uses of this annotation (and once
50 /// you know when to use it, by all means `allow` this lint), it's a common
51 /// newbie-mistake to pepper one's code with it.
53 /// As a rule of thumb, before slapping `#[inline(always)]` on a function,
54 /// measure if that additional function call really affects your runtime profile
55 /// sufficiently to make up for the increase in compile time.
57 /// **Known problems:** False positives, big time. This lint is meant to be
58 /// deactivated by everyone doing serious performance work. This means having
59 /// done the measurement.
64 /// fn not_quite_hot_code(..) { ... }
68 "use of `#[inline(always)]`"
71 declare_clippy_lint! {
72 /// **What it does:** Checks for `extern crate` and `use` items annotated with
75 /// This lint permits `#[allow(unused_imports)]`, `#[allow(deprecated)]` and
76 /// `#[allow(unreachable_pub)]` on `use` items and `#[allow(unused_imports)]` on
77 /// `extern crate` items with a `#[macro_use]` attribute.
79 /// **Why is this bad?** Lint attributes have no effect on crate imports. Most
80 /// likely a `!` was forgotten.
82 /// **Known problems:** None.
87 /// #[deny(dead_code)]
89 /// #[forbid(dead_code)]
93 /// #[allow(unused_imports)]
95 /// #[allow(unused_imports)]
99 pub USELESS_ATTRIBUTE,
101 "use of lint attributes on `extern crate` items"
104 declare_clippy_lint! {
105 /// **What it does:** Checks for `#[deprecated]` annotations with a `since`
106 /// field that is not a valid semantic version.
108 /// **Why is this bad?** For checking the version of the deprecation, it must be
109 /// a valid semver. Failing that, the contained information is useless.
111 /// **Known problems:** None.
115 /// #[deprecated(since = "forever")]
116 /// fn something_else() { /* ... */ }
118 pub DEPRECATED_SEMVER,
120 "use of `#[deprecated(since = \"x\")]` where x is not semver"
123 declare_clippy_lint! {
124 /// **What it does:** Checks for empty lines after outer attributes
126 /// **Why is this bad?**
127 /// Most likely the attribute was meant to be an inner attribute using a '!'.
128 /// If it was meant to be an outer attribute, then the following item
129 /// should not be separated by empty lines.
131 /// **Known problems:** Can cause false positives.
133 /// From the clippy side it's difficult to detect empty lines between an attributes and the
134 /// following item because empty lines and comments are not part of the AST. The parsing
135 /// currently works for basic cases but is not perfect.
139 /// // Good (as inner attribute)
140 /// #![inline(always)]
142 /// fn this_is_fine() { }
145 /// #[inline(always)]
147 /// fn not_quite_good_code() { }
149 /// // Good (as outer attribute)
150 /// #[inline(always)]
151 /// fn this_is_fine_too() { }
153 pub EMPTY_LINE_AFTER_OUTER_ATTR,
155 "empty line after outer attribute"
158 declare_clippy_lint! {
159 /// **What it does:** Checks for `allow`/`warn`/`deny`/`forbid` attributes with scoped clippy
160 /// lints and if those lints exist in clippy. If there is an uppercase letter in the lint name
161 /// (not the tool name) and a lowercase version of this lint exists, it will suggest to lowercase
164 /// **Why is this bad?** A lint attribute with a mistyped lint name won't have an effect.
166 /// **Known problems:** None.
171 /// #![warn(if_not_els)]
172 /// #![deny(clippy::All)]
177 /// #![warn(if_not_else)]
178 /// #![deny(clippy::all)]
180 pub UNKNOWN_CLIPPY_LINTS,
182 "unknown_lints for scoped Clippy lints"
185 declare_clippy_lint! {
186 /// **What it does:** Checks for `warn`/`deny`/`forbid` attributes targeting the whole clippy::restriction category.
188 /// **Why is this bad?** Restriction lints sometimes are in contrast with other lints or even go against idiomatic rust.
189 /// These lints should only be enabled on a lint-by-lint basis and with careful consideration.
191 /// **Known problems:** None.
196 /// #![deny(clippy::restriction)]
201 /// #![deny(clippy::as_conversions)]
203 pub BLANKET_CLIPPY_RESTRICTION_LINTS,
205 "enabling the complete restriction group"
208 declare_clippy_lint! {
209 /// **What it does:** Checks for `#[cfg_attr(rustfmt, rustfmt_skip)]` and suggests to replace it
210 /// with `#[rustfmt::skip]`.
212 /// **Why is this bad?** Since tool_attributes ([rust-lang/rust#44690](https://github.com/rust-lang/rust/issues/44690))
213 /// are stable now, they should be used instead of the old `cfg_attr(rustfmt)` attributes.
215 /// **Known problems:** This lint doesn't detect crate level inner attributes, because they get
216 /// processed before the PreExpansionPass lints get executed. See
217 /// [#3123](https://github.com/rust-lang/rust-clippy/pull/3123#issuecomment-422321765)
223 /// #[cfg_attr(rustfmt, rustfmt_skip)]
232 pub DEPRECATED_CFG_ATTR,
234 "usage of `cfg_attr(rustfmt)` instead of tool attributes"
237 declare_clippy_lint! {
238 /// **What it does:** Checks for cfg attributes having operating systems used in target family position.
240 /// **Why is this bad?** The configuration option will not be recognised and the related item will not be included
241 /// by the conditional compilation engine.
243 /// **Known problems:** None.
250 /// fn conditional() { }
255 /// #[cfg(target_os = "linux")]
256 /// fn conditional() { }
262 /// fn conditional() { }
264 /// Check the [Rust Reference](https://doc.rust-lang.org/reference/conditional-compilation.html#target_os) for more details.
265 pub MISMATCHED_TARGET_OS,
267 "usage of `cfg(operating_system)` instead of `cfg(target_os = \"operating_system\")`"
270 declare_lint_pass!(Attributes => [
274 UNKNOWN_CLIPPY_LINTS,
275 BLANKET_CLIPPY_RESTRICTION_LINTS,
278 impl<'tcx> LateLintPass<'tcx> for Attributes {
279 fn check_attribute(&mut self, cx: &LateContext<'tcx>, attr: &'tcx Attribute) {
280 if let Some(items) = &attr.meta_item_list() {
281 if let Some(ident) = attr.ident() {
282 let ident = &*ident.as_str();
284 "allow" | "warn" | "deny" | "forbid" => {
285 check_clippy_lint_names(cx, ident, items);
289 if items.is_empty() || !attr.check_name(sym!(deprecated)) {
294 if let NestedMetaItem::MetaItem(mi) = &item;
295 if let MetaItemKind::NameValue(lit) = &mi.kind;
296 if mi.check_name(sym!(since));
298 check_semver(cx, item.span(), lit);
306 fn check_item(&mut self, cx: &LateContext<'tcx>, item: &'tcx Item<'_>) {
307 if is_relevant_item(cx, item) {
308 check_attrs(cx, item.span, item.ident.name, &item.attrs)
311 ItemKind::ExternCrate(..) | ItemKind::Use(..) => {
312 let skip_unused_imports = item.attrs.iter().any(|attr| attr.check_name(sym!(macro_use)));
314 for attr in item.attrs {
315 if in_external_macro(cx.sess(), attr.span) {
318 if let Some(lint_list) = &attr.meta_item_list() {
319 if let Some(ident) = attr.ident() {
320 match &*ident.as_str() {
321 "allow" | "warn" | "deny" | "forbid" => {
322 // permit `unused_imports`, `deprecated` and `unreachable_pub` for `use` items
323 // and `unused_imports` for `extern crate` items with `macro_use`
324 for lint in lint_list {
326 ItemKind::Use(..) => {
327 if is_word(lint, sym!(unused_imports))
328 || is_word(lint, sym!(deprecated))
329 || is_word(lint, sym!(unreachable_pub))
330 || is_word(lint, sym!(unused))
335 ItemKind::ExternCrate(..) => {
336 if is_word(lint, sym!(unused_imports)) && skip_unused_imports {
339 if is_word(lint, sym!(unused_extern_crates)) {
346 let line_span = first_line_of_span(cx, attr.span);
348 if let Some(mut sugg) = snippet_opt(cx, line_span) {
349 if sugg.contains("#[") {
354 "useless lint attribute",
356 sugg = sugg.replacen("#[", "#![", 1);
357 diag.span_suggestion(
359 "if you just forgot a `!`, use",
361 Applicability::MaybeIncorrect,
378 fn check_impl_item(&mut self, cx: &LateContext<'tcx>, item: &'tcx ImplItem<'_>) {
379 if is_relevant_impl(cx, item) {
380 check_attrs(cx, item.span, item.ident.name, &item.attrs)
384 fn check_trait_item(&mut self, cx: &LateContext<'tcx>, item: &'tcx TraitItem<'_>) {
385 if is_relevant_trait(cx, item) {
386 check_attrs(cx, item.span, item.ident.name, &item.attrs)
391 fn check_clippy_lint_names(cx: &LateContext<'_>, ident: &str, items: &[NestedMetaItem]) {
392 fn extract_name(lint: &NestedMetaItem) -> Option<SymbolStr> {
394 if let Some(meta_item) = lint.meta_item();
395 if meta_item.path.segments.len() > 1;
396 if let tool_name = meta_item.path.segments[0].ident;
397 if tool_name.as_str() == "clippy";
398 let lint_name = meta_item.path.segments.last().unwrap().ident.name;
400 return Some(lint_name.as_str());
406 let lint_store = cx.lints();
408 if let Some(lint_name) = extract_name(lint) {
409 if let CheckLintNameResult::Tool(Err((None, _))) =
410 lint_store.check_lint_name(&lint_name, Some(sym!(clippy)))
414 UNKNOWN_CLIPPY_LINTS,
416 &format!("unknown clippy lint: clippy::{}", lint_name),
418 let name_lower = lint_name.to_lowercase();
419 let symbols = lint_store
422 .map(|l| Symbol::intern(&l.name_lower()))
423 .collect::<Vec<_>>();
424 let sugg = find_best_match_for_name(
426 Symbol::intern(&format!("clippy::{}", name_lower)),
429 if lint_name.chars().any(char::is_uppercase)
430 && lint_store.find_lints(&format!("clippy::{}", name_lower)).is_ok()
432 diag.span_suggestion(
434 "lowercase the lint name",
435 format!("clippy::{}", name_lower),
436 Applicability::MachineApplicable,
438 } else if let Some(sugg) = sugg {
439 diag.span_suggestion(
443 Applicability::MachineApplicable,
448 } else if lint_name == "restriction" && ident != "allow" {
451 BLANKET_CLIPPY_RESTRICTION_LINTS,
453 "restriction lints are not meant to be all enabled",
455 "try enabling only the lints you really need",
462 fn is_relevant_item(cx: &LateContext<'_>, item: &Item<'_>) -> bool {
463 if let ItemKind::Fn(_, _, eid) = item.kind {
464 is_relevant_expr(cx, cx.tcx.body_tables(eid), &cx.tcx.hir().body(eid).value)
470 fn is_relevant_impl(cx: &LateContext<'_>, item: &ImplItem<'_>) -> bool {
472 ImplItemKind::Fn(_, eid) => is_relevant_expr(cx, cx.tcx.body_tables(eid), &cx.tcx.hir().body(eid).value),
477 fn is_relevant_trait(cx: &LateContext<'_>, item: &TraitItem<'_>) -> bool {
479 TraitItemKind::Fn(_, TraitFn::Required(_)) => true,
480 TraitItemKind::Fn(_, TraitFn::Provided(eid)) => {
481 is_relevant_expr(cx, cx.tcx.body_tables(eid), &cx.tcx.hir().body(eid).value)
487 fn is_relevant_block(cx: &LateContext<'_>, tables: &ty::TypeckTables<'_>, block: &Block<'_>) -> bool {
488 block.stmts.first().map_or(
489 block.expr.as_ref().map_or(false, |e| is_relevant_expr(cx, tables, e)),
490 |stmt| match &stmt.kind {
491 StmtKind::Local(_) => true,
492 StmtKind::Expr(expr) | StmtKind::Semi(expr) => is_relevant_expr(cx, tables, expr),
498 fn is_relevant_expr(cx: &LateContext<'_>, tables: &ty::TypeckTables<'_>, expr: &Expr<'_>) -> bool {
500 ExprKind::Block(block, _) => is_relevant_block(cx, tables, block),
501 ExprKind::Ret(Some(e)) => is_relevant_expr(cx, tables, e),
502 ExprKind::Ret(None) | ExprKind::Break(_, None) => false,
503 ExprKind::Call(path_expr, _) => {
504 if let ExprKind::Path(qpath) = &path_expr.kind {
506 .qpath_res(qpath, path_expr.hir_id)
508 .map_or(true, |fun_id| !match_def_path(cx, fun_id, &paths::BEGIN_PANIC))
517 fn check_attrs(cx: &LateContext<'_>, span: Span, name: Name, attrs: &[Attribute]) {
518 if span.from_expansion() {
523 if let Some(values) = attr.meta_item_list() {
524 if values.len() != 1 || !attr.check_name(sym!(inline)) {
527 if is_word(&values[0], sym!(always)) {
533 "you have declared `#[inline(always)]` on `{}`. This is usually a bad idea",
542 fn check_semver(cx: &LateContext<'_>, span: Span, lit: &Lit) {
543 if let LitKind::Str(is, _) = lit.kind {
544 if Version::parse(&is.as_str()).is_ok() {
552 "the since field must contain a semver-compliant version",
556 fn is_word(nmi: &NestedMetaItem, expected: Symbol) -> bool {
557 if let NestedMetaItem::MetaItem(mi) = &nmi {
558 mi.is_word() && mi.check_name(expected)
564 declare_lint_pass!(EarlyAttributes => [
566 MISMATCHED_TARGET_OS,
567 EMPTY_LINE_AFTER_OUTER_ATTR,
570 impl EarlyLintPass for EarlyAttributes {
571 fn check_item(&mut self, cx: &EarlyContext<'_>, item: &rustc_ast::ast::Item) {
572 check_empty_line_after_outer_attr(cx, item);
575 fn check_attribute(&mut self, cx: &EarlyContext<'_>, attr: &Attribute) {
576 check_deprecated_cfg_attr(cx, attr);
577 check_mismatched_target_os(cx, attr);
581 fn check_empty_line_after_outer_attr(cx: &EarlyContext<'_>, item: &rustc_ast::ast::Item) {
582 for attr in &item.attrs {
583 let attr_item = if let AttrKind::Normal(ref attr) = attr.kind {
589 if attr.style == AttrStyle::Outer {
590 if attr_item.args.inner_tokens().is_empty() || !is_present_in_source(cx, attr.span) {
594 let begin_of_attr_to_item = Span::new(attr.span.lo(), item.span.lo(), item.span.ctxt());
595 let end_of_attr_to_item = Span::new(attr.span.hi(), item.span.lo(), item.span.ctxt());
597 if let Some(snippet) = snippet_opt(cx, end_of_attr_to_item) {
598 let lines = snippet.split('\n').collect::<Vec<_>>();
599 let lines = without_block_comments(lines);
601 if lines.iter().filter(|l| l.trim().is_empty()).count() > 2 {
604 EMPTY_LINE_AFTER_OUTER_ATTR,
605 begin_of_attr_to_item,
606 "Found an empty line after an outer attribute. \
607 Perhaps you forgot to add a `!` to make it an inner attribute?",
615 fn check_deprecated_cfg_attr(cx: &EarlyContext<'_>, attr: &Attribute) {
618 if attr.check_name(sym!(cfg_attr));
619 if let Some(items) = attr.meta_item_list();
621 // check for `rustfmt`
622 if let Some(feature_item) = items[0].meta_item();
623 if feature_item.check_name(sym!(rustfmt));
624 // check for `rustfmt_skip` and `rustfmt::skip`
625 if let Some(skip_item) = &items[1].meta_item();
626 if skip_item.check_name(sym!(rustfmt_skip)) ||
627 skip_item.path.segments.last().expect("empty path in attribute").ident.name == sym!(skip);
628 // Only lint outer attributes, because custom inner attributes are unstable
629 // Tracking issue: https://github.com/rust-lang/rust/issues/54726
630 if let AttrStyle::Outer = attr.style;
636 "`cfg_attr` is deprecated for rustfmt and got replaced by tool attributes",
638 "#[rustfmt::skip]".to_string(),
639 Applicability::MachineApplicable,
645 fn check_mismatched_target_os(cx: &EarlyContext<'_>, attr: &Attribute) {
646 fn find_os(name: &str) -> Option<&'static str> {
649 .chain(NON_UNIX_SYSTEMS.iter())
650 .find(|&&os| os == name)
654 fn is_unix(name: &str) -> bool {
655 UNIX_SYSTEMS.iter().any(|&os| os == name)
658 fn find_mismatched_target_os(items: &[NestedMetaItem]) -> Vec<(&str, Span)> {
659 let mut mismatched = Vec::new();
662 if let NestedMetaItem::MetaItem(meta) = item {
664 MetaItemKind::List(list) => {
665 mismatched.extend(find_mismatched_target_os(&list));
667 MetaItemKind::Word => {
669 if let Some(ident) = meta.ident();
670 if let Some(os) = find_os(&*ident.name.as_str());
672 mismatched.push((os, ident.span));
685 if attr.check_name(sym!(cfg));
686 if let Some(list) = attr.meta_item_list();
687 let mismatched = find_mismatched_target_os(&list);
688 if !mismatched.is_empty();
690 let mess = "operating system used in target family position";
692 span_lint_and_then(cx, MISMATCHED_TARGET_OS, attr.span, &mess, |diag| {
693 // Avoid showing the unix suggestion multiple times in case
694 // we have more than one mismatch for unix-like systems
695 let mut unix_suggested = false;
697 for (os, span) in mismatched {
698 let sugg = format!("target_os = \"{}\"", os);
699 diag.span_suggestion(span, "try", sugg, Applicability::MaybeIncorrect);
701 if !unix_suggested && is_unix(os) {
702 diag.help("Did you mean `unix`?");
703 unix_suggested = true;