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;
13 diagnostics::{Diagnostic as _, DiagnosticCode, DiagnosticSinkBuilder},
16 use ide_db::base_db::SourceDatabase;
17 use ide_db::RootDatabase;
18 use itertools::Itertools;
19 use rustc_hash::FxHashSet;
22 SyntaxNode, TextRange, T,
24 use text_edit::TextEdit;
26 use crate::{FileId, Label, SourceChange, SourceFileEdit};
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::MissingOkInTailExpr, _>(|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::InactiveCode, _>(|d| {
141 // If there's inactive code somewhere in a macro, don't propagate to the call-site.
142 if d.display_source().file_id.expansion_info(db).is_some() {
146 // Override severity and mark as unused.
147 res.borrow_mut().push(
148 Diagnostic::hint(sema.diagnostics_display_range(d).range, d.message())
150 .with_code(Some(d.code())),
153 .on::<hir::diagnostics::UnresolvedProcMacro, _>(|d| {
154 // Use more accurate position if available.
156 d.precise_location.unwrap_or_else(|| sema.diagnostics_display_range(d).range);
158 // FIXME: it would be nice to tell the user whether proc macros are currently disabled
160 .push(Diagnostic::hint(display_range, d.message()).with_code(Some(d.code())));
162 // Only collect experimental diagnostics when they're enabled.
163 .filter(|diag| !(diag.is_experimental() && config.disable_experimental))
164 .filter(|diag| !config.disabled.contains(diag.code().as_str()));
166 // Finalize the `DiagnosticSink` building process.
167 let mut sink = sink_builder
168 // Diagnostics not handled above get no fix and default treatment.
170 res.borrow_mut().push(
171 Diagnostic::error(sema.diagnostics_display_range(d).range, d.message())
172 .with_code(Some(d.code())),
176 if let Some(m) = sema.to_module_def(file_id) {
177 m.diagnostics(db, &mut sink);
183 fn diagnostic_with_fix<D: DiagnosticWithFix>(d: &D, sema: &Semantics<RootDatabase>) -> Diagnostic {
184 Diagnostic::error(sema.diagnostics_display_range(d).range, d.message())
185 .with_fix(d.fix(&sema))
186 .with_code(Some(d.code()))
189 fn warning_with_fix<D: DiagnosticWithFix>(d: &D, sema: &Semantics<RootDatabase>) -> Diagnostic {
190 Diagnostic::hint(sema.diagnostics_display_range(d).range, d.message())
191 .with_fix(d.fix(&sema))
192 .with_code(Some(d.code()))
195 fn check_unnecessary_braces_in_use_statement(
196 acc: &mut Vec<Diagnostic>,
200 let use_tree_list = ast::UseTreeList::cast(node.clone())?;
201 if let Some((single_use_tree,)) = use_tree_list.use_trees().collect_tuple() {
202 // If there is a comment inside the bracketed `use`,
203 // assume it is a commented out module path and don't show diagnostic.
204 if use_tree_list.has_inner_comment() {
208 let use_range = use_tree_list.syntax().text_range();
210 text_edit_for_remove_unnecessary_braces_with_self_in_use_statement(&single_use_tree)
212 let to_replace = single_use_tree.syntax().text().to_string();
213 let mut edit_builder = TextEdit::builder();
214 edit_builder.delete(use_range);
215 edit_builder.insert(use_range.start(), to_replace);
216 edit_builder.finish()
220 Diagnostic::hint(use_range, "Unnecessary braces in use statement".to_string())
221 .with_fix(Some(Fix::new(
222 "Remove unnecessary braces",
223 SourceFileEdit { file_id, edit }.into(),
232 fn text_edit_for_remove_unnecessary_braces_with_self_in_use_statement(
233 single_use_tree: &ast::UseTree,
234 ) -> Option<TextEdit> {
235 let use_tree_list_node = single_use_tree.syntax().parent()?;
236 if single_use_tree.path()?.segment()?.syntax().first_child_or_token()?.kind() == T![self] {
237 let start = use_tree_list_node.prev_sibling_or_token()?.text_range().start();
238 let end = use_tree_list_node.text_range().end();
239 return Some(TextEdit::delete(TextRange::new(start, end)));
246 use expect_test::{expect, Expect};
247 use stdx::trim_indent;
248 use test_utils::assert_eq_text;
250 use crate::{fixture, DiagnosticsConfig};
252 /// Takes a multi-file input fixture with annotated cursor positions,
254 /// * a diagnostic is produced
255 /// * this diagnostic fix trigger range touches the input cursor position
256 /// * that the contents of the file containing the cursor match `after` after the diagnostic fix is applied
257 pub(crate) fn check_fix(ra_fixture_before: &str, ra_fixture_after: &str) {
258 let after = trim_indent(ra_fixture_after);
260 let (analysis, file_position) = fixture::position(ra_fixture_before);
261 let diagnostic = analysis
262 .diagnostics(&DiagnosticsConfig::default(), file_position.file_id)
266 let fix = diagnostic.fix.unwrap();
268 let file_id = fix.source_change.source_file_edits.first().unwrap().file_id;
269 let mut actual = analysis.file_text(file_id).unwrap().to_string();
271 // Go from the last one to the first one, so that ranges won't be affected by previous edits.
272 // FIXME: https://github.com/rust-analyzer/rust-analyzer/issues/4901#issuecomment-644675309
273 for edit in fix.source_change.source_file_edits.iter().rev() {
274 edit.edit.apply(&mut actual);
279 assert_eq_text!(&after, &actual);
281 fix.fix_trigger_range.contains_inclusive(file_position.offset),
282 "diagnostic fix range {:?} does not touch cursor position {:?}",
283 fix.fix_trigger_range,
288 /// Takes a multi-file input fixture with annotated cursor position and checks that no diagnostics
289 /// apply to the file containing the cursor.
290 pub(crate) fn check_no_diagnostics(ra_fixture: &str) {
291 let (analysis, files) = fixture::files(ra_fixture);
292 let diagnostics = files
294 .flat_map(|file_id| {
295 analysis.diagnostics(&DiagnosticsConfig::default(), file_id).unwrap()
297 .collect::<Vec<_>>();
298 assert_eq!(diagnostics.len(), 0, "unexpected diagnostics:\n{:#?}", diagnostics);
301 fn check_expect(ra_fixture: &str, expect: Expect) {
302 let (analysis, file_id) = fixture::file(ra_fixture);
303 let diagnostics = analysis.diagnostics(&DiagnosticsConfig::default(), file_id).unwrap();
304 expect.assert_debug_eq(&diagnostics)
308 fn test_wrap_return_type() {
311 //- /main.rs crate:main deps:core
312 use core::result::Result::{self, Ok, Err};
314 fn div(x: i32, y: i32) -> Result<i32, ()> {
320 //- /core/lib.rs crate:core
322 pub enum Result<T, E> { Ok(T), Err(E) }
326 use core::result::Result::{self, Ok, Err};
328 fn div(x: i32, y: i32) -> Result<i32, ()> {
339 fn test_wrap_return_type_handles_generic_functions() {
342 //- /main.rs crate:main deps:core
343 use core::result::Result::{self, Ok, Err};
345 fn div<T>(x: T) -> Result<T, i32> {
351 //- /core/lib.rs crate:core
353 pub enum Result<T, E> { Ok(T), Err(E) }
357 use core::result::Result::{self, Ok, Err};
359 fn div<T>(x: T) -> Result<T, i32> {
370 fn test_wrap_return_type_handles_type_aliases() {
373 //- /main.rs crate:main deps:core
374 use core::result::Result::{self, Ok, Err};
376 type MyResult<T> = Result<T, ()>;
378 fn div(x: i32, y: i32) -> MyResult<i32> {
384 //- /core/lib.rs crate:core
386 pub enum Result<T, E> { Ok(T), Err(E) }
390 use core::result::Result::{self, Ok, Err};
392 type MyResult<T> = Result<T, ()>;
394 fn div(x: i32, y: i32) -> MyResult<i32> {
405 fn test_wrap_return_type_not_applicable_when_expr_type_does_not_match_ok_type() {
406 check_no_diagnostics(
408 //- /main.rs crate:main deps:core
409 use core::result::Result::{self, Ok, Err};
411 fn foo() -> Result<(), i32> { 0 }
413 //- /core/lib.rs crate:core
415 pub enum Result<T, E> { Ok(T), Err(E) }
422 fn test_wrap_return_type_not_applicable_when_return_type_is_not_result() {
423 check_no_diagnostics(
425 //- /main.rs crate:main deps:core
426 use core::result::Result::{self, Ok, Err};
428 enum SomeOtherEnum { Ok(i32), Err(String) }
430 fn foo() -> SomeOtherEnum { 0 }
432 //- /core/lib.rs crate:core
434 pub enum Result<T, E> { Ok(T), Err(E) }
441 fn test_fill_struct_fields_empty() {
444 struct TestStruct { one: i32, two: i64 }
447 let s = TestStruct {<|>};
451 struct TestStruct { one: i32, two: i64 }
454 let s = TestStruct { one: (), two: ()};
461 fn test_fill_struct_fields_self() {
464 struct TestStruct { one: i32 }
467 fn test_fn() { let s = Self {<|>}; }
471 struct TestStruct { one: i32 }
474 fn test_fn() { let s = Self { one: ()}; }
481 fn test_fill_struct_fields_enum() {
485 Bin { lhs: Box<Expr>, rhs: Box<Expr> }
489 fn new_bin(lhs: Box<Expr>, rhs: Box<Expr>) -> Expr {
496 Bin { lhs: Box<Expr>, rhs: Box<Expr> }
500 fn new_bin(lhs: Box<Expr>, rhs: Box<Expr>) -> Expr {
501 Expr::Bin { lhs: (), rhs: () }
509 fn test_fill_struct_fields_partial() {
512 struct TestStruct { one: i32, two: i64 }
515 let s = TestStruct{ two: 2<|> };
519 struct TestStruct { one: i32, two: i64 }
522 let s = TestStruct{ two: 2, one: () };
529 fn test_fill_struct_fields_no_diagnostic() {
530 check_no_diagnostics(
532 struct TestStruct { one: i32, two: i64 }
536 let s = TestStruct{ one, two: 2 };
543 fn test_fill_struct_fields_no_diagnostic_on_spread() {
544 check_no_diagnostics(
546 struct TestStruct { one: i32, two: i64 }
550 let s = TestStruct{ ..a };
557 fn test_unresolved_module_diagnostic() {
563 message: "unresolved module",
568 label: "Create module",
569 source_change: SourceChange {
570 source_file_edits: [],
573 dst: AnchoredPathBuf {
579 initial_contents: "",
584 fix_trigger_range: 0..8,
600 fn range_mapping_out_of_macros() {
601 // FIXME: this is very wrong, but somewhat tricky to fix.
608 macro_rules! id { ($($tt:tt)*) => { $($tt)*}; }
611 let _x = id![Foo { a: <|>42 }];
614 pub struct Foo { pub a: i32, pub b: i32 }
621 macro_rules! id { ($($tt:tt)*) => { $($tt)*}; }
624 let _x = id![Foo { a: 42 }];
627 pub struct Foo { pub a: i32, pub b: i32 }
633 fn test_check_unnecessary_braces_in_use_statement() {
634 check_no_diagnostics(
647 check_no_diagnostics(
705 mod a { mod c {} mod d { mod e {} } }
706 use a::{c, d::{e<|>}};
709 mod a { mod c {} mod d { mod e {} } }
716 fn test_add_field_from_usage() {
720 Foo { bar: 3, baz<|>: false};
728 Foo { bar: 3, baz: false};
739 fn test_add_field_in_other_file_from_usage() {
746 foo::Foo { bar: 3, <|>baz: false};
763 fn test_disabled_diagnostics() {
764 let mut config = DiagnosticsConfig::default();
765 config.disabled.insert("unresolved-module".into());
767 let (analysis, file_id) = fixture::file(r#"mod foo;"#);
769 let diagnostics = analysis.diagnostics(&config, file_id).unwrap();
770 assert!(diagnostics.is_empty());
772 let diagnostics = analysis.diagnostics(&DiagnosticsConfig::default(), file_id).unwrap();
773 assert!(!diagnostics.is_empty());
777 fn test_rename_incorrect_case() {
780 pub struct test_struct<|> { one: i32 }
782 pub fn some_fn(val: test_struct) -> test_struct {
783 test_struct { one: val.one + 1 }
787 pub struct TestStruct { one: i32 }
789 pub fn some_fn(val: TestStruct) -> TestStruct {
790 TestStruct { one: val.one + 1 }
797 pub fn some_fn(NonSnakeCase<|>: u8) -> u8 {
802 pub fn some_fn(non_snake_case: u8) -> u8 {
810 pub fn SomeFn<|>(val: u8) -> u8 {
811 if val != 0 { SomeFn(val - 1) } else { val }
815 pub fn some_fn(val: u8) -> u8 {
816 if val != 0 { some_fn(val - 1) } else { val }
824 let whatAWeird_Formatting<|> = 10;
825 another_func(whatAWeird_Formatting);
830 let what_a_weird_formatting = 10;
831 another_func(what_a_weird_formatting);
838 fn test_uppercase_const_no_diagnostics() {
839 check_no_diagnostics(
842 const ANOTHER_ITEM<|>: &str = "some_item";
849 fn test_rename_incorrect_case_struct_method() {
852 pub struct TestStruct;
855 pub fn SomeFn<|>() -> TestStruct {
861 pub struct TestStruct;
864 pub fn some_fn() -> TestStruct {
873 fn test_single_incorrect_case_diagnostic_in_function_name_issue_6970() {
874 let input = r#"fn FOO<|>() {}"#;
875 let expected = r#"fn foo() {}"#;
877 let (analysis, file_position) = fixture::position(input);
879 analysis.diagnostics(&DiagnosticsConfig::default(), file_position.file_id).unwrap();
880 assert_eq!(diagnostics.len(), 1);
882 check_fix(input, expected);