Generate default lint completions

This commit is contained in:
Lukas Wirth 2021-06-04 18:35:19 +02:00
parent 5d17b6a687
commit 343df88ac7
7 changed files with 1130 additions and 777 deletions

View file

@ -3,11 +3,13 @@
AsAssocItem, AssocItemContainer, GenericParam, HasAttrs, HasSource, HirDisplay, InFile, Module,
ModuleDef, Semantics,
};
use ide_completion::generated_lint_completions::{CLIPPY_LINTS, FEATURES};
use ide_db::{
base_db::SourceDatabase,
defs::{Definition, NameClass, NameRefClass},
helpers::FamousDefs,
helpers::{
generated_lints::{CLIPPY_LINTS, DEFAULT_LINTS, FEATURES},
FamousDefs,
},
RootDatabase,
};
use itertools::Itertools;
@ -206,25 +208,36 @@ fn try_hover_for_attribute(token: &SyntaxToken) -> Option<RangeInfo<HoverResult>
if !tt.syntax().text_range().contains(token.text_range().start()) {
return None;
}
let lints = match &*path {
"feature" => FEATURES,
"allow" | "warn" | "forbid" | "error" => {
let is_clippy = algo::skip_trivia_token(token.clone(), Direction::Prev)
.filter(|t| t.kind() == T![::])
.and_then(|t| algo::skip_trivia_token(t, Direction::Prev))
.map_or(false, |t| t.kind() == T![ident] && t.text() == "clippy");
let (is_clippy, lints) = match &*path {
"feature" => (false, FEATURES),
"allow" | "deny" | "forbid" | "warn" => {
let is_clippy = algo::non_trivia_sibling(token.clone().into(), Direction::Prev)
.filter(|t| t.kind() == T![:])
.and_then(|t| algo::non_trivia_sibling(t, Direction::Prev))
.filter(|t| t.kind() == T![:])
.and_then(|t| algo::non_trivia_sibling(t, Direction::Prev))
.map_or(false, |t| {
t.kind() == T![ident] && t.into_token().map_or(false, |t| t.text() == "clippy")
});
if is_clippy {
CLIPPY_LINTS
(true, CLIPPY_LINTS)
} else {
&[]
(false, DEFAULT_LINTS)
}
}
_ => return None,
};
let lint = lints
.binary_search_by_key(&token.text(), |lint| lint.label)
.ok()
.map(|idx| &FEATURES[idx])?;
let tmp;
let needle = if is_clippy {
tmp = format!("clippy::{}", token.text());
&tmp
} else {
&*token.text()
};
let lint =
lints.binary_search_by_key(&needle, |lint| lint.label).ok().map(|idx| &lints[idx])?;
Some(RangeInfo::new(
token.text_range(),
HoverResult {
@ -4055,4 +4068,36 @@ fn main() {
"##]],
)
}
#[test]
fn hover_lint() {
check(
r#"#![allow(arithmetic_overflow$0)]"#,
expect![[r#"
*arithmetic_overflow*
```
arithmetic_overflow
```
___
arithmetic operation overflows
"#]],
)
}
#[test]
fn hover_clippy_lint() {
check(
r#"#![allow(clippy::almost_swapped$0)]"#,
expect![[r#"
*almost_swapped*
```
clippy::almost_swapped
```
___
Checks for `foo = bar; bar = foo` sequences.
"#]],
)
}
}

View file

@ -3,20 +3,19 @@
//! This module uses a bit of static metadata to provide completions
//! for built-in attributes.
use ide_db::helpers::generated_lints::{CLIPPY_LINTS, DEFAULT_LINTS, FEATURES};
use once_cell::sync::Lazy;
use rustc_hash::{FxHashMap, FxHashSet};
use syntax::{algo::non_trivia_sibling, ast, AstNode, Direction, NodeOrToken, SyntaxKind, T};
use crate::{
context::CompletionContext,
generated_lint_completions::{CLIPPY_LINTS, FEATURES},
item::{CompletionItem, CompletionItemKind, CompletionKind},
Completions,
};
mod derive;
mod lint;
pub(crate) use self::lint::LintCompletion;
pub(crate) fn complete_attribute(acc: &mut Completions, ctx: &CompletionContext) -> Option<()> {
let attribute = ctx.attribute_under_caret.as_ref()?;
@ -25,7 +24,7 @@ pub(crate) fn complete_attribute(acc: &mut Completions, ctx: &CompletionContext)
"derive" => derive::complete_derive(acc, ctx, token_tree),
"feature" => lint::complete_lint(acc, ctx, token_tree, FEATURES),
"allow" | "warn" | "deny" | "forbid" => {
lint::complete_lint(acc, ctx, token_tree.clone(), lint::DEFAULT_LINT_COMPLETIONS);
lint::complete_lint(acc, ctx, token_tree.clone(), DEFAULT_LINTS);
lint::complete_lint(acc, ctx, token_tree, CLIPPY_LINTS);
}
_ => (),

View file

@ -1,4 +1,5 @@
//! Completion for lints
use ide_db::helpers::generated_lints::Lint;
use syntax::ast;
use crate::{
@ -11,7 +12,7 @@ pub(super) fn complete_lint(
acc: &mut Completions,
ctx: &CompletionContext,
derive_input: ast::TokenTree,
lints_completions: &[LintCompletion],
lints_completions: &[Lint],
) {
if let Some(existing_lints) = super::parse_comma_sep_input(derive_input) {
for lint_completion in lints_completions
@ -29,130 +30,6 @@ pub(super) fn complete_lint(
}
}
pub struct LintCompletion {
pub label: &'static str,
pub description: &'static str,
}
#[rustfmt::skip]
pub const DEFAULT_LINT_COMPLETIONS: &[LintCompletion] = &[
LintCompletion { label: "absolute_paths_not_starting_with_crate", description: r#"fully qualified paths that start with a module name instead of `crate`, `self`, or an extern crate name"# },
LintCompletion { label: "ambiguous_associated_items", description: r#"ambiguous associated items"# },
LintCompletion { label: "anonymous_parameters", description: r#"detects anonymous parameters"# },
LintCompletion { label: "arithmetic_overflow", description: r#"arithmetic operation overflows"# },
LintCompletion { label: "array_into_iter", description: r#"detects calling `into_iter` on arrays"# },
LintCompletion { label: "asm_sub_register", description: r#"using only a subset of a register for inline asm inputs"# },
LintCompletion { label: "bare_trait_objects", description: r#"suggest using `dyn Trait` for trait objects"# },
LintCompletion { label: "bindings_with_variant_name", description: r#"detects pattern bindings with the same name as one of the matched variants"# },
LintCompletion { label: "box_pointers", description: r#"use of owned (Box type) heap memory"# },
LintCompletion { label: "cenum_impl_drop_cast", description: r#"a C-like enum implementing Drop is cast"# },
LintCompletion { label: "clashing_extern_declarations", description: r#"detects when an extern fn has been declared with the same name but different types"# },
LintCompletion { label: "coherence_leak_check", description: r#"distinct impls distinguished only by the leak-check code"# },
LintCompletion { label: "conflicting_repr_hints", description: r#"conflicts between `#[repr(..)]` hints that were previously accepted and used in practice"# },
LintCompletion { label: "confusable_idents", description: r#"detects visually confusable pairs between identifiers"# },
LintCompletion { label: "const_err", description: r#"constant evaluation detected erroneous expression"# },
LintCompletion { label: "dead_code", description: r#"detect unused, unexported items"# },
LintCompletion { label: "deprecated_in_future", description: r#"detects use of items that will be deprecated in a future version"# },
LintCompletion { label: "deprecated", description: r#"detects use of deprecated items"# },
LintCompletion { label: "elided_lifetimes_in_paths", description: r#"hidden lifetime parameters in types are deprecated"# },
LintCompletion { label: "ellipsis_inclusive_range_patterns", description: r#"`...` range patterns are deprecated"# },
LintCompletion { label: "explicit_outlives_requirements", description: r#"outlives requirements can be inferred"# },
LintCompletion { label: "exported_private_dependencies", description: r#"public interface leaks type from a private dependency"# },
LintCompletion { label: "ill_formed_attribute_input", description: r#"ill-formed attribute inputs that were previously accepted and used in practice"# },
LintCompletion { label: "illegal_floating_point_literal_pattern", description: r#"floating-point literals cannot be used in patterns"# },
LintCompletion { label: "improper_ctypes_definitions", description: r#"proper use of libc types in foreign item definitions"# },
LintCompletion { label: "improper_ctypes", description: r#"proper use of libc types in foreign modules"# },
LintCompletion { label: "incomplete_features", description: r#"incomplete features that may function improperly in some or all cases"# },
LintCompletion { label: "incomplete_include", description: r#"trailing content in included file"# },
LintCompletion { label: "indirect_structural_match", description: r#"pattern with const indirectly referencing non-structural-match type"# },
LintCompletion { label: "inline_no_sanitize", description: r#"detects incompatible use of `#[inline(always)]` and `#[no_sanitize(...)]`"# },
LintCompletion { label: "intra_doc_link_resolution_failure", description: r#"failures in resolving intra-doc link targets"# },
LintCompletion { label: "invalid_codeblock_attributes", description: r#"codeblock attribute looks a lot like a known one"# },
LintCompletion { label: "invalid_type_param_default", description: r#"type parameter default erroneously allowed in invalid location"# },
LintCompletion { label: "invalid_value", description: r#"an invalid value is being created (such as a NULL reference)"# },
LintCompletion { label: "irrefutable_let_patterns", description: r#"detects irrefutable patterns in if-let and while-let statements"# },
LintCompletion { label: "keyword_idents", description: r#"detects edition keywords being used as an identifier"# },
LintCompletion { label: "late_bound_lifetime_arguments", description: r#"detects generic lifetime arguments in path segments with late bound lifetime parameters"# },
LintCompletion { label: "macro_expanded_macro_exports_accessed_by_absolute_paths", description: r#"macro-expanded `macro_export` macros from the current crate cannot be referred to by absolute paths"# },
LintCompletion { label: "macro_use_extern_crate", description: r#"the `#[macro_use]` attribute is now deprecated in favor of using macros via the module system"# },
LintCompletion { label: "meta_variable_misuse", description: r#"possible meta-variable misuse at macro definition"# },
LintCompletion { label: "missing_copy_implementations", description: r#"detects potentially-forgotten implementations of `Copy`"# },
LintCompletion { label: "missing_crate_level_docs", description: r#"detects crates with no crate-level documentation"# },
LintCompletion { label: "missing_debug_implementations", description: r#"detects missing implementations of Debug"# },
LintCompletion { label: "missing_doc_code_examples", description: r#"detects publicly-exported items without code samples in their documentation"# },
LintCompletion { label: "missing_docs", description: r#"detects missing documentation for public members"# },
LintCompletion { label: "missing_fragment_specifier", description: r#"detects missing fragment specifiers in unused `macro_rules!` patterns"# },
LintCompletion { label: "mixed_script_confusables", description: r#"detects Unicode scripts whose mixed script confusables codepoints are solely used"# },
LintCompletion { label: "mutable_borrow_reservation_conflict", description: r#"reservation of a two-phased borrow conflicts with other shared borrows"# },
LintCompletion { label: "mutable_transmutes", description: r#"mutating transmuted &mut T from &T may cause undefined behavior"# },
LintCompletion { label: "no_mangle_const_items", description: r#"const items will not have their symbols exported"# },
LintCompletion { label: "no_mangle_generic_items", description: r#"generic items must be mangled"# },
LintCompletion { label: "non_ascii_idents", description: r#"detects non-ASCII identifiers"# },
LintCompletion { label: "non_camel_case_types", description: r#"types, variants, traits and type parameters should have camel case names"# },
LintCompletion { label: "non_shorthand_field_patterns", description: r#"using `Struct { x: x }` instead of `Struct { x }` in a pattern"# },
LintCompletion { label: "non_snake_case", description: r#"variables, methods, functions, lifetime parameters and modules should have snake case names"# },
LintCompletion { label: "non_upper_case_globals", description: r#"static constants should have uppercase identifiers"# },
LintCompletion { label: "order_dependent_trait_objects", description: r#"trait-object types were treated as different depending on marker-trait order"# },
LintCompletion { label: "overflowing_literals", description: r#"literal out of range for its type"# },
LintCompletion { label: "overlapping_patterns", description: r#"detects overlapping patterns"# },
LintCompletion { label: "path_statements", description: r#"path statements with no effect"# },
LintCompletion { label: "patterns_in_fns_without_body", description: r#"patterns in functions without body were erroneously allowed"# },
LintCompletion { label: "private_doc_tests", description: r#"detects code samples in docs of private items not documented by rustdoc"# },
LintCompletion { label: "private_in_public", description: r#"detect private items in public interfaces not caught by the old implementation"# },
LintCompletion { label: "proc_macro_derive_resolution_fallback", description: r#"detects proc macro derives using inaccessible names from parent modules"# },
LintCompletion { label: "pub_use_of_private_extern_crate", description: r#"detect public re-exports of private extern crates"# },
LintCompletion { label: "redundant_semicolons", description: r#"detects unnecessary trailing semicolons"# },
LintCompletion { label: "renamed_and_removed_lints", description: r#"lints that have been renamed or removed"# },
LintCompletion { label: "safe_packed_borrows", description: r#"safe borrows of fields of packed structs were erroneously allowed"# },
LintCompletion { label: "single_use_lifetimes", description: r#"detects lifetime parameters that are only used once"# },
LintCompletion { label: "soft_unstable", description: r#"a feature gate that doesn't break dependent crates"# },
LintCompletion { label: "stable_features", description: r#"stable features found in `#[feature]` directive"# },
LintCompletion { label: "trivial_bounds", description: r#"these bounds don't depend on an type parameters"# },
LintCompletion { label: "trivial_casts", description: r#"detects trivial casts which could be removed"# },
LintCompletion { label: "trivial_numeric_casts", description: r#"detects trivial casts of numeric types which could be removed"# },
LintCompletion { label: "type_alias_bounds", description: r#"bounds in type aliases are not enforced"# },
LintCompletion { label: "tyvar_behind_raw_pointer", description: r#"raw pointer to an inference variable"# },
LintCompletion { label: "unaligned_references", description: r#"detects unaligned references to fields of packed structs"# },
LintCompletion { label: "uncommon_codepoints", description: r#"detects uncommon Unicode codepoints in identifiers"# },
LintCompletion { label: "unconditional_panic", description: r#"operation will cause a panic at runtime"# },
LintCompletion { label: "unconditional_recursion", description: r#"functions that cannot return without calling themselves"# },
LintCompletion { label: "unknown_crate_types", description: r#"unknown crate type found in `#[crate_type]` directive"# },
LintCompletion { label: "unknown_lints", description: r#"unrecognized lint attribute"# },
LintCompletion { label: "unnameable_test_items", description: r#"detects an item that cannot be named being marked as `#[test_case]`"# },
LintCompletion { label: "unreachable_code", description: r#"detects unreachable code paths"# },
LintCompletion { label: "unreachable_patterns", description: r#"detects unreachable patterns"# },
LintCompletion { label: "unreachable_pub", description: r#"`pub` items not reachable from crate root"# },
LintCompletion { label: "unsafe_code", description: r#"usage of `unsafe` code"# },
LintCompletion { label: "unsafe_op_in_unsafe_fn", description: r#"unsafe operations in unsafe functions without an explicit unsafe block are deprecated"# },
LintCompletion { label: "unstable_features", description: r#"enabling unstable features (deprecated. do not use)"# },
LintCompletion { label: "unstable_name_collisions", description: r#"detects name collision with an existing but unstable method"# },
LintCompletion { label: "unused_allocation", description: r#"detects unnecessary allocations that can be eliminated"# },
LintCompletion { label: "unused_assignments", description: r#"detect assignments that will never be read"# },
LintCompletion { label: "unused_attributes", description: r#"detects attributes that were not used by the compiler"# },
LintCompletion { label: "unused_braces", description: r#"unnecessary braces around an expression"# },
LintCompletion { label: "unused_comparisons", description: r#"comparisons made useless by limits of the types involved"# },
LintCompletion { label: "unused_crate_dependencies", description: r#"crate dependencies that are never used"# },
LintCompletion { label: "unused_doc_comments", description: r#"detects doc comments that aren't used by rustdoc"# },
LintCompletion { label: "unused_extern_crates", description: r#"extern crates that are never used"# },
LintCompletion { label: "unused_features", description: r#"unused features found in crate-level `#[feature]` directives"# },
LintCompletion { label: "unused_import_braces", description: r#"unnecessary braces around an imported item"# },
LintCompletion { label: "unused_imports", description: r#"imports that are never used"# },
LintCompletion { label: "unused_labels", description: r#"detects labels that are never used"# },
LintCompletion { label: "unused_lifetimes", description: r#"detects lifetime parameters that are never used"# },
LintCompletion { label: "unused_macros", description: r#"detects macros that were not used"# },
LintCompletion { label: "unused_must_use", description: r#"unused result of a type flagged as `#[must_use]`"# },
LintCompletion { label: "unused_mut", description: r#"detect mut variables which don't need to be mutable"# },
LintCompletion { label: "unused_parens", description: r#"`if`, `match`, `while` and `return` do not need parentheses"# },
LintCompletion { label: "unused_qualifications", description: r#"detects unnecessarily qualified names"# },
LintCompletion { label: "unused_results", description: r#"unused result of an expression in a statement"# },
LintCompletion { label: "unused_unsafe", description: r#"unnecessary use of an `unsafe` block"# },
LintCompletion { label: "unused_variables", description: r#"detect variables which are not used in any way"# },
LintCompletion { label: "variant_size_differences", description: r#"detects enums with widely varying variant sizes"# },
LintCompletion { label: "warnings", description: r#"mass-change the level for lints which produce warnings"# },
LintCompletion { label: "where_clauses_object_safety", description: r#"checks the object safety of where clauses"# },
LintCompletion { label: "while_true", description: r#"suggest using `loop { }` instead of `while true { }`"# },
];
#[cfg(test)]
mod tests {

View file

@ -10,8 +10,6 @@
mod completions;
pub mod generated_lint_completions;
use completions::flyimport::position_for_import;
use ide_db::{
base_db::FilePosition,

View file

@ -3,6 +3,7 @@
pub mod insert_use;
pub mod merge_imports;
pub mod rust_doc;
pub mod generated_lints;
use std::collections::VecDeque;

View file

@ -12,23 +12,54 @@ pub(crate) fn generate_lint_completions() -> Result<()> {
cmd!("git clone --depth=1 https://github.com/rust-lang/rust ./target/rust").run()?;
}
let mut contents = String::from("use crate::completions::attribute::LintCompletion;\n\n");
generate_descriptor(&mut contents, "./target/rust/src/doc/unstable-book/src".into())?;
let mut contents = String::from(
r#"pub struct Lint {
pub label: &'static str,
pub description: &'static str,
}
"#,
);
generate_lint_descriptor(&mut contents)?;
contents.push('\n');
generate_feature_descriptor(&mut contents, "./target/rust/src/doc/unstable-book/src".into())?;
contents.push('\n');
cmd!("curl http://rust-lang.github.io/rust-clippy/master/lints.json --output ./target/clippy_lints.json").run()?;
generate_descriptor_clippy(&mut contents, &Path::new("./target/clippy_lints.json"))?;
let contents = reformat(&contents)?;
let destination =
project_root().join("crates/ide_completion/src/generated_lint_completions.rs");
let destination = project_root().join("crates/ide_db/src/helpers/generated_lints.rs");
ensure_file_contents(destination.as_path(), &contents)?;
Ok(())
}
fn generate_descriptor(buf: &mut String, src_dir: PathBuf) -> Result<()> {
buf.push_str(r#"pub const FEATURES: &[LintCompletion] = &["#);
fn generate_lint_descriptor(buf: &mut String) -> Result<()> {
let stdout = cmd!("rustc -W help").read()?;
let start = stdout.find("---- ------- -------").ok_or_else(|| anyhow::format_err!(""))?;
let end =
stdout.rfind("Lint groups provided by rustc:").ok_or_else(|| anyhow::format_err!(""))?;
buf.push_str(r#"pub const DEFAULT_LINTS: &[Lint] = &["#);
buf.push('\n');
let mut lints = stdout[start..end]
.lines()
.filter(|l| !l.is_empty())
.flat_map(|line| {
let (name, rest) = line.trim().split_once(char::is_whitespace)?;
let (_default_level, description) = rest.trim().split_once(char::is_whitespace)?;
Some((name.trim(), description.trim()))
})
.collect::<Vec<_>>();
lints.sort_by(|(ident, _), (ident2, _)| ident.cmp(ident2));
lints.into_iter().for_each(|(name, description)| push_lint_completion(buf, name, description));
buf.push_str("];\n");
Ok(())
}
fn generate_feature_descriptor(buf: &mut String, src_dir: PathBuf) -> Result<()> {
buf.push_str(r#"pub const FEATURES: &[Lint] = &["#);
buf.push('\n');
let mut vec = ["language-features", "library-features"]
.iter()
@ -46,9 +77,8 @@ fn generate_descriptor(buf: &mut String, src_dir: PathBuf) -> Result<()> {
})
.collect::<Vec<_>>();
vec.sort_by(|(feature_ident, _), (feature_ident2, _)| feature_ident.cmp(feature_ident2));
vec.into_iter().for_each(|(feature_ident, doc)| {
push_lint_completion(buf, &feature_ident, &doc);
});
vec.into_iter()
.for_each(|(feature_ident, doc)| push_lint_completion(buf, &feature_ident, &doc));
buf.push_str("];\n");
Ok(())
}
@ -90,7 +120,7 @@ fn generate_descriptor_clippy(buf: &mut String, path: &Path) -> Result<()> {
}
}
clippy_lints.sort_by(|lint, lint2| lint.id.cmp(&lint2.id));
buf.push_str(r#"pub const CLIPPY_LINTS: &[LintCompletion] = &["#);
buf.push_str(r#"pub const CLIPPY_LINTS: &[Lint] = &["#);
buf.push('\n');
clippy_lints.into_iter().for_each(|clippy_lint| {
let lint_ident = format!("clippy::{}", clippy_lint.id);
@ -106,7 +136,7 @@ fn generate_descriptor_clippy(buf: &mut String, path: &Path) -> Result<()> {
fn push_lint_completion(buf: &mut String, label: &str, description: &str) {
writeln!(
buf,
r###" LintCompletion {{
r###" Lint {{
label: "{}",
description: r##"{}"##
}},"###,