paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-04 14:03:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add some basic documentation on linter options.

Browse Source
This commit is contained in:
Tim Abbott
2019-06-24 14:24:31 -07:00
parent a2de8ab44f
commit 83c2287da2
1 changed files with 10 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/testing/linters.md
View File

@@ -37,7 +37,16 @@ You can also run them individually or pass specific files:
./tools/lint ./tools/lint
./tools/lint static/js/compose.js ./tools/lint static/js/compose.js
./tools/lint static/js/ ./tools/lint static/js/
./tools/run-mypy
`./tools/lint` has many useful options; you can read about them in its
internal documentation using `./tools/lint --help`. Of particular
note are:
* `--fix`: Several of our linters support automatically fixing basic
issues; this option will ask `tools/lint` to run those.
* `--verbose`: Provides detailed information on how to fix many common
linter errors not covered by `--fix`.
* `--skip` and `--only`: Only run certain linters.
* `-m`: Only check modified files.
Finally, you can rely on our Travis CI setup to run linters for you, but Finally, you can rely on our Travis CI setup to run linters for you, but
it is good practice to run lint checks locally. it is good practice to run lint checks locally.
@@ -56,11 +65,6 @@ Our linting tools generally support the ability to lint files
individually--with some caveats--and those options will be described individually--with some caveats--and those options will be described
later in this document. later in this document.
We may eventually bundle `run-mypy` into `lint`, but mypy is pretty
resource intensive compared to the rest of the linters, because it does
static code analysis. So we keep mypy separate to allow folks to quickly run
the other lint checks.
## General considerations ## General considerations
Once you have read the [Zulip coding guidelines](../contributing/code-style.html), you can Once you have read the [Zulip coding guidelines](../contributing/code-style.html), you can