feat(shfmt): add a useEditorConfig option
#443
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
With vanilla `shfmt`, it's easy to get it to use `.editorconfig` files: you simply [invoke it with no arguments](https://github.com/mvdan/sh/blob/v3.12.0/cmd/shfmt/shfmt.1.scd?plain=1#L20-L21). However, with `treefmt-nix`, it's a bit more challenging because we turn on some knobs by default, and those knobs change over time. For example, we have users who [used to accomplish this by setting `indent_size` to `null`](https://github.com/sellout/bash-strict-mode/blob/37eaa2e33d24168e0a903ddd9828666c1b91f867/.config/project/default.nix#L31-L33), but then we recently added the [simplify flag which defaults to true](numtide@6b850ba), thereby causing shfmt to no longer honor `.editorconfig` files. To give people some stability, this new `useEditorConfig` option changes the defaults so they're all disabled, and furthermore asserts that every option is disabled (in case people try to change them by hand). This protects our users against new default options in the future. An alternative to this would be a policy of not deviating from shfmt's defaults, but I think this is clearer for everyone.
jfly
force-pushed
the
link-to-correct-project
branch
from
68c9ade to
6303e70
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
With vanilla
shfmt, it's easy to get it to use.editorconfigfiles: you simply invoke it with noarguments.
However, with
treefmt-nix, it's a bit more challenging because we turn on some knobs by default, and those knobs change over time. For example, we have users who used to accomplish this by settingindent_sizetonull, but then we recently added the simplify flag which defaults to true, thereby causing shfmt to no longer honor.editorconfigfiles.To give people some stability, this new
useEditorConfigoption changes the defaults so they're all disabled, and furthermore asserts that every option is disabled (in case people try to change them by hand). This protects our users against new default options in the future.An alternative to this would be a policy of not deviating from shfmt's defaults, but I think this is clearer for everyone.