rust/crates/ra_ide_api/src/diagnostics.rs

438 lines
12 KiB
Rust
Raw Normal View History

2019-03-24 02:21:36 -05:00
use std::cell::RefCell;
2019-03-21 11:05:15 -05:00
use itertools::Itertools;
2019-03-23 13:20:49 -05:00
use hir::{source_binder, diagnostics::{Diagnostic as _, DiagnosticSink}};
2019-02-08 02:52:18 -06:00
use ra_db::SourceDatabase;
2019-03-21 11:05:15 -05:00
use ra_syntax::{
Location, SourceFile, SyntaxKind, TextRange, SyntaxNode,
2019-04-10 16:00:56 -05:00
ast::{self, AstNode, NamedFieldList, NamedField},
2019-03-21 11:05:15 -05:00
};
2019-04-10 16:00:56 -05:00
use ra_assists::ast_editor::{AstEditor, AstBuilder};
2019-03-21 11:05:15 -05:00
use ra_text_edit::{TextEdit, TextEditBuilder};
2019-05-05 09:32:53 -05:00
use ra_prof::profile;
2019-03-21 11:05:15 -05:00
use crate::{Diagnostic, FileId, FileSystemEdit, SourceChange, SourceFileEdit, db::RootDatabase};
2019-01-08 13:33:36 -06:00
2019-03-23 11:34:49 -05:00
#[derive(Debug, Copy, Clone)]
pub enum Severity {
Error,
WeakWarning,
}
2019-02-08 05:30:21 -06:00
pub(crate) fn diagnostics(db: &RootDatabase, file_id: FileId) -> Vec<Diagnostic> {
2019-05-05 09:32:53 -05:00
let _p = profile("diagnostics");
2019-03-21 11:21:00 -05:00
let source_file = db.parse(file_id);
let mut res = Vec::new();
syntax_errors(&mut res, &source_file);
for node in source_file.syntax().descendants() {
check_unnecessary_braces_in_use_statement(&mut res, file_id, node);
check_struct_shorthand_initialization(&mut res, file_id, node);
}
2019-03-24 02:21:36 -05:00
let res = RefCell::new(res);
let mut sink = DiagnosticSink::new(|d| {
res.borrow_mut().push(Diagnostic {
message: d.message(),
2019-03-25 01:40:49 -05:00
range: d.highlight_range(),
2019-03-24 02:21:36 -05:00
severity: Severity::Error,
fix: None,
})
})
.on::<hir::diagnostics::UnresolvedModule, _>(|d| {
let source_root = db.file_source_root(d.file().original_file(db));
let create_file = FileSystemEdit::CreateFile { source_root, path: d.candidate.clone() };
2019-03-25 02:56:55 -05:00
let fix = SourceChange::file_system_edit("create module", create_file);
2019-03-24 02:21:36 -05:00
res.borrow_mut().push(Diagnostic {
2019-03-25 01:40:49 -05:00
range: d.highlight_range(),
2019-03-24 02:21:36 -05:00
message: d.message(),
severity: Severity::Error,
fix: Some(fix),
})
2019-04-10 16:00:56 -05:00
})
.on::<hir::diagnostics::MissingFields, _>(|d| {
let file_id = d.file().original_file(db);
let source_file = db.parse(file_id);
let syntax_node = d.syntax_node_ptr();
let node = NamedFieldList::cast(syntax_node.to_node(&source_file)).unwrap();
let mut ast_editor = AstEditor::new(node);
for f in d.missed_fields.iter() {
ast_editor.append_field(&AstBuilder::<NamedField>::from_name(f));
}
let mut builder = TextEditBuilder::default();
ast_editor.into_text_edit(&mut builder);
let fix =
SourceChange::source_file_edit_from("fill struct fields", file_id, builder.finish());
res.borrow_mut().push(Diagnostic {
range: d.highlight_range(),
message: d.message(),
severity: Severity::Error,
fix: Some(fix),
})
2019-03-24 02:21:36 -05:00
});
2019-02-08 05:30:21 -06:00
if let Some(m) = source_binder::module_from_file_id(db, file_id) {
2019-03-24 02:21:36 -05:00
m.diagnostics(db, &mut sink);
2019-02-08 05:30:21 -06:00
};
2019-03-24 02:21:36 -05:00
drop(sink);
res.into_inner()
2019-01-08 13:33:36 -06:00
}
2019-03-21 11:05:15 -05:00
2019-03-21 11:21:00 -05:00
fn syntax_errors(acc: &mut Vec<Diagnostic>, source_file: &SourceFile) {
2019-03-21 11:05:15 -05:00
fn location_to_range(location: Location) -> TextRange {
match location {
Location::Offset(offset) => TextRange::offset_len(offset, 1.into()),
Location::Range(range) => range,
}
}
2019-03-21 11:21:00 -05:00
acc.extend(source_file.errors().into_iter().map(|err| Diagnostic {
range: location_to_range(err.location()),
message: format!("Syntax Error: {}", err),
severity: Severity::Error,
fix: None,
}));
2019-03-21 11:05:15 -05:00
}
fn check_unnecessary_braces_in_use_statement(
acc: &mut Vec<Diagnostic>,
2019-03-21 11:21:00 -05:00
file_id: FileId,
2019-03-21 11:05:15 -05:00
node: &SyntaxNode,
) -> Option<()> {
let use_tree_list = ast::UseTreeList::cast(node)?;
if let Some((single_use_tree,)) = use_tree_list.use_trees().collect_tuple() {
let range = use_tree_list.syntax().range();
let edit =
text_edit_for_remove_unnecessary_braces_with_self_in_use_statement(single_use_tree)
.unwrap_or_else(|| {
let to_replace = single_use_tree.syntax().text().to_string();
let mut edit_builder = TextEditBuilder::default();
edit_builder.delete(range);
edit_builder.insert(range.start(), to_replace);
edit_builder.finish()
});
acc.push(Diagnostic {
range,
message: format!("Unnecessary braces in use statement"),
severity: Severity::WeakWarning,
fix: Some(SourceChange::source_file_edit(
"Remove unnecessary braces",
SourceFileEdit { file_id, edit },
)),
2019-03-21 11:05:15 -05:00
});
}
Some(())
}
fn text_edit_for_remove_unnecessary_braces_with_self_in_use_statement(
single_use_tree: &ast::UseTree,
) -> Option<TextEdit> {
let use_tree_list_node = single_use_tree.syntax().parent()?;
2019-03-30 05:25:53 -05:00
if single_use_tree.path()?.segment()?.syntax().first_child_or_token()?.kind()
== SyntaxKind::SELF_KW
{
let start = use_tree_list_node.prev_sibling_or_token()?.range().start();
2019-03-21 11:05:15 -05:00
let end = use_tree_list_node.range().end();
let range = TextRange::from_to(start, end);
let mut edit_builder = TextEditBuilder::default();
edit_builder.delete(range);
return Some(edit_builder.finish());
}
None
}
fn check_struct_shorthand_initialization(
acc: &mut Vec<Diagnostic>,
2019-03-21 11:21:00 -05:00
file_id: FileId,
2019-03-21 11:05:15 -05:00
node: &SyntaxNode,
) -> Option<()> {
let struct_lit = ast::StructLit::cast(node)?;
let named_field_list = struct_lit.named_field_list()?;
for named_field in named_field_list.fields() {
if let (Some(name_ref), Some(expr)) = (named_field.name_ref(), named_field.expr()) {
let field_name = name_ref.syntax().text().to_string();
let field_expr = expr.syntax().text().to_string();
if field_name == field_expr {
let mut edit_builder = TextEditBuilder::default();
edit_builder.delete(named_field.syntax().range());
edit_builder.insert(named_field.syntax().range().start(), field_name);
let edit = edit_builder.finish();
acc.push(Diagnostic {
range: named_field.syntax().range(),
message: format!("Shorthand struct initialization"),
severity: Severity::WeakWarning,
fix: Some(SourceChange::source_file_edit(
"use struct shorthand initialization",
SourceFileEdit { file_id, edit },
)),
2019-03-21 11:05:15 -05:00
});
}
}
}
Some(())
}
#[cfg(test)]
mod tests {
use test_utils::assert_eq_text;
2019-03-25 06:28:04 -05:00
use insta::assert_debug_snapshot_matches;
use crate::mock_analysis::single_file;
2019-03-21 11:05:15 -05:00
use super::*;
2019-03-21 11:21:00 -05:00
type DiagnosticChecker = fn(&mut Vec<Diagnostic>, FileId, &SyntaxNode) -> Option<()>;
2019-03-21 11:05:15 -05:00
fn check_not_applicable(code: &str, func: DiagnosticChecker) {
let file = SourceFile::parse(code);
let mut diagnostics = Vec::new();
for node in file.syntax().descendants() {
2019-03-21 11:21:00 -05:00
func(&mut diagnostics, FileId(0), node);
2019-03-21 11:05:15 -05:00
}
assert!(diagnostics.is_empty());
}
fn check_apply(before: &str, after: &str, func: DiagnosticChecker) {
let file = SourceFile::parse(before);
let mut diagnostics = Vec::new();
for node in file.syntax().descendants() {
2019-03-21 11:21:00 -05:00
func(&mut diagnostics, FileId(0), node);
2019-03-21 11:05:15 -05:00
}
let diagnostic =
diagnostics.pop().unwrap_or_else(|| panic!("no diagnostics for:\n{}\n", before));
let mut fix = diagnostic.fix.unwrap();
let edit = fix.source_file_edits.pop().unwrap().edit;
let actual = edit.apply(&before);
assert_eq_text!(after, &actual);
}
2019-04-10 16:00:56 -05:00
fn check_apply_diagnostic_fix(before: &str, after: &str) {
let (analysis, file_id) = single_file(before);
let diagnostic = analysis.diagnostics(file_id).unwrap().pop().unwrap();
let mut fix = diagnostic.fix.unwrap();
let edit = fix.source_file_edits.pop().unwrap().edit;
let actual = edit.apply(&before);
assert_eq_text!(after, &actual);
}
fn check_no_diagnostic(content: &str) {
let (analysis, file_id) = single_file(content);
let diagnostics = analysis.diagnostics(file_id).unwrap();
assert_eq!(diagnostics.len(), 0);
}
#[test]
fn test_fill_struct_fields_empty() {
let before = r"
struct TestStruct {
one: i32,
two: i64,
}
fn test_fn() {
let s = TestStruct{};
}
";
let after = r"
struct TestStruct {
one: i32,
two: i64,
}
fn test_fn() {
let s = TestStruct{ one: (), two: ()};
}
";
check_apply_diagnostic_fix(before, after);
}
#[test]
fn test_fill_struct_fields_partial() {
let before = r"
struct TestStruct {
one: i32,
two: i64,
}
fn test_fn() {
let s = TestStruct{ two: 2 };
}
";
let after = r"
struct TestStruct {
one: i32,
two: i64,
}
fn test_fn() {
let s = TestStruct{ two: 2, one: () };
}
";
check_apply_diagnostic_fix(before, after);
}
#[test]
fn test_fill_struct_fields_no_diagnostic() {
let content = r"
struct TestStruct {
one: i32,
two: i64,
}
fn test_fn() {
let one = 1;
let s = TestStruct{ one, two: 2 };
}
";
check_no_diagnostic(content);
}
#[test]
fn test_fill_struct_fields_no_diagnostic_on_spread() {
let content = r"
struct TestStruct {
one: i32,
two: i64,
}
fn test_fn() {
let one = 1;
let s = TestStruct{ ..a };
}
";
check_no_diagnostic(content);
}
2019-03-25 06:28:04 -05:00
#[test]
fn test_unresolved_module_diagnostic() {
let (analysis, file_id) = single_file("mod foo;");
let diagnostics = analysis.diagnostics(file_id).unwrap();
assert_debug_snapshot_matches!(diagnostics, @r####"[
Diagnostic {
message: "unresolved module",
range: [0; 8),
fix: Some(
SourceChange {
label: "create module",
source_file_edits: [],
file_system_edits: [
CreateFile {
source_root: SourceRootId(
0
),
path: "foo.rs"
}
],
cursor_position: None
}
),
severity: Error
}
]"####);
}
2019-03-21 11:05:15 -05:00
#[test]
fn test_check_unnecessary_braces_in_use_statement() {
check_not_applicable(
"
use a;
use a::{c, d::e};
",
check_unnecessary_braces_in_use_statement,
);
check_apply("use {b};", "use b;", check_unnecessary_braces_in_use_statement);
check_apply("use a::{c};", "use a::c;", check_unnecessary_braces_in_use_statement);
check_apply("use a::{self};", "use a;", check_unnecessary_braces_in_use_statement);
check_apply(
"use a::{c, d::{e}};",
"use a::{c, d::e};",
check_unnecessary_braces_in_use_statement,
);
}
#[test]
fn test_check_struct_shorthand_initialization() {
check_not_applicable(
r#"
struct A {
a: &'static str
}
fn main() {
A {
a: "hello"
}
}
"#,
check_struct_shorthand_initialization,
);
check_apply(
r#"
struct A {
a: &'static str
}
fn main() {
let a = "haha";
A {
a: a
}
}
"#,
r#"
struct A {
a: &'static str
}
fn main() {
let a = "haha";
A {
a
}
}
"#,
check_struct_shorthand_initialization,
);
check_apply(
r#"
struct A {
a: &'static str,
b: &'static str
}
fn main() {
let a = "haha";
let b = "bb";
A {
a: a,
b
}
}
"#,
r#"
struct A {
a: &'static str,
b: &'static str
}
fn main() {
let a = "haha";
let b = "bb";
A {
a,
b
}
}
"#,
check_struct_shorthand_initialization,
);
}
}