diff options
| author | Owen Jacobson <owen@grimoire.ca> | 2025-06-23 22:45:18 -0400 |
|---|---|---|
| committer | Owen Jacobson <owen@grimoire.ca> | 2025-07-01 20:25:30 -0400 |
| commit | c38d877b94c6ac5df2de4c9c939ae683d733e8b8 (patch) | |
| tree | f8d02380dfef622656710b1412900eb21cc42656 /docs/linting.md | |
| parent | c0c825477e476d6d7331bfc409bceff9c376b484 (diff) | |
Organize the developer docs into a "Pilcrow for Developers" book.
The audience for this is developers looking to make changes to Pilcrow, either on the server, on the included client, or via its data model. Most of the material here is drawn from existing documents, but organized somewhat more coherently.
I've left some space for client documentation, though no such documents exist yet.
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. |