diff options
Diffstat (limited to 'docs/linting.md')
| -rw-r--r-- | docs/linting.md | 21 |
1 files changed, 0 insertions, 21 deletions
diff --git a/docs/linting.md b/docs/linting.md deleted file mode 100644 index 47420bb..0000000 --- a/docs/linting.md +++ /dev/null @@ -1,21 +0,0 @@ -# Linting - -We use automated tools, rather than human effort, to spot possible bugs or dubious structural choices, where possible. This is handled by three tools: - -- Javascript is linted using [eslint]. -- Rust is linted using [cargo check] and [clippy]. - -[eslint]: https://eslint.org/ -[cargo check]: https://doc.rust-lang.org/cargo/commands/cargo-check.html -[clippy]: https://doc.rust-lang.org/cargo/commands/cargo-clippy.html - -## Tools - -- To check for detectable lints, run - `tools/check-lint`. This should be run whenever making changes, and is part of the optional - `git-hooks/pre-commit` hook script. - -- To fix lints that have automatic fixes, run - `tools/delint`. - -You can also run the individual lint tools directly. The tool scripts listed above contain the specific commands needed. |