Fail textDocument/formatting when no formatter is set #108
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
That's reasonable. Thanks! |
oxalica
requested changes
Sep 22, 2023
crates/nil/src/handler.rs
Outdated
Comment on lines
224
to
226
| let Some(cmd) = &snap.config.formatting_command else { | ||
| return Ok(None); | ||
| bail!("No formatter configured. Set the nil.formatting.command LSP server setting."); | ||
| }; |
There was a problem hiding this comment.
Now this can be:
Suggested change
| let Some(cmd) = &snap.config.formatting_command else { | |
| return Ok(None); | |
| bail!("No formatter configured. Set the nil.formatting.command LSP server setting."); | |
| }; | |
| let cmd = snap | |
| .config | |
| .formatting_command | |
| .as_ref() | |
| .context("No formatter configured. Set the nil.formatting.command LSP server setting.")?; |
There was a problem hiding this comment.
Sounds good! It still prints the useful message with context:
[Error - 3:18:09 PM] Request textDocument/formatting failed.
Message: No formatter configured. Set the nil.formatting.command LSP server setting.
Code: -32603
Currently, nil silently fails when no formatter is set. This caused me a lot of confusion as to why nothing was formatting when I accidentally misconfigured the formatter. This makes it so that we return an error instead, alerting the user that something is wrong. This could be annoying to someone who hasn't configured a formatter on purpose but still causes formatting events, either by format-on-save or muscle memory. I think this is fine, and they should turn off format-on-save or just get a formatter instead. Alternatively, someone could set `cat` as their formatter.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently, nil silently fails when no formatter is set. This caused me a lot of confusion as to why nothing was formatting when I accidentally misconfigured the formatter.
This makes it so that we return an error instead, alerting the user that something is wrong.
This could be annoying to someone who hasn't configured a formatter on purpose but still causes formatting events, either by format-on-save or muscle memory. I think this is fine, and they should turn off format-on-save or just get a formatter instead. Alternatively, someone could set
catas their formatter.