Format comparisons, functions, and redirections to be consistent #1201
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
spacewander
reviewed
Mar 26, 2025
ferdnyc
reviewed
Apr 4, 2025
There was a problem hiding this comment.
This seems like a helpful bit of cleanup, @hyperupcall -- I agree with @spacewander, it would be good to have those checks in the CI as well.
| function addworkspace { | ||
| addworkspace() { |
There was a problem hiding this comment.
There's still some inconsistency allowed here because when your script adds parentheses, it adds them without a space after the function name...
| function guardedExecution () { | ||
| guardedExecution () { |
There was a problem hiding this comment.
But if they're already present, it will leave the format however it was previously...
| function _usage() { | ||
| _usage() { |
There was a problem hiding this comment.
Which means the results have all of:
# Definitions without a space, because they
# were changed from
function fname { ... }
# to
fname() { }
# Definitions without a space, because they were
# changed from
function fname() { ... }
# to
fname() { ... }
# Definitions with a space, because they were
# changed from
function fname () { ... }
# to
fname () { ... }(And that's just in the ones the script modified.) Would it be better to decide on a particular style and apply it consistently?
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.
It can be difficult reading through scripts here with every file seemingly having a different convention (for argument parsing, help menu, function delarations, etc.). This cleans up some of that with a little checkstyle.py script I made for asdf-vm a while back (it has autofix). It catches some things that ShellCheck doesn't, or autofixes things that ShellCheck doesn't.
One thing I would like to do, is add a
chekstyle.pyhere, so we can easily enforce those style issues (and possibly other automatically fixable things) for new PRs. Is there interest in that?