paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-01 12:33:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add shellcheck as a linter.

Browse Source 
Fixes #10162.

Tweaked by tabbott to cover documentation as well.

Signed-off-by: Anders Kaseorg <andersk@mit.edu>
This commit is contained in:
Anders Kaseorg
2018-08-02 20:09:42 -04:00
committed by Tim Abbott
parent d0fb34e8af
commit c3bd293eaf
6 changed files with 32 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/testing/linters.md
View File

@@ -210,10 +210,19 @@ its CSS; see our
[configuration](https://github.com/zulip/zulip/blob/master/.stylelintrc)
for the rules we currently enforce.
#### Shell scripts
Zulip uses [shellcheck](https://github.com/koalaman/shellcheck) to
lint our shell scripts. We recommend the
[shellcheck gallery of bad code][shellcheck-bad-code] as a resource on
how to not write bad shell.
[shellcheck-bad-code]: https://github.com/koalaman/shellcheck/blob/master/README.md#user-content-gallery-of-bad-code
#### Markdown, shell scripts, JSON fixtures
We mostly validate miscellaneous source files like `.sh`, `.json`, and `.md` files for
whitespace issues.
We mostly validate miscellaneous source files like `.json`, and `.md`
files for whitespace issues.
## Philosophy