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 let use_range = use_tree_list.syntax().text_range();
204 text_edit_for_remove_unnecessary_braces_with_self_in_use_statement(&single_use_tree)
206 let to_replace = single_use_tree.syntax().text().to_string();
207 let mut edit_builder = TextEdit::builder();
208 edit_builder.delete(use_range);
209 edit_builder.insert(use_range.start(), to_replace);
210 edit_builder.finish()
214 Diagnostic::hint(use_range, "Unnecessary braces in use statement".to_string())
215 .with_fix(Some(Fix::new(
216 "Remove unnecessary braces",
217 SourceFileEdit { file_id, edit }.into(),
226 fn text_edit_for_remove_unnecessary_braces_with_self_in_use_statement(
227 single_use_tree: &ast::UseTree,
228 ) -> Option<TextEdit> {
229 let use_tree_list_node = single_use_tree.syntax().parent()?;
230 if single_use_tree.path()?.segment()?.syntax().first_child_or_token()?.kind() == T![self] {
231 let start = use_tree_list_node.prev_sibling_or_token()?.text_range().start();
232 let end = use_tree_list_node.text_range().end();
233 return Some(TextEdit::delete(TextRange::new(start, end)));
240 use expect_test::{expect, Expect};
241 use stdx::trim_indent;
242 use test_utils::assert_eq_text;
244 use crate::{fixture, DiagnosticsConfig};
246 /// Takes a multi-file input fixture with annotated cursor positions,
248 /// * a diagnostic is produced
249 /// * this diagnostic fix trigger range touches the input cursor position
250 /// * that the contents of the file containing the cursor match `after` after the diagnostic fix is applied
251 pub(crate) fn check_fix(ra_fixture_before: &str, ra_fixture_after: &str) {
252 let after = trim_indent(ra_fixture_after);
254 let (analysis, file_position) = fixture::position(ra_fixture_before);
255 let diagnostic = analysis
256 .diagnostics(&DiagnosticsConfig::default(), file_position.file_id)
260 let fix = diagnostic.fix.unwrap();
261 let target_file_contents = analysis.file_text(file_position.file_id).unwrap();
263 let mut actual = target_file_contents.to_string();
264 // Go from the last one to the first one, so that ranges won't be affected by previous edits.
265 for edit in fix.source_change.source_file_edits.iter().rev() {
266 edit.edit.apply(&mut actual);
271 assert_eq_text!(&after, &actual);
273 fix.fix_trigger_range.contains_inclusive(file_position.offset),
274 "diagnostic fix range {:?} does not touch cursor position {:?}",
275 fix.fix_trigger_range,
280 /// Checks that a diagnostic applies to the file containing the `<|>` cursor marker
281 /// which has a fix that can apply to other files.
282 fn check_apply_diagnostic_fix_in_other_file(ra_fixture_before: &str, ra_fixture_after: &str) {
283 let ra_fixture_after = &trim_indent(ra_fixture_after);
284 let (analysis, file_pos) = fixture::position(ra_fixture_before);
285 let current_file_id = file_pos.file_id;
286 let diagnostic = analysis
287 .diagnostics(&DiagnosticsConfig::default(), current_file_id)
291 let mut fix = diagnostic.fix.unwrap();
292 let edit = fix.source_change.source_file_edits.pop().unwrap();
293 let changed_file_id = edit.file_id;
294 let before = analysis.file_text(changed_file_id).unwrap();
296 let mut actual = before.to_string();
297 edit.edit.apply(&mut actual);
300 assert_eq_text!(ra_fixture_after, &actual);
303 /// Takes a multi-file input fixture with annotated cursor position and checks that no diagnostics
304 /// apply to the file containing the cursor.
305 pub(crate) fn check_no_diagnostics(ra_fixture: &str) {
306 let (analysis, files) = fixture::files(ra_fixture);
307 let diagnostics = files
309 .flat_map(|file_id| {
310 analysis.diagnostics(&DiagnosticsConfig::default(), file_id).unwrap()
312 .collect::<Vec<_>>();
313 assert_eq!(diagnostics.len(), 0, "unexpected diagnostics:\n{:#?}", diagnostics);
316 fn check_expect(ra_fixture: &str, expect: Expect) {
317 let (analysis, file_id) = fixture::file(ra_fixture);
318 let diagnostics = analysis.diagnostics(&DiagnosticsConfig::default(), file_id).unwrap();
319 expect.assert_debug_eq(&diagnostics)
323 fn test_wrap_return_type() {
326 //- /main.rs crate:main deps:core
327 use core::result::Result::{self, Ok, Err};
329 fn div(x: i32, y: i32) -> Result<i32, ()> {
335 //- /core/lib.rs crate:core
337 pub enum Result<T, E> { Ok(T), Err(E) }
341 use core::result::Result::{self, Ok, Err};
343 fn div(x: i32, y: i32) -> Result<i32, ()> {
354 fn test_wrap_return_type_handles_generic_functions() {
357 //- /main.rs crate:main deps:core
358 use core::result::Result::{self, Ok, Err};
360 fn div<T>(x: T) -> Result<T, i32> {
366 //- /core/lib.rs crate:core
368 pub enum Result<T, E> { Ok(T), Err(E) }
372 use core::result::Result::{self, Ok, Err};
374 fn div<T>(x: T) -> Result<T, i32> {
385 fn test_wrap_return_type_handles_type_aliases() {
388 //- /main.rs crate:main deps:core
389 use core::result::Result::{self, Ok, Err};
391 type MyResult<T> = Result<T, ()>;
393 fn div(x: i32, y: i32) -> MyResult<i32> {
399 //- /core/lib.rs crate:core
401 pub enum Result<T, E> { Ok(T), Err(E) }
405 use core::result::Result::{self, Ok, Err};
407 type MyResult<T> = Result<T, ()>;
409 fn div(x: i32, y: i32) -> MyResult<i32> {
420 fn test_wrap_return_type_not_applicable_when_expr_type_does_not_match_ok_type() {
421 check_no_diagnostics(
423 //- /main.rs crate:main deps:core
424 use core::result::Result::{self, Ok, Err};
426 fn foo() -> Result<(), i32> { 0 }
428 //- /core/lib.rs crate:core
430 pub enum Result<T, E> { Ok(T), Err(E) }
437 fn test_wrap_return_type_not_applicable_when_return_type_is_not_result() {
438 check_no_diagnostics(
440 //- /main.rs crate:main deps:core
441 use core::result::Result::{self, Ok, Err};
443 enum SomeOtherEnum { Ok(i32), Err(String) }
445 fn foo() -> SomeOtherEnum { 0 }
447 //- /core/lib.rs crate:core
449 pub enum Result<T, E> { Ok(T), Err(E) }
456 fn test_fill_struct_fields_empty() {
459 struct TestStruct { one: i32, two: i64 }
462 let s = TestStruct {<|>};
466 struct TestStruct { one: i32, two: i64 }
469 let s = TestStruct { one: (), two: ()};
476 fn test_fill_struct_fields_self() {
479 struct TestStruct { one: i32 }
482 fn test_fn() { let s = Self {<|>}; }
486 struct TestStruct { one: i32 }
489 fn test_fn() { let s = Self { one: ()}; }
496 fn test_fill_struct_fields_enum() {
500 Bin { lhs: Box<Expr>, rhs: Box<Expr> }
504 fn new_bin(lhs: Box<Expr>, rhs: Box<Expr>) -> Expr {
511 Bin { lhs: Box<Expr>, rhs: Box<Expr> }
515 fn new_bin(lhs: Box<Expr>, rhs: Box<Expr>) -> Expr {
516 Expr::Bin { lhs: (), rhs: () }
524 fn test_fill_struct_fields_partial() {
527 struct TestStruct { one: i32, two: i64 }
530 let s = TestStruct{ two: 2<|> };
534 struct TestStruct { one: i32, two: i64 }
537 let s = TestStruct{ two: 2, one: () };
544 fn test_fill_struct_fields_no_diagnostic() {
545 check_no_diagnostics(
547 struct TestStruct { one: i32, two: i64 }
551 let s = TestStruct{ one, two: 2 };
558 fn test_fill_struct_fields_no_diagnostic_on_spread() {
559 check_no_diagnostics(
561 struct TestStruct { one: i32, two: i64 }
565 let s = TestStruct{ ..a };
572 fn test_unresolved_module_diagnostic() {
578 message: "unresolved module",
583 label: "Create module",
584 source_change: SourceChange {
585 source_file_edits: [],
588 dst: AnchoredPathBuf {
594 initial_contents: "",
599 fix_trigger_range: 0..8,
615 fn range_mapping_out_of_macros() {
616 // FIXME: this is very wrong, but somewhat tricky to fix.
623 macro_rules! id { ($($tt:tt)*) => { $($tt)*}; }
626 let _x = id![Foo { a: <|>42 }];
629 pub struct Foo { pub a: i32, pub b: i32 }
636 macro_rules! id { ($($tt:tt)*) => { $($tt)*}; }
639 let _x = id![Foo { a: 42 }];
642 pub struct Foo { pub a: i32, pub b: i32 }
648 fn test_check_unnecessary_braces_in_use_statement() {
649 check_no_diagnostics(
704 mod a { mod c {} mod d { mod e {} } }
705 use a::{c, d::{e<|>}};
708 mod a { mod c {} mod d { mod e {} } }
715 fn test_add_field_from_usage() {
719 Foo { bar: 3, baz<|>: false};
727 Foo { bar: 3, baz: false};
738 fn test_add_field_in_other_file_from_usage() {
739 check_apply_diagnostic_fix_in_other_file(
745 <|>foo::Foo { bar: 3, baz: false};
762 fn test_disabled_diagnostics() {
763 let mut config = DiagnosticsConfig::default();
764 config.disabled.insert("unresolved-module".into());
766 let (analysis, file_id) = fixture::file(r#"mod foo;"#);
768 let diagnostics = analysis.diagnostics(&config, file_id).unwrap();
769 assert!(diagnostics.is_empty());
771 let diagnostics = analysis.diagnostics(&DiagnosticsConfig::default(), file_id).unwrap();
772 assert!(!diagnostics.is_empty());
776 fn test_rename_incorrect_case() {
779 pub struct test_struct<|> { one: i32 }
781 pub fn some_fn(val: test_struct) -> test_struct {
782 test_struct { one: val.one + 1 }
786 pub struct TestStruct { one: i32 }
788 pub fn some_fn(val: TestStruct) -> TestStruct {
789 TestStruct { one: val.one + 1 }
796 pub fn some_fn(NonSnakeCase<|>: u8) -> u8 {
801 pub fn some_fn(non_snake_case: u8) -> u8 {
809 pub fn SomeFn<|>(val: u8) -> u8 {
810 if val != 0 { SomeFn(val - 1) } else { val }
814 pub fn some_fn(val: u8) -> u8 {
815 if val != 0 { some_fn(val - 1) } else { val }
823 let whatAWeird_Formatting<|> = 10;
824 another_func(whatAWeird_Formatting);
829 let what_a_weird_formatting = 10;
830 another_func(what_a_weird_formatting);
837 fn test_uppercase_const_no_diagnostics() {
838 check_no_diagnostics(
841 const ANOTHER_ITEM<|>: &str = "some_item";
848 fn test_rename_incorrect_case_struct_method() {
851 pub struct TestStruct;
854 pub fn SomeFn<|>() -> TestStruct {
860 pub struct TestStruct;
863 pub fn some_fn() -> TestStruct {
872 fn test_single_incorrect_case_diagnostic_in_function_name_issue_6970() {
873 let input = r#"fn FOO<|>() {}"#;
874 let expected = r#"fn foo() {}"#;
876 let (analysis, file_position) = fixture::position(input);
878 analysis.diagnostics(&DiagnosticsConfig::default(), file_position.file_id).unwrap();
879 assert_eq!(diagnostics.len(), 1);
881 check_fix(input, expected);