language-servers/rust-analyzer
1
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer.git synced 2025-10-01 14:21:44 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Improve rustc diagnostic mapping

Browse source
This commit is contained in:
Jonas Schievink 2021-03-30 19:29:26 +02:00
parent fd7c454d51
commit 9b41effd07
3 changed files with 300 additions and 77 deletions
Download patch file Download diff file Expand all files Collapse all files

118
crates/rust-analyzer/src/diagnostics/test_data/handles_macro_location.txt
View file

@ -21,6 +21,94 @@
character: 26, character: 26,
}, },
}, },
severity: Some(
Hint,
),
code: Some(
String(
"E0277",
),
),
code_description: Some(
CodeDescription {
href: Url {
scheme: "https",
username: "",
password: None,
host: Some(
Domain(
"doc.rust-lang.org",
),
),
port: None,
path: "/error-index.html",
query: None,
fragment: Some(
"E0277",
),
},
},
),
source: Some(
"rustc",
),
message: "can\'t compare `{integer}` with `&str`\nthe trait `std::cmp::PartialEq<&str>` is not implemented for `{integer}`",
related_information: Some(
[
DiagnosticRelatedInformation {
location: Location {
uri: Url {
scheme: "file",
username: "",
password: None,
host: None,
port: None,
path: "/test/%3C::core::macros::assert_eq%20macros%3E",
query: None,
fragment: None,
},
range: Range {
start: Position {
line: 6,
character: 30,
},
end: Position {
line: 6,
character: 32,
},
},
},
message: "Exact error occurred here",
},
],
),
tags: None,
data: None,
},
fixes: [],
},
MappedRustDiagnostic {
url: Url {
scheme: "file",
username: "",
password: None,
host: None,
port: None,
path: "/test/%3C::core::macros::assert_eq%20macros%3E",
query: None,
fragment: None,
},
diagnostic: Diagnostic {
range: Range {
start: Position {
line: 6,
character: 30,
},
end: Position {
line: 6,
character: 32,
},
},
severity: Some( severity: Some(
Error, Error,
), ),
@ -53,7 +141,35 @@
"rustc", "rustc",
), ),
message: "can\'t compare `{integer}` with `&str`\nthe trait `std::cmp::PartialEq<&str>` is not implemented for `{integer}`", message: "can\'t compare `{integer}` with `&str`\nthe trait `std::cmp::PartialEq<&str>` is not implemented for `{integer}`",
related_information: None, related_information: Some(
[
DiagnosticRelatedInformation {
location: Location {
uri: Url {
scheme: "file",
username: "",
password: None,
host: None,
port: None,
path: "/test/src/main.rs",
query: None,
fragment: None,
},
range: Range {
start: Position {
line: 1,
character: 4,
},
end: Position {
line: 1,
character: 26,
},
},
},
message: "Error originated from macro call here",
},
],
),
tags: None, tags: None,
data: None, data: None,
}, },

194
crates/rust-analyzer/src/diagnostics/test_data/macro_compiler_error.txt
View file

@ -1,4 +1,134 @@
[ [
MappedRustDiagnostic {
url: Url {
scheme: "file",
username: "",
password: None,
host: None,
port: None,
path: "/test/crates/hir_def/src/path.rs",
query: None,
fragment: None,
},
diagnostic: Diagnostic {
range: Range {
start: Position {
line: 271,
character: 8,
},
end: Position {
line: 271,
character: 50,
},
},
severity: Some(
Hint,
),
code: None,
code_description: None,
source: Some(
"rustc",
),
message: "Please register your known path in the path module",
related_information: Some(
[
DiagnosticRelatedInformation {
location: Location {
uri: Url {
scheme: "file",
username: "",
password: None,
host: None,
port: None,
path: "/test/crates/hir_def/src/path.rs",
query: None,
fragment: None,
},
range: Range {
start: Position {
line: 264,
character: 8,
},
end: Position {
line: 264,
character: 76,
},
},
},
message: "Exact error occurred here",
},
],
),
tags: None,
data: None,
},
fixes: [],
},
MappedRustDiagnostic {
url: Url {
scheme: "file",
username: "",
password: None,
host: None,
port: None,
path: "/test/crates/hir_def/src/data.rs",
query: None,
fragment: None,
},
diagnostic: Diagnostic {
range: Range {
start: Position {
line: 79,
character: 15,
},
end: Position {
line: 79,
character: 41,
},
},
severity: Some(
Hint,
),
code: None,
code_description: None,
source: Some(
"rustc",
),
message: "Please register your known path in the path module",
related_information: Some(
[
DiagnosticRelatedInformation {
location: Location {
uri: Url {
scheme: "file",
username: "",
password: None,
host: None,
port: None,
path: "/test/crates/hir_def/src/path.rs",
query: None,
fragment: None,
},
range: Range {
start: Position {
line: 264,
character: 8,
},
end: Position {
line: 264,
character: 76,
},
},
},
message: "Exact error occurred here",
},
],
),
tags: None,
data: None,
},
fixes: [],
},
MappedRustDiagnostic { MappedRustDiagnostic {
url: Url { url: Url {
scheme: "file", scheme: "file",
@ -32,6 +162,31 @@
message: "Please register your known path in the path module", message: "Please register your known path in the path module",
related_information: Some( related_information: Some(
[ [
DiagnosticRelatedInformation {
location: Location {
uri: Url {
scheme: "file",
username: "",
password: None,
host: None,
port: None,
path: "/test/crates/hir_def/src/path.rs",
query: None,
fragment: None,
},
range: Range {
start: Position {
line: 271,
character: 8,
},
end: Position {
line: 271,
character: 50,
},
},
},
message: "Error originated from macro call here",
},
DiagnosticRelatedInformation { DiagnosticRelatedInformation {
location: Location { location: Location {
uri: Url { uri: Url {
@ -55,7 +210,7 @@
}, },
}, },
}, },
message: "Exact error occurred here", message: "Error originated from macro call here",
}, },
], ],
), ),
@ -64,41 +219,4 @@
}, },
fixes: [], fixes: [],
}, },
MappedRustDiagnostic {
url: Url {
scheme: "file",
username: "",
password: None,
host: None,
port: None,
path: "/test/crates/hir_def/src/data.rs",
query: None,
fragment: None,
},
diagnostic: Diagnostic {
range: Range {
start: Position {
line: 79,
character: 15,
},
end: Position {
line: 79,
character: 41,
},
},
severity: Some(
Error,
),
code: None,
code_description: None,
source: Some(
"rustc",
),
message: "Please register your known path in the path module",
related_information: None,
tags: None,
data: None,
},
fixes: [],
},
] ]

