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 if let Some(m) = sema.to_module_def(file_id) {
201 m.diagnostics(db, &mut sink);
207 fn diagnostic_with_fix<D: DiagnosticWithFix>(d: &D, sema: &Semantics<RootDatabase>) -> Diagnostic {
208 Diagnostic::error(sema.diagnostics_display_range(d.display_source()).range, d.message())
209 .with_fix(d.fix(&sema))
210 .with_code(Some(d.code()))
213 fn warning_with_fix<D: DiagnosticWithFix>(d: &D, sema: &Semantics<RootDatabase>) -> Diagnostic {
214 Diagnostic::hint(sema.diagnostics_display_range(d.display_source()).range, d.message())
215 .with_fix(d.fix(&sema))
216 .with_code(Some(d.code()))
219 fn check_unnecessary_braces_in_use_statement(
220 acc: &mut Vec<Diagnostic>,
224 let use_tree_list = ast::UseTreeList::cast(node.clone())?;
225 if let Some((single_use_tree,)) = use_tree_list.use_trees().collect_tuple() {
226 // If there is a comment inside the bracketed `use`,
227 // assume it is a commented out module path and don't show diagnostic.
228 if use_tree_list.has_inner_comment() {
232 let use_range = use_tree_list.syntax().text_range();
234 text_edit_for_remove_unnecessary_braces_with_self_in_use_statement(&single_use_tree)
236 let to_replace = single_use_tree.syntax().text().to_string();
237 let mut edit_builder = TextEdit::builder();
238 edit_builder.delete(use_range);
239 edit_builder.insert(use_range.start(), to_replace);
240 edit_builder.finish()
244 Diagnostic::hint(use_range, "Unnecessary braces in use statement".to_string())
245 .with_fix(Some(Fix::new(
246 "Remove unnecessary braces",
247 SourceChange::from_text_edit(file_id, edit),
256 fn text_edit_for_remove_unnecessary_braces_with_self_in_use_statement(
257 single_use_tree: &ast::UseTree,
258 ) -> Option<TextEdit> {
259 let use_tree_list_node = single_use_tree.syntax().parent()?;
260 if single_use_tree.path()?.segment()?.self_token().is_some() {
261 let start = use_tree_list_node.prev_sibling_or_token()?.text_range().start();
262 let end = use_tree_list_node.text_range().end();
263 return Some(TextEdit::delete(TextRange::new(start, end)));
270 use expect_test::{expect, Expect};
271 use stdx::trim_indent;
272 use test_utils::assert_eq_text;
274 use crate::{fixture, DiagnosticsConfig};
276 /// Takes a multi-file input fixture with annotated cursor positions,
278 /// * a diagnostic is produced
279 /// * this diagnostic fix trigger range touches the input cursor position
280 /// * that the contents of the file containing the cursor match `after` after the diagnostic fix is applied
281 pub(crate) fn check_fix(ra_fixture_before: &str, ra_fixture_after: &str) {
282 let after = trim_indent(ra_fixture_after);
284 let (analysis, file_position) = fixture::position(ra_fixture_before);
285 let diagnostic = analysis
286 .diagnostics(&DiagnosticsConfig::default(), file_position.file_id)
290 let fix = diagnostic.fix.unwrap();
292 let file_id = *fix.source_change.source_file_edits.keys().next().unwrap();
293 let mut actual = analysis.file_text(file_id).unwrap().to_string();
295 for edit in fix.source_change.source_file_edits.values() {
296 edit.apply(&mut actual);
301 assert_eq_text!(&after, &actual);
303 fix.fix_trigger_range.contains_inclusive(file_position.offset),
304 "diagnostic fix range {:?} does not touch cursor position {:?}",
305 fix.fix_trigger_range,
310 /// Takes a multi-file input fixture with annotated cursor position and checks that no diagnostics
311 /// apply to the file containing the cursor.
312 pub(crate) fn check_no_diagnostics(ra_fixture: &str) {
313 let (analysis, files) = fixture::files(ra_fixture);
314 let diagnostics = files
316 .flat_map(|file_id| {
317 analysis.diagnostics(&DiagnosticsConfig::default(), file_id).unwrap()
319 .collect::<Vec<_>>();
320 assert_eq!(diagnostics.len(), 0, "unexpected diagnostics:\n{:#?}", diagnostics);
323 fn check_expect(ra_fixture: &str, expect: Expect) {
324 let (analysis, file_id) = fixture::file(ra_fixture);
325 let diagnostics = analysis.diagnostics(&DiagnosticsConfig::default(), file_id).unwrap();
326 expect.assert_debug_eq(&diagnostics)
330 fn test_wrap_return_type_option() {
333 //- /main.rs crate:main deps:core
334 use core::option::Option::{self, Some, None};
336 fn div(x: i32, y: i32) -> Option<i32> {
342 //- /core/lib.rs crate:core
344 pub enum Result<T, E> { Ok(T), Err(E) }
347 pub enum Option<T> { Some(T), None }
351 use core::option::Option::{self, Some, None};
353 fn div(x: i32, y: i32) -> Option<i32> {
364 fn test_wrap_return_type() {
367 //- /main.rs crate:main deps:core
368 use core::result::Result::{self, Ok, Err};
370 fn div(x: i32, y: i32) -> Result<i32, ()> {
376 //- /core/lib.rs crate:core
378 pub enum Result<T, E> { Ok(T), Err(E) }
381 pub enum Option<T> { Some(T), None }
385 use core::result::Result::{self, Ok, Err};
387 fn div(x: i32, y: i32) -> Result<i32, ()> {
398 fn test_wrap_return_type_handles_generic_functions() {
401 //- /main.rs crate:main deps:core
402 use core::result::Result::{self, Ok, Err};
404 fn div<T>(x: T) -> Result<T, i32> {
410 //- /core/lib.rs crate:core
412 pub enum Result<T, E> { Ok(T), Err(E) }
415 pub enum Option<T> { Some(T), None }
419 use core::result::Result::{self, Ok, Err};
421 fn div<T>(x: T) -> Result<T, i32> {
432 fn test_wrap_return_type_handles_type_aliases() {
435 //- /main.rs crate:main deps:core
436 use core::result::Result::{self, Ok, Err};
438 type MyResult<T> = Result<T, ()>;
440 fn div(x: i32, y: i32) -> MyResult<i32> {
446 //- /core/lib.rs crate:core
448 pub enum Result<T, E> { Ok(T), Err(E) }
451 pub enum Option<T> { Some(T), None }
455 use core::result::Result::{self, Ok, Err};
457 type MyResult<T> = Result<T, ()>;
459 fn div(x: i32, y: i32) -> MyResult<i32> {
470 fn test_wrap_return_type_not_applicable_when_expr_type_does_not_match_ok_type() {
471 check_no_diagnostics(
473 //- /main.rs crate:main deps:core
474 use core::result::Result::{self, Ok, Err};
476 fn foo() -> Result<(), i32> { 0 }
478 //- /core/lib.rs crate:core
480 pub enum Result<T, E> { Ok(T), Err(E) }
483 pub enum Option<T> { Some(T), None }
490 fn test_wrap_return_type_not_applicable_when_return_type_is_not_result_or_option() {
491 check_no_diagnostics(
493 //- /main.rs crate:main deps:core
494 use core::result::Result::{self, Ok, Err};
496 enum SomeOtherEnum { Ok(i32), Err(String) }
498 fn foo() -> SomeOtherEnum { 0 }
500 //- /core/lib.rs crate:core
502 pub enum Result<T, E> { Ok(T), Err(E) }
505 pub enum Option<T> { Some(T), None }
512 fn test_fill_struct_fields_empty() {
515 struct TestStruct { one: i32, two: i64 }
518 let s = TestStruct {$0};
522 struct TestStruct { one: i32, two: i64 }
525 let s = TestStruct { one: (), two: ()};
532 fn test_fill_struct_fields_self() {
535 struct TestStruct { one: i32 }
538 fn test_fn() { let s = Self {$0}; }
542 struct TestStruct { one: i32 }
545 fn test_fn() { let s = Self { one: ()}; }
552 fn test_fill_struct_fields_enum() {
556 Bin { lhs: Box<Expr>, rhs: Box<Expr> }
560 fn new_bin(lhs: Box<Expr>, rhs: Box<Expr>) -> Expr {
567 Bin { lhs: Box<Expr>, rhs: Box<Expr> }
571 fn new_bin(lhs: Box<Expr>, rhs: Box<Expr>) -> Expr {
572 Expr::Bin { lhs: (), rhs: () }
580 fn test_fill_struct_fields_partial() {
583 struct TestStruct { one: i32, two: i64 }
586 let s = TestStruct{ two: 2$0 };
590 struct TestStruct { one: i32, two: i64 }
593 let s = TestStruct{ two: 2, one: () };
600 fn test_fill_struct_fields_no_diagnostic() {
601 check_no_diagnostics(
603 struct TestStruct { one: i32, two: i64 }
607 let s = TestStruct{ one, two: 2 };
614 fn test_fill_struct_fields_no_diagnostic_on_spread() {
615 check_no_diagnostics(
617 struct TestStruct { one: i32, two: i64 }
621 let s = TestStruct{ ..a };
628 fn test_unresolved_module_diagnostic() {
634 message: "unresolved module",
639 label: "Create module",
640 source_change: SourceChange {
641 source_file_edits: {},
644 dst: AnchoredPathBuf {
650 initial_contents: "",
655 fix_trigger_range: 0..8,
671 fn test_unresolved_macro_range() {
677 message: "unresolved macro call",
684 "unresolved-macro-call",
694 fn range_mapping_out_of_macros() {
695 // FIXME: this is very wrong, but somewhat tricky to fix.
702 macro_rules! id { ($($tt:tt)*) => { $($tt)*}; }
705 let _x = id![Foo { a: $042 }];
708 pub struct Foo { pub a: i32, pub b: i32 }
715 macro_rules! id { ($($tt:tt)*) => { $($tt)*}; }
718 let _x = id![Foo { a: 42 }];
721 pub struct Foo { pub a: i32, pub b: i32 }
727 fn test_check_unnecessary_braces_in_use_statement() {
728 check_no_diagnostics(
741 check_no_diagnostics(
799 mod a { mod c {} mod d { mod e {} } }
800 use a::{c, d::{e$0}};
803 mod a { mod c {} mod d { mod e {} } }
810 fn test_add_field_from_usage() {
814 Foo { bar: 3, baz$0: false};
822 Foo { bar: 3, baz: false};
833 fn test_add_field_in_other_file_from_usage() {
840 foo::Foo { bar: 3, $0baz: false};
857 fn test_disabled_diagnostics() {
858 let mut config = DiagnosticsConfig::default();
859 config.disabled.insert("unresolved-module".into());
861 let (analysis, file_id) = fixture::file(r#"mod foo;"#);
863 let diagnostics = analysis.diagnostics(&config, file_id).unwrap();
864 assert!(diagnostics.is_empty());
866 let diagnostics = analysis.diagnostics(&DiagnosticsConfig::default(), file_id).unwrap();
867 assert!(!diagnostics.is_empty());
871 fn test_rename_incorrect_case() {
874 pub struct test_struct$0 { one: i32 }
876 pub fn some_fn(val: test_struct) -> test_struct {
877 test_struct { one: val.one + 1 }
881 pub struct TestStruct { one: i32 }
883 pub fn some_fn(val: TestStruct) -> TestStruct {
884 TestStruct { one: val.one + 1 }
891 pub fn some_fn(NonSnakeCase$0: u8) -> u8 {
896 pub fn some_fn(non_snake_case: u8) -> u8 {
904 pub fn SomeFn$0(val: u8) -> u8 {
905 if val != 0 { SomeFn(val - 1) } else { val }
909 pub fn some_fn(val: u8) -> u8 {
910 if val != 0 { some_fn(val - 1) } else { val }
918 let whatAWeird_Formatting$0 = 10;
919 another_func(whatAWeird_Formatting);
924 let what_a_weird_formatting = 10;
925 another_func(what_a_weird_formatting);
932 fn test_uppercase_const_no_diagnostics() {
933 check_no_diagnostics(
936 const ANOTHER_ITEM$0: &str = "some_item";
943 fn test_rename_incorrect_case_struct_method() {
946 pub struct TestStruct;
949 pub fn SomeFn$0() -> TestStruct {
955 pub struct TestStruct;
958 pub fn some_fn() -> TestStruct {
967 fn test_single_incorrect_case_diagnostic_in_function_name_issue_6970() {
968 let input = r#"fn FOO$0() {}"#;
969 let expected = r#"fn foo() {}"#;
971 let (analysis, file_position) = fixture::position(input);
973 analysis.diagnostics(&DiagnosticsConfig::default(), file_position.file_id).unwrap();
974 assert_eq!(diagnostics.len(), 1);
976 check_fix(input, expected);