shfmt-configuration

Shell script formatting consistency is enforced through shfmt configuration. Create a .shfmt.toml file in your project root to define rules like indentation style, shell dialect (bash, posix, mksh, bats), and spacing preferences. These settings apply uniformly to all shell scripts when shfmt runs, eliminating manual formatting decisions across your team.

Yes. shfmt integrates with EditorConfig to align shell formatting with editor-wide rules. Map shfmt options like indent_size and binary_next_line to EditorConfig properties in your .editorconfig file. This ensures formatting consistency whether developers use shfmt directly or through their editor.

shfmt supports posix, bash, mksh, and bats shell dialects. You specify the target dialect in .shfmt.toml via the shell setting. This lets you enforce dialect-specific formatting rules—such as function declaration style or command substitution syntax—tailored to your project's shell requirements.

Configure indentation and spacing in .shfmt.toml using options like indent (number of spaces), space_redirects (spacing around redirects), keep_padding (preserve alignment), and func_next_line (function brace placement). Each option controls specific formatting aspects; combine them to define your team's shell formatting standard.

shfmt applies configuration in order of precedence: command-line flags override EditorConfig settings, which override .shfmt.toml defaults. This hierarchy lets you set baseline rules in .shfmt.toml, refine them per-directory in EditorConfig, and override both temporarily via CLI for one-off runs.

Yes. shfmt provides separate .shfmt.toml options: switch_case_indent controls case statement indentation, and binary_next_line places binary operators at line start or end. Configure each independently to match your project's style for conditionals and multi-line expressions.