fileutil: Omit zsh extensions and shebangs #1101
Open
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
These lines were being rendered into the contents of `shebang-nospace`
rather than separate files because they were missing the trailing `--`
delimiters.
It seems that there's no way to guard against this based `txtar` docs:
> There are no possible syntax errors in a txtar archive.
This change will cause the tests to fail and will be fixed in a
subsequent commit:
> cmpenv stdout find.golden
diff stdout find.golden
--- stdout
+++ find.golden
@@ -16,6 +16,4 @@
modify/shebang-space
modify/shebang-tabs
modify/shebang-usr-sh
-skip/ext.zsh
-skip/shebang-zsh
symlink/subdir/ext-shebang.sh
FAIL: testdata/script/walk.txtar:10: stdout and find.golden differ
To prevent `shfmt` from discovering `zsh` files which aren't currently supported for formatting. This fixes mvdan#535 and the following test: > cmpenv stdout find.golden diff stdout find.golden --- stdout +++ find.golden @@ -16,6 +16,4 @@ modify/shebang-space modify/shebang-tabs modify/shebang-usr-sh -skip/ext.zsh -skip/shebang-zsh symlink/subdir/ext-shebang.sh FAIL: testdata/script/walk.txtar:10: stdout and find.golden differ It could be considered a breaking change to `shfmt` and `fileutil`. There's some discussion in that issue about whether it's beneficial to match `zsh` files because they can _sometimes_ be formatted if they don't contain any zsh-specific syntax, but without any way to explicitly exclude them from discovery it's more of a hindrance than help.
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.
testdata: Fix missing zsh files
These lines were being rendered into the contents of
shebang-nospacerather than separate files because they were missing the trailing
--delimiters.
It seems that there's no way to guard against this based
txtardocs:This change will cause the tests to fail and will be fixed in a
subsequent commit:
fileutil: Omit zsh extensions and shebangs
To prevent
shfmtfrom discoveringzshfiles which aren't currentlysupported for formatting.
This fixes #535 and the following test:
It could be considered a breaking change to
shfmtandfileutil.There's some discussion in that issue about whether it's beneficial to
match
zshfiles because they can sometimes be formatted if theydon't contain any zsh-specific syntax, but without any way to explicitly
exclude them from discovery it's more of a hindrance than help until #120 is done.