DeveloperWiki:Bash Coding Style

From ArchWiki
Revision as of 17:50, 2 July 2010 by Drankinatty (Talk | contribs) (Policy)

Jump to: navigation, search

Policy

  • encoding is utf-8
  • use #!/bin/bash
  • indent with tabs
  • tabs have 8 characters
  • don't use more than 132 columns
  • opening braces are top right, closing are bottom left:
foo() {
        echo bar
}
  • if and for statements are like this:
if true; then
        do something
else
        do something else
fi
for i in a b c; do
        echo $i
done
  • use single quotes if a string does not contain parseable content
  • use source instead of .

Modelines

Add these lines at the bottom of the document to enforce our guideline:

# vim: set noexpandtab tabstop=8 shiftwidth=8 textwidth=132 autoindent
# kate: indent-mode normal; indent-width 8; tab-indents on; tab-width 8; word-wrap on; word-wrap-column 132