sh

README

sh

A shell parser and formatter. Supports POSIX Shell and Bash.

For a quick overview, see the examples.

shfmt

go get -u github.com/mvdan/sh/cmd/shfmt

shfmt formats shell programs. It can use tabs or any number of spaces to indent. See canonical.sh for a quick look at its style.

You can feed it standard input, any number of files or any number of directories to recurse into. When recursing, it will operate on .sh and .bash files and ignore files starting with a period. It will also operate on files with no extension and a shell shebang.

shfmt -l -w script.sh

Use -i N to indent with a number of spaces instead of tabs.

Fuzzing

This project makes use of go-fuzz to find crashes and hangs in both the parser and the printer. To get started, run:

git checkout fuzz
./fuzz

Related projects

• format-shell - Atom plugin for shfmt