Styleguide

DC* edited this page Dec 29, 2016 · 1 revision

General style guide

  • Always use spaces
  • 2 spaces for indentation
  • Keep line length below 80 characters

Conventions

  • Underscore for variable names ($this_is_a_variable)
  • Dash for function names (this-is-a-function)
  • Prefix '-' for "private" functions
  • Always use if / then / else for conditionals

Running shellcheck

Shellcheck is run on TravisCI, but you can run it manually this way:

shellcheck bin/antigen.zsh --shell=ksh

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.