Skip to content

Commit

Permalink
[clangd] downgrade missing-includes diagnostic to Information level
Browse files Browse the repository at this point in the history
In practice, a Warning on every occurrence is very unpopular, even on a codebase
with clear rules about direct inclusion & moderately good compliance.

This change has various practical effects (in vscode for concreteness):
  - makes the diagnostic decoration less striking (blue vs yellow)
  - makes these diagnostics visually distinct from others when reading
  - causes these diagnostics to sort last in the "problems" view
  - allows these diagnostics to be easily filtered from the "problems" view

Differential Revision: https://reviews.llvm.org/D149912
  • Loading branch information
sam-mccall committed May 16, 2023
1 parent 8178de3 commit 8f84797
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 4 deletions.
18 changes: 17 additions & 1 deletion clang-tools-extra/clangd/IncludeCleaner.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,23 @@ std::vector<Diag> generateMissingIncludeDiagnostics(
D.Source = Diag::DiagSource::Clangd;
D.File = AST.tuPath();
D.InsideMainFile = true;
D.Severity = DiagnosticsEngine::Warning;
// We avoid the "warning" severity here in favor of LSP's "information".
//
// Users treat most warnings on code being edited as high-priority.
// They don't think of include cleanups the same way: they want to edit
// lines with existing violations without fixing them.
// Diagnostics at the same level tend to be visually indistinguishable,
// and a few missing includes can cause many diagnostics.
// Marking these as "information" leaves them visible, but less intrusive.
//
// (These concerns don't apply to unused #include warnings: these are fewer,
// they appear on infrequently-edited lines with few other warnings, and
// the 'Unneccesary' tag often result in a different rendering)
//
// Usually clang's "note" severity usually has special semantics, being
// translated into LSP RelatedInformation of a parent diagnostic.
// But not here: these aren't processed by clangd's DiagnosticConsumer.
D.Severity = DiagnosticsEngine::Note;
D.Range = clangd::Range{
offsetToPosition(Code,
SymbolWithMissingInclude.SymRefRange.beginOffset()),
Expand Down
6 changes: 3 additions & 3 deletions clang-tools-extra/clangd/test/include-cleaner-batch-fix.test
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
# CHECK-NEXT: "line": 2
# CHECK-NEXT: }
# CHECK-NEXT: },
# CHECK-NEXT: "severity": 2,
# CHECK-NEXT: "severity": 3,
# CHECK-NEXT: "source": "clangd"
# CHECK-NEXT: },
# CHECK-NEXT: {
Expand All @@ -60,7 +60,7 @@
# CHECK-NEXT: "line": 2
# CHECK-NEXT: }
# CHECK-NEXT: },
# CHECK-NEXT: "severity": 2,
# CHECK-NEXT: "severity": 3,
# CHECK-NEXT: "source": "clangd"
# CHECK-NEXT: },
# CHECK-NEXT: {
Expand Down Expand Up @@ -112,7 +112,7 @@
# CHECK-NEXT: "version": 0
# CHECK-NEXT: }
---
{"jsonrpc":"2.0","id":2,"method":"textDocument/codeAction","params":{"textDocument":{"uri":"test:///simple.cpp"},"range":{"start":{"line":2,"character":1},"end":{"line":2,"character":4}},"context":{"diagnostics":[{"range":{"start": {"line": 2, "character": 1}, "end": {"line": 2, "character": 4}},"severity":2,"message":"No header providing \"Foo\" is directly included (fixes available)", "code": "missing-includes", "source": "clangd"}]}}}
{"jsonrpc":"2.0","id":2,"method":"textDocument/codeAction","params":{"textDocument":{"uri":"test:///simple.cpp"},"range":{"start":{"line":2,"character":1},"end":{"line":2,"character":4}},"context":{"diagnostics":[{"range":{"start": {"line": 2, "character": 1}, "end": {"line": 2, "character": 4}},"severity":3,"message":"No header providing \"Foo\" is directly included (fixes available)", "code": "missing-includes", "source": "clangd"}]}}}
# CHECK: "id": 2,
# CHECK-NEXT: "jsonrpc": "2.0",
# CHECK-NEXT: "result": [
Expand Down

0 comments on commit 8f84797

Please sign in to comment.