1 //! Collects diagnostics & fixits for a single file.
3 //! The tricky bit here is that diagnostics are produced by hir in terms of
4 //! macro-expanded files, but we need to present them to the users in terms of
5 //! original files. So we need to map the ranges.
10 use std::cell::RefCell;
14 diagnostics::{Diagnostic as _, DiagnosticCode, DiagnosticSinkBuilder},
17 use ide_db::{base_db::SourceDatabase, RootDatabase};
18 use itertools::Itertools;
19 use rustc_hash::FxHashSet;
22 SyntaxNode, SyntaxNodePtr, TextRange,
24 use text_edit::TextEdit;
26 use crate::{FileId, Label, SourceChange};
28 use self::fixes::DiagnosticWithFix;
31 pub struct Diagnostic {
32 // pub name: Option<String>,
35 pub severity: Severity,
38 pub code: Option<DiagnosticCode>,
42 fn error(range: TextRange, message: String) -> Self {
43 Self { message, range, severity: Severity::Error, fix: None, unused: false, code: None }
46 fn hint(range: TextRange, message: String) -> Self {
50 severity: Severity::WeakWarning,
57 fn with_fix(self, fix: Option<Fix>) -> Self {
61 fn with_unused(self, unused: bool) -> Self {
62 Self { unused, ..self }
65 fn with_code(self, code: Option<DiagnosticCode>) -> Self {
73 pub source_change: SourceChange,
74 /// Allows to trigger the fix only when the caret is in the range given
75 pub fix_trigger_range: TextRange,
79 fn new(label: &str, source_change: SourceChange, fix_trigger_range: TextRange) -> Self {
80 let label = Label::new(label);
81 Self { label, source_change, fix_trigger_range }
85 #[derive(Debug, Copy, Clone)]
91 #[derive(Default, Debug, Clone)]
92 pub struct DiagnosticsConfig {
93 pub disable_experimental: bool,
94 pub disabled: FxHashSet<String>,
97 pub(crate) fn diagnostics(
99 config: &DiagnosticsConfig,
101 ) -> Vec<Diagnostic> {
102 let _p = profile::span("diagnostics");
103 let sema = Semantics::new(db);
104 let parse = db.parse(file_id);
105 let mut res = Vec::new();
107 // [#34344] Only take first 128 errors to prevent slowing down editor/ide, the number 128 is chosen arbitrarily.
113 .map(|err| Diagnostic::error(err.range(), format!("Syntax Error: {}", err))),
116 for node in parse.tree().syntax().descendants() {
117 check_unnecessary_braces_in_use_statement(&mut res, file_id, &node);
118 field_shorthand::check(&mut res, file_id, &node);
120 let res = RefCell::new(res);
121 let sink_builder = DiagnosticSinkBuilder::new()
122 .on::<hir::diagnostics::UnresolvedModule, _>(|d| {
123 res.borrow_mut().push(diagnostic_with_fix(d, &sema));
125 .on::<hir::diagnostics::MissingFields, _>(|d| {
126 res.borrow_mut().push(diagnostic_with_fix(d, &sema));
128 .on::<hir::diagnostics::MissingOkOrSomeInTailExpr, _>(|d| {
129 res.borrow_mut().push(diagnostic_with_fix(d, &sema));
131 .on::<hir::diagnostics::NoSuchField, _>(|d| {
132 res.borrow_mut().push(diagnostic_with_fix(d, &sema));
134 .on::<hir::diagnostics::RemoveThisSemicolon, _>(|d| {
135 res.borrow_mut().push(diagnostic_with_fix(d, &sema));
137 .on::<hir::diagnostics::IncorrectCase, _>(|d| {
138 res.borrow_mut().push(warning_with_fix(d, &sema));
140 .on::<hir::diagnostics::ReplaceFilterMapNextWithFindMap, _>(|d| {
141 res.borrow_mut().push(warning_with_fix(d, &sema));
143 .on::<hir::diagnostics::InactiveCode, _>(|d| {
144 // If there's inactive code somewhere in a macro, don't propagate to the call-site.
145 if d.display_source().file_id.expansion_info(db).is_some() {
149 // Override severity and mark as unused.
150 res.borrow_mut().push(
152 sema.diagnostics_display_range(d.display_source()).range,
156 .with_code(Some(d.code())),
159 .on::<hir::diagnostics::UnresolvedProcMacro, _>(|d| {
160 // Use more accurate position if available.
161 let display_range = d
163 .unwrap_or_else(|| sema.diagnostics_display_range(d.display_source()).range);
165 // FIXME: it would be nice to tell the user whether proc macros are currently disabled
167 .push(Diagnostic::hint(display_range, d.message()).with_code(Some(d.code())));
169 .on::<hir::diagnostics::UnresolvedMacroCall, _>(|d| {
170 let last_path_segment = sema.db.parse_or_expand(d.file).and_then(|root| {
174 .and_then(|it| it.segment())
175 .and_then(|it| it.name_ref())
176 .map(|it| InFile::new(d.file, SyntaxNodePtr::new(it.syntax())))
178 let diagnostics = last_path_segment.unwrap_or_else(|| d.display_source());
179 let display_range = sema.diagnostics_display_range(diagnostics).range;
181 .push(Diagnostic::error(display_range, d.message()).with_code(Some(d.code())));
183 // Only collect experimental diagnostics when they're enabled.
184 .filter(|diag| !(diag.is_experimental() && config.disable_experimental))
185 .filter(|diag| !config.disabled.contains(diag.code().as_str()));
187 // Finalize the `DiagnosticSink` building process.
188 let mut sink = sink_builder
189 // Diagnostics not handled above get no fix and default treatment.
191 res.borrow_mut().push(
193 sema.diagnostics_display_range(d.display_source()).range,
196 .with_code(Some(d.code())),
200 match sema.to_module_def(file_id) {
201 Some(m) => m.diagnostics(db, &mut sink),
203 res.borrow_mut().push(
205 parse.tree().syntax().text_range(),
206 "file not included in module tree".to_string(),
217 fn diagnostic_with_fix<D: DiagnosticWithFix>(d: &D, sema: &Semantics<RootDatabase>) -> Diagnostic {
218 Diagnostic::error(sema.diagnostics_display_range(d.display_source()).range, d.message())
219 .with_fix(d.fix(&sema))
220 .with_code(Some(d.code()))
223 fn warning_with_fix<D: DiagnosticWithFix>(d: &D, sema: &Semantics<RootDatabase>) -> Diagnostic {
224 Diagnostic::hint(sema.diagnostics_display_range(d.display_source()).range, d.message())
225 .with_fix(d.fix(&sema))
226 .with_code(Some(d.code()))
229 fn check_unnecessary_braces_in_use_statement(
230 acc: &mut Vec<Diagnostic>,
234 let use_tree_list = ast::UseTreeList::cast(node.clone())?;
235 if let Some((single_use_tree,)) = use_tree_list.use_trees().collect_tuple() {
236 // If there is a comment inside the bracketed `use`,
237 // assume it is a commented out module path and don't show diagnostic.
238 if use_tree_list.has_inner_comment() {
242 let use_range = use_tree_list.syntax().text_range();
244 text_edit_for_remove_unnecessary_braces_with_self_in_use_statement(&single_use_tree)
246 let to_replace = single_use_tree.syntax().text().to_string();
247 let mut edit_builder = TextEdit::builder();
248 edit_builder.delete(use_range);
249 edit_builder.insert(use_range.start(), to_replace);
250 edit_builder.finish()
254 Diagnostic::hint(use_range, "Unnecessary braces in use statement".to_string())
255 .with_fix(Some(Fix::new(
256 "Remove unnecessary braces",
257 SourceChange::from_text_edit(file_id, edit),
266 fn text_edit_for_remove_unnecessary_braces_with_self_in_use_statement(
267 single_use_tree: &ast::UseTree,
268 ) -> Option<TextEdit> {
269 let use_tree_list_node = single_use_tree.syntax().parent()?;
270 if single_use_tree.path()?.segment()?.self_token().is_some() {
271 let start = use_tree_list_node.prev_sibling_or_token()?.text_range().start();
272 let end = use_tree_list_node.text_range().end();
273 return Some(TextEdit::delete(TextRange::new(start, end)));
280 use expect_test::{expect, Expect};
281 use stdx::trim_indent;
282 use test_utils::assert_eq_text;
284 use crate::{fixture, DiagnosticsConfig};
286 /// Takes a multi-file input fixture with annotated cursor positions,
288 /// * a diagnostic is produced
289 /// * this diagnostic fix trigger range touches the input cursor position
290 /// * that the contents of the file containing the cursor match `after` after the diagnostic fix is applied
291 pub(crate) fn check_fix(ra_fixture_before: &str, ra_fixture_after: &str) {
292 let after = trim_indent(ra_fixture_after);
294 let (analysis, file_position) = fixture::position(ra_fixture_before);
295 let diagnostic = analysis
296 .diagnostics(&DiagnosticsConfig::default(), file_position.file_id)
300 let fix = diagnostic.fix.unwrap();
302 let file_id = *fix.source_change.source_file_edits.keys().next().unwrap();
303 let mut actual = analysis.file_text(file_id).unwrap().to_string();
305 for edit in fix.source_change.source_file_edits.values() {
306 edit.apply(&mut actual);
311 assert_eq_text!(&after, &actual);
313 fix.fix_trigger_range.contains_inclusive(file_position.offset),
314 "diagnostic fix range {:?} does not touch cursor position {:?}",
315 fix.fix_trigger_range,
320 /// Takes a multi-file input fixture with annotated cursor position and checks that no diagnostics
321 /// apply to the file containing the cursor.
322 pub(crate) fn check_no_diagnostics(ra_fixture: &str) {
323 let (analysis, files) = fixture::files(ra_fixture);
324 let diagnostics = files
326 .flat_map(|file_id| {
327 analysis.diagnostics(&DiagnosticsConfig::default(), file_id).unwrap()
329 .collect::<Vec<_>>();
330 assert_eq!(diagnostics.len(), 0, "unexpected diagnostics:\n{:#?}", diagnostics);
333 fn check_expect(ra_fixture: &str, expect: Expect) {
334 let (analysis, file_id) = fixture::file(ra_fixture);
335 let diagnostics = analysis.diagnostics(&DiagnosticsConfig::default(), file_id).unwrap();
336 expect.assert_debug_eq(&diagnostics)
340 fn test_wrap_return_type_option() {
343 //- /main.rs crate:main deps:core
344 use core::option::Option::{self, Some, None};
346 fn div(x: i32, y: i32) -> Option<i32> {
352 //- /core/lib.rs crate:core
354 pub enum Result<T, E> { Ok(T), Err(E) }
357 pub enum Option<T> { Some(T), None }
361 use core::option::Option::{self, Some, None};
363 fn div(x: i32, y: i32) -> Option<i32> {
374 fn test_wrap_return_type() {
377 //- /main.rs crate:main deps:core
378 use core::result::Result::{self, Ok, Err};
380 fn div(x: i32, y: i32) -> Result<i32, ()> {
386 //- /core/lib.rs crate:core
388 pub enum Result<T, E> { Ok(T), Err(E) }
391 pub enum Option<T> { Some(T), None }
395 use core::result::Result::{self, Ok, Err};
397 fn div(x: i32, y: i32) -> Result<i32, ()> {
408 fn test_wrap_return_type_handles_generic_functions() {
411 //- /main.rs crate:main deps:core
412 use core::result::Result::{self, Ok, Err};
414 fn div<T>(x: T) -> Result<T, i32> {
420 //- /core/lib.rs crate:core
422 pub enum Result<T, E> { Ok(T), Err(E) }
425 pub enum Option<T> { Some(T), None }
429 use core::result::Result::{self, Ok, Err};
431 fn div<T>(x: T) -> Result<T, i32> {
442 fn test_wrap_return_type_handles_type_aliases() {
445 //- /main.rs crate:main deps:core
446 use core::result::Result::{self, Ok, Err};
448 type MyResult<T> = Result<T, ()>;
450 fn div(x: i32, y: i32) -> MyResult<i32> {
456 //- /core/lib.rs crate:core
458 pub enum Result<T, E> { Ok(T), Err(E) }
461 pub enum Option<T> { Some(T), None }
465 use core::result::Result::{self, Ok, Err};
467 type MyResult<T> = Result<T, ()>;
469 fn div(x: i32, y: i32) -> MyResult<i32> {
480 fn test_wrap_return_type_not_applicable_when_expr_type_does_not_match_ok_type() {
481 check_no_diagnostics(
483 //- /main.rs crate:main deps:core
484 use core::result::Result::{self, Ok, Err};
486 fn foo() -> Result<(), i32> { 0 }
488 //- /core/lib.rs crate:core
490 pub enum Result<T, E> { Ok(T), Err(E) }
493 pub enum Option<T> { Some(T), None }
500 fn test_wrap_return_type_not_applicable_when_return_type_is_not_result_or_option() {
501 check_no_diagnostics(
503 //- /main.rs crate:main deps:core
504 use core::result::Result::{self, Ok, Err};
506 enum SomeOtherEnum { Ok(i32), Err(String) }
508 fn foo() -> SomeOtherEnum { 0 }
510 //- /core/lib.rs crate:core
512 pub enum Result<T, E> { Ok(T), Err(E) }
515 pub enum Option<T> { Some(T), None }
522 fn test_fill_struct_fields_empty() {
525 struct TestStruct { one: i32, two: i64 }
528 let s = TestStruct {$0};
532 struct TestStruct { one: i32, two: i64 }
535 let s = TestStruct { one: (), two: ()};
542 fn test_fill_struct_fields_self() {
545 struct TestStruct { one: i32 }
548 fn test_fn() { let s = Self {$0}; }
552 struct TestStruct { one: i32 }
555 fn test_fn() { let s = Self { one: ()}; }
562 fn test_fill_struct_fields_enum() {
566 Bin { lhs: Box<Expr>, rhs: Box<Expr> }
570 fn new_bin(lhs: Box<Expr>, rhs: Box<Expr>) -> Expr {
577 Bin { lhs: Box<Expr>, rhs: Box<Expr> }
581 fn new_bin(lhs: Box<Expr>, rhs: Box<Expr>) -> Expr {
582 Expr::Bin { lhs: (), rhs: () }
590 fn test_fill_struct_fields_partial() {
593 struct TestStruct { one: i32, two: i64 }
596 let s = TestStruct{ two: 2$0 };
600 struct TestStruct { one: i32, two: i64 }
603 let s = TestStruct{ two: 2, one: () };
610 fn test_fill_struct_fields_no_diagnostic() {
611 check_no_diagnostics(
613 struct TestStruct { one: i32, two: i64 }
617 let s = TestStruct{ one, two: 2 };
624 fn test_fill_struct_fields_no_diagnostic_on_spread() {
625 check_no_diagnostics(
627 struct TestStruct { one: i32, two: i64 }
631 let s = TestStruct{ ..a };
638 fn test_unresolved_module_diagnostic() {
644 message: "unresolved module",
649 label: "Create module",
650 source_change: SourceChange {
651 source_file_edits: {},
654 dst: AnchoredPathBuf {
660 initial_contents: "",
665 fix_trigger_range: 0..8,
681 fn test_unresolved_macro_range() {
687 message: "unresolved macro call",
694 "unresolved-macro-call",
704 fn range_mapping_out_of_macros() {
705 // FIXME: this is very wrong, but somewhat tricky to fix.
712 macro_rules! id { ($($tt:tt)*) => { $($tt)*}; }
715 let _x = id![Foo { a: $042 }];
718 pub struct Foo { pub a: i32, pub b: i32 }
725 macro_rules! id { ($($tt:tt)*) => { $($tt)*}; }
728 let _x = id![Foo { a: 42 }];
731 pub struct Foo { pub a: i32, pub b: i32 }
737 fn test_check_unnecessary_braces_in_use_statement() {
738 check_no_diagnostics(
751 check_no_diagnostics(
809 mod a { mod c {} mod d { mod e {} } }
810 use a::{c, d::{e$0}};
813 mod a { mod c {} mod d { mod e {} } }
820 fn test_add_field_from_usage() {
824 Foo { bar: 3, baz$0: false};
832 Foo { bar: 3, baz: false};
843 fn test_add_field_in_other_file_from_usage() {
850 foo::Foo { bar: 3, $0baz: false};
867 fn test_disabled_diagnostics() {
868 let mut config = DiagnosticsConfig::default();
869 config.disabled.insert("unresolved-module".into());
871 let (analysis, file_id) = fixture::file(r#"mod foo;"#);
873 let diagnostics = analysis.diagnostics(&config, file_id).unwrap();
874 assert!(diagnostics.is_empty());
876 let diagnostics = analysis.diagnostics(&DiagnosticsConfig::default(), file_id).unwrap();
877 assert!(!diagnostics.is_empty());
881 fn test_rename_incorrect_case() {
884 pub struct test_struct$0 { one: i32 }
886 pub fn some_fn(val: test_struct) -> test_struct {
887 test_struct { one: val.one + 1 }
891 pub struct TestStruct { one: i32 }
893 pub fn some_fn(val: TestStruct) -> TestStruct {
894 TestStruct { one: val.one + 1 }
901 pub fn some_fn(NonSnakeCase$0: u8) -> u8 {
906 pub fn some_fn(non_snake_case: u8) -> u8 {
914 pub fn SomeFn$0(val: u8) -> u8 {
915 if val != 0 { SomeFn(val - 1) } else { val }
919 pub fn some_fn(val: u8) -> u8 {
920 if val != 0 { some_fn(val - 1) } else { val }
928 let whatAWeird_Formatting$0 = 10;
929 another_func(whatAWeird_Formatting);
934 let what_a_weird_formatting = 10;
935 another_func(what_a_weird_formatting);
942 fn test_uppercase_const_no_diagnostics() {
943 check_no_diagnostics(
946 const ANOTHER_ITEM$0: &str = "some_item";
953 fn test_rename_incorrect_case_struct_method() {
956 pub struct TestStruct;
959 pub fn SomeFn$0() -> TestStruct {
965 pub struct TestStruct;
968 pub fn some_fn() -> TestStruct {
977 fn test_single_incorrect_case_diagnostic_in_function_name_issue_6970() {
978 let input = r#"fn FOO$0() {}"#;
979 let expected = r#"fn foo() {}"#;
981 let (analysis, file_position) = fixture::position(input);
983 analysis.diagnostics(&DiagnosticsConfig::default(), file_position.file_id).unwrap();
984 assert_eq!(diagnostics.len(), 1);
986 check_fix(input, expected);