cmd/shfmt: document when --filename is needed for EditorConfig support #1058
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
mvdan
force-pushed
the
shfmt-filename-editorconfig
branch
from
0be84b7
to
db0b4ba
Compare
EditorConfig files are found based on a script's absolute path, and the EditorConfig patterns are usually filename-based as well. When formatting standard input, there is no known filename or path. Sometimes there's a need to format a stream of bytes in memory without having to place them on a file, which is why we support stdin. We added the --filename flag for this purpose a long time ago, and the tests already verified this fact - we just hadn't documented it. While here, also add a test case for absolute paths, and make the man page flags consistently use double dashes. Fixes #1055.
mvdan
force-pushed
the
shfmt-filename-editorconfig
branch
from
db0b4ba
to
6562761
Compare
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.
(see commit message)
Fixes #1055.