Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Do not format a file that contains an error in the LSP #3447

Merged
merged 6 commits into from
Nov 11, 2024
Merged

Do not format a file that contains an error in the LSP #3447

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
de52eb1
do not format a file that contains an error
sprsquish Nov 4, 2024
1be2a05
Merge branch 'main' into fix-format-with-error
sprsquish Nov 6, 2024
dc26c33
Merge branch 'main' into fix-format-with-error
sprsquish Nov 7, 2024
6239e3b
Merge branch 'main' into fix-format-with-error
sprsquish Nov 8, 2024
a484674
Add commentary on why formatting was skipped
sprsquish Nov 8, 2024
3157b77
provide a count of errors found
sprsquish Nov 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions private/buf/buflsp/server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,18 @@ func (s *server) Formatting(
return nil, fmt.Errorf("received update for file that was not open: %q", params.TextDocument.URI)
}

// We check the diagnostics on the file, if there are any build errors, we do not want
// to format an invalid AST, so we skip formatting and return an error for logging.
errorCount := 0
for _, diagnostic := range file.diagnostics {
if diagnostic.Severity == protocol.DiagnosticSeverityError {
errorCount += 1
}
}
if errorCount > 0 {
return nil, fmt.Errorf("cannot format file %q, %v error(s) found.", file.uri.Filename(), errorCount)
}

// Currently we have no way to honor any of the parameters.
_ = params
if file.fileNode == nil {
Expand Down