65
crates/rust-analyzer/src/diagnostics/to_proto.rs
View file

@ -34,22 +34,8 @@ fn diagnostic_severity(
Some(res) Some(res)
} }
/// Check whether a file name is from macro invocation
fn is_from_macro(file_name: &str) -> bool {
file_name.starts_with('<') && file_name.ends_with('>')
}
/// Converts a Rust span to a LSP location, resolving macro expansion site if neccesary
fn location(workspace_root: &Path, span: &DiagnosticSpan) -> lsp_types::Location {
let mut span = span.clone();
while let Some(expansion) = span.expansion {
span = expansion.span;
}
return location_naive(workspace_root, &span);
}
/// Converts a Rust span to a LSP location /// Converts a Rust span to a LSP location
fn location_naive(workspace_root: &Path, span: &DiagnosticSpan) -> lsp_types::Location { fn convert_location(workspace_root: &Path, span: &DiagnosticSpan) -> lsp_types::Location {
let file_name = workspace_root.join(&span.file_name); let file_name = workspace_root.join(&span.file_name);
let uri = url_from_abs_path(&file_name); let uri = url_from_abs_path(&file_name);
@ -62,7 +48,7 @@ fn location_naive(workspace_root: &Path, span: &DiagnosticSpan) -> lsp_types::Lo
lsp_types::Location { uri, range } lsp_types::Location { uri, range }
} }
/// Converts a secondary Rust span to a LSP related inflocation(ormation /// Converts a secondary Rust span to a LSP related information
/// ///
/// If the span is unlabelled this will return `None`. /// If the span is unlabelled this will return `None`.
fn diagnostic_related_information( fn diagnostic_related_information(
@ -70,7 +56,7 @@ fn diagnostic_related_information(
span: &DiagnosticSpan, span: &DiagnosticSpan,
) -> Option<lsp_types::DiagnosticRelatedInformation> { ) -> Option<lsp_types::DiagnosticRelatedInformation> {
let message = span.label.clone()?; let message = span.label.clone()?;
let location = location(workspace_root, span); let location = convert_location(workspace_root, span);
Some(lsp_types::DiagnosticRelatedInformation { location, message }) Some(lsp_types::DiagnosticRelatedInformation { location, message })
} }
@ -98,7 +84,7 @@ fn map_rust_child_diagnostic(
let mut edit_map: HashMap<lsp_types::Url, Vec<lsp_types::TextEdit>> = HashMap::new(); let mut edit_map: HashMap<lsp_types::Url, Vec<lsp_types::TextEdit>> = HashMap::new();
for &span in &spans { for &span in &spans {
if let Some(suggested_replacement) = &span.suggested_replacement { if let Some(suggested_replacement) = &span.suggested_replacement {
let location = location(workspace_root, span); let location = convert_location(workspace_root, span);
let edit = lsp_types::TextEdit::new(location.range, suggested_replacement.clone()); let edit = lsp_types::TextEdit::new(location.range, suggested_replacement.clone());
edit_map.entry(location.uri).or_default().push(edit); edit_map.entry(location.uri).or_default().push(edit);
} }
@ -107,7 +93,7 @@ fn map_rust_child_diagnostic(
if edit_map.is_empty() { if edit_map.is_empty() {
MappedRustChildDiagnostic::SubDiagnostic(SubDiagnostic { MappedRustChildDiagnostic::SubDiagnostic(SubDiagnostic {
related: lsp_types::DiagnosticRelatedInformation { related: lsp_types::DiagnosticRelatedInformation {
location: location(workspace_root, spans[0]), location: convert_location(workspace_root, spans[0]),
message: rd.message.clone(), message: rd.message.clone(),
}, },
suggested_fix: None, suggested_fix: None,
@ -115,7 +101,7 @@ fn map_rust_child_diagnostic(
} else { } else {
MappedRustChildDiagnostic::SubDiagnostic(SubDiagnostic { MappedRustChildDiagnostic::SubDiagnostic(SubDiagnostic {
related: lsp_types::DiagnosticRelatedInformation { related: lsp_types::DiagnosticRelatedInformation {
location: location(workspace_root, spans[0]), location: convert_location(workspace_root, spans[0]),
message: rd.message.clone(), message: rd.message.clone(),
}, },
suggested_fix: Some(lsp_ext::CodeAction { suggested_fix: Some(lsp_ext::CodeAction {
@ -231,7 +217,7 @@ pub(crate) fn map_rust_diagnostic_to_lsp(
primary_spans primary_spans
.iter() .iter()
.flat_map(|primary_span| { .flat_map(|primary_span| {
let location = location(workspace_root, &primary_span); let location = convert_location(workspace_root, &primary_span);
let mut message = message.clone(); let mut message = message.clone();
if needs_primary_span_label { if needs_primary_span_label {
@ -243,21 +229,22 @@ pub(crate) fn map_rust_diagnostic_to_lsp(
// Each primary diagnostic span may result in multiple LSP diagnostics. // Each primary diagnostic span may result in multiple LSP diagnostics.
let mut diagnostics = Vec::new(); let mut diagnostics = Vec::new();
let mut related_macro_info = None; let mut related_info_macro_calls = vec![];
// If error occurs from macro expansion, add related info pointing to // If error occurs from macro expansion, add related info pointing to
// where the error originated // where the error originated
// Also, we would generate an additional diagnostic, so that exact place of macro // Also, we would generate an additional diagnostic, so that exact place of macro
// will be highlighted in the error origin place. // will be highlighted in the error origin place.
if !is_from_macro(&primary_span.file_name) && primary_span.expansion.is_some() { let macro_calls = std::iter::successors(Some(*primary_span), |span| {
let in_macro_location = location_naive(workspace_root, &primary_span); Some(&span.expansion.as_ref()?.span)
})
// Add related information for the main disagnostic. .skip(1);
related_macro_info = Some(lsp_types::DiagnosticRelatedInformation { for macro_span in macro_calls {
let in_macro_location = convert_location(workspace_root, &macro_span);
related_info_macro_calls.push(lsp_types::DiagnosticRelatedInformation {
location: in_macro_location.clone(), location: in_macro_location.clone(),
message: "Error originated from macro here".to_string(), message: "Error originated from macro call here".to_string(),
}); });
// For the additional in-macro diagnostic we add the inverse message pointing to the error location in code. // For the additional in-macro diagnostic we add the inverse message pointing to the error location in code.
let information_for_additional_diagnostic = let information_for_additional_diagnostic =
vec![lsp_types::DiagnosticRelatedInformation { vec![lsp_types::DiagnosticRelatedInformation {
@ -267,7 +254,8 @@ pub(crate) fn map_rust_diagnostic_to_lsp(
let diagnostic = lsp_types::Diagnostic { let diagnostic = lsp_types::Diagnostic {
range: in_macro_location.range, range: in_macro_location.range,
severity, // downgrade to hint if we're pointing at the macro
severity: Some(lsp_types::DiagnosticSeverity::Hint),
code: code.clone().map(lsp_types::NumberOrString::String), code: code.clone().map(lsp_types::NumberOrString::String),
code_description: code_description.clone(), code_description: code_description.clone(),
source: Some(source.clone()), source: Some(source.clone()),
@ -276,7 +264,6 @@ pub(crate) fn map_rust_diagnostic_to_lsp(
tags: if tags.is_empty() { None } else { Some(tags.clone()) }, tags: if tags.is_empty() { None } else { Some(tags.clone()) },
data: None, data: None,
}; };
diagnostics.push(MappedRustDiagnostic { diagnostics.push(MappedRustDiagnostic {
url: in_macro_location.uri, url: in_macro_location.uri,
diagnostic, diagnostic,
@ -294,15 +281,17 @@ pub(crate) fn map_rust_diagnostic_to_lsp(
code_description: code_description.clone(), code_description: code_description.clone(),
source: Some(source.clone()), source: Some(source.clone()),
message, message,
related_information: if subdiagnostics.is_empty() { related_information: {
None let info = related_info_macro_calls
} else {
let mut related = subdiagnostics
.iter() .iter()
.map(|sub| sub.related.clone()) .cloned()
.chain(subdiagnostics.iter().map(|sub| sub.related.clone()))
.collect::<Vec<_>>(); .collect::<Vec<_>>();
related.extend(related_macro_info); if info.is_empty() {
Some(related) None
} else {
Some(info)
}
}, },
tags: if tags.is_empty() { None } else { Some(tags.clone()) }, tags: if tags.is_empty() { None } else { Some(tags.clone()) },
data: None, data: None,