shfmt
shfmt documentation
- Version in MegaLinter: 3.7.0
- Visit Official Web Site
Configuration in MegaLinter
- Enable shfmt by adding
BASH_SHFMT
in ENABLE_LINTERS variable - Disable shfmt by adding
BASH_SHFMT
in DISABLE_LINTERS variable
- Enable autofixes by adding
BASH_SHFMT
in APPLY_FIXES variable
Variable | Description | Default value |
---|---|---|
BASH_SHFMT_ARGUMENTS | User custom arguments to add in linter CLI call Ex: -s --foo "bar" |
|
BASH_SHFMT_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter Ex: -s --foo "bar" |
|
BASH_SHFMT_FILTER_REGEX_INCLUDE | Custom regex including filter Ex: (src\|lib) |
Include every file |
BASH_SHFMT_FILTER_REGEX_EXCLUDE | Custom regex excluding filter Ex: (test\|examples) |
Exclude no file |
BASH_SHFMT_CLI_LINT_MODE | Override default CLI lint mode - file : Calls the linter for each file- list_of_files : Call the linter with the list of files as argument- project : Call the linter from the root of the project |
list_of_files |
BASH_SHFMT_FILE_EXTENSIONS | Allowed file extensions. "*" matches any extension, "" matches empty extension. Empty list excludes all filesEx: [".py", ""] |
[".sh", ".bash", ".dash", ".ksh"] |
BASH_SHFMT_FILE_NAMES_REGEX | File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files Ex: ["Dockerfile(-.+)?", "Jenkinsfile"] |
Include every file |
BASH_SHFMT_PRE_COMMANDS | List of bash commands to run before the linter | None |
BASH_SHFMT_POST_COMMANDS | List of bash commands to run after the linter | None |
BASH_SHFMT_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling BASH_SHFMT and its pre/post commands | None |
BASH_SHFMT_DISABLE_ERRORS | Run linter but consider errors as warnings | true |
BASH_SHFMT_DISABLE_ERRORS_IF_LESS_THAN | Maximum number of errors allowed | 0 |
BASH_SHFMT_CLI_EXECUTABLE | Override CLI executable | ['shfmt'] |
IDE Integration
Use shfmt in your favorite IDE to catch errors before MegaLinter !
MegaLinter Flavours
This linter is available in the following flavours
Flavor | Description | Embedded linters | Info | |
---|---|---|---|---|
![]() |
all | Default MegaLinter Flavor | 118 | |
c_cpp | Optimized for pure C/C++ projects | 53 | ||
ci_light | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 22 | ||
cupcake | MegaLinter for the most commonly used languages | 85 | ||
documentation | MegaLinter for documentation projects | 51 | ||
dotnet | Optimized for C, C++, C# or VB based projects | 63 | ||
dotnetweb | Optimized for C, C++, C# or VB based projects with JS/TS | 72 | ||
formatters | Contains only formatters | 16 | ||
go | Optimized for GO based projects | 53 | ||
java | Optimized for JAVA based projects | 55 | ||
javascript | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 60 | ||
php | Optimized for PHP based projects | 54 | ||
python | Optimized for PYTHON based projects | 62 | ||
ruby | Optimized for RUBY based projects | 51 | ||
rust | Optimized for RUST based projects | 51 | ||
salesforce | Optimized for Salesforce based projects | 55 | ||
swift | Optimized for SWIFT based projects | 51 | ||
terraform | Optimized for TERRAFORM based projects | 55 |
Behind the scenes
How are identified applicable files
- File extensions:
.sh
,.bash
,.dash
,.ksh
How the linting is performed
- shfmt is called once with the list of files as arguments (
list_of_files
CLI lint mode)
Example calls
shfmt -d myfile.sh
shfmt -w myfile.sh
Help content
usage: shfmt [flags] [path ...]
shfmt formats shell programs. If the only argument is a dash ('-') or no
arguments are given, standard input will be used. If a given path is a
directory, all shell scripts found under that directory will be used.
--version show version and exit
-l, --list list files whose formatting differs from shfmt's
-w, --write write result to file instead of stdout
-d, --diff error with a diff when the formatting differs
-s, --simplify simplify the code
-mn, --minify minify the code to reduce its size (implies -s)
Parser options:
-ln, --language-dialect str bash/posix/mksh/bats, default "auto"
-p, --posix shorthand for -ln=posix
--filename str provide a name for the standard input file
Printer options:
-i, --indent uint 0 for tabs (default), >0 for number of spaces
-bn, --binary-next-line binary ops like && and | may start a line
-ci, --case-indent switch cases will be indented
-sr, --space-redirects redirect operators will be followed by a space
-kp, --keep-padding keep column alignment paddings
-fn, --func-next-line function opening braces are placed on a separate line
Utilities:
-f, --find recursively find all shell files and print the paths
--to-json print syntax tree to stdout as a typed JSON
--from-json read syntax tree from stdin as a typed JSON
For more information, see 'man shfmt' and https://github.com/mvdan/sh.
Installation on mega-linter Docker image
- Dockerfile commands :
FROM mvdan/shfmt:latest-alpine as shfmt
COPY --link --from=shfmt /bin/shfmt /usr/bin/