Add .editorconfig support for shfmt #1171
Merged
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
Language dialect is something that can be set via `.editorconfig`, so we'll need to respect that when running `shfmt`.
If we have any `shfmt`-specific options in `.editorconfig`, use the config in `.editorconfig` and ignore the language server config (this is similar to `shfmt`'s approach of using either `.editorconfig` or command line flags, but not both). Indentation always comes via the editor - if someone is using `.editorconfig` then the expectation is that they will have configured their editor's indentation in this way too.
The error message that we expect from one of our tests is different depending upon which version of shfmt is being run. Fix the test to accept both error messages.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1171 +/- ##
==========================================
- Coverage 81.27% 81.09% -0.18%
==========================================
Files 29 29
Lines 1415 1439 +24
Branches 338 342 +4
==========================================
+ Hits 1150 1167 +17
Misses 218 218
- Partials 47 54 +7 ☔ View full report in Codecov by Sentry. |
|
Fixed one of the tests to work with the older version of |
skovhus
approved these changes
Jun 10, 2024
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.
This PR adds support for reading
shfmtconfig via.editorconfig.If any
shfmt-specific configuration properties are found in.editorconfigthen the config in.editorconfigwill be used and the language server config will be ignored. This followsshfmt's approach of using either.editorconfigor command line flags, but not both. Note that onlyshfmt-specific configuration properties are read from.editorconfig- indentation preferences are still provided by the editor, so to format using the indentation specified in.editorconfigmake sure your editor is also configured to read.editorconfig.It is possible to disable
.editorconfigsupport and always use the language server config by setting the "Ignore Editorconfig" configuration variable.See #1165 for some discussion of the approach to this.