Add shell script formatter #598
Merged
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
|
Can you summarize the indention rules used in shfmt? |
|
@jserv The CI using GCC 14 on the macOS host keeps failing due to a version mismatch (the latest is gcc-15). I'll send a PR to fix it first. |
jserv
requested changes
Jun 1, 2025
ChinYikMing
force-pushed
the
shfmt
branch
2 times, most recently
from
af8cf25 to
10617cb
Compare
Mentioned in the commit messages. |
Move the formatting rules in |
Leverage shfmt as the standard formatter for shell scripts in this repo.
- add `.editorconfig` with formatting rules and apply shfmt in
.ci/check-format.sh. The formatting rules are as follows:
* Use spaces for indentation
* Indent with 4 spaces
* Use Unix-style line endings (LF)
* Remove trailing whitespace at the end of lines
* Ensure the file ends with a newline
* Place the opening brace of a function on the next line
* Indent case statements within switch blocks
* Add spaces around redirection operators (e.g., >, >>)
* Place binary operators (e.g., &&, |) on the next line when breaking
lines
- update CONTRIBUTING.md with formatting rules and usage instructions.
Contributors must ensure consistent shell script style before code
submission.
The early exit behavior (set -e) in .ci/check-format.sh has been removed
to allow collecting all formatting mismatches in a single run. The
script’s exit code is now the sum of the line-level mismatch count from
clang-format-18 and the file-level mismatch count from shfmt, which
should be 0 if all files are properly formatted.
All existing shell scripts are reformatted with the formatting rules.
|
Thank @ChinYikMing for contributing. |
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.
Leverage shfmt as the standard formatter for shell scripts in this repo.
Summary by Bito
This pull request standardizes shell script formatting by introducing shfmt, enhancing error handling, and improving readability. It includes an EditorConfig file for consistent formatting rules and updates to various scripts for better maintainability.