fix(config): handle unset and off values in editorconfig files
#3907
Conversation
This file contains hidden or 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
c223874 to
f0e2039
Compare
ematipico
reviewed
Sep 16, 2024
crates/biome_cli/tests/snapshots/main_cases_editorconfig/should_emit_diagnostics.snap
Outdated
Show resolved
Hide resolved
| ```block | ||
| configuration ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ | ||
| × Key 'max_line_length' is incompatible with biome: 'off' is incompatible with how Biome works. |
There was a problem hiding this comment.
The spec says that off means "use the default settings". Can't we do that?
Regarding the message, I think we could be more specific. Saying "incompatible with Biome" seems to be too generic. Also, the message isn't actionable, because it doesn't tell the user what they should do to fix the issue.
There was a problem hiding this comment.
Yeah we can do that.
Btw, the only mention of "off" seems to be in this document: https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties and it doesn't seem to be present in https://spec.editorconfig.org/
There was a problem hiding this comment.
Perhaps they standardized off to unset?
f0e2039 to
ca791ca
Compare
Conaclos
reviewed
Sep 16, 2024
ematipico
approved these changes
Sep 16, 2024
Conaclos
reviewed
Sep 16, 2024
Conaclos
approved these changes
Sep 16, 2024
ca791ca to
045f3da
Compare
Closed
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Summary
In the editorconfig spec,
unsetmeans "use the default value" andoff(in the context ofmax_line_length) means "completely turn off the line limit".This PR aims to implement the behavior for
unset, andoff.provide a better diagnostic when encounteringoff. We technically can't really handleoffbecause biome doesn't have a mechanism to turn off the max line length enforcement.fixes #3886
closes #3904
Test Plan
Added some unit tests and a cli snapshot test