shellcheck/README.md

   1 ---
   2 title: ShellCheck
   3 homepage: https://github.com/koalaman/shellcheck
   4 tagline: |
   5   ShellCheck - A shell script static analysis tool
   6 ---
   7
   8 To update or switch versions, run `webi shellcheck@stable`, or `@vx.y.z` for a
   9 specific version.
  10
  11 ## Cheat Sheet
  12
  13 > shellcheck catches rookie mistakes (and old-habits-die-hard mistakes) in bash
  14
  15 ### Run shellcheck in your terminal:
  16
  17 ```bash
  18 shellcheck yourscript
  19 ```
  20
  21 <!---
  22 ### Run shellcheck in your editor:
  23
  24 Include running shellcheck in editor?
  25
  26 It's just links to other linters or extensions
  27 -->
  28
  29 ### To use shellcheck in a build or test suite:
  30
  31 Simply include shellcheck in the process.
  32
  33 ```bash
  34 check-scripts:
  35     # Fail if any of these files have warnings
  36     shellcheck myscripts/*.sh
  37 ```
  38
  39 <!---
  40 Improve this as you need to!
  41 -->