Consolidate project linting into tool scripts.

The new `tools/check-lint` script checks lints across _all_ lintable files - JS (through `eslint`), and Rust (through `clippy` and `cargo check`). It also checks `eslint` against the whole project, not just against what's in the `ui` subdir, which means it now catches lintable issues in various JS config files.

This was originally part of [another proposal][pr-6]. I've broken it out to make the intent clearer, and to make the proposal easier to get a handle on in isolation from other, related changes. Thanks to @wlonk for their input on this!

[pr-6]: https://codeberg.org/ojacobson/pilcrow/pulls/6

Merges prop/lint-checks into main.

1 files changed, 23 insertions, 0 deletions

diff --git a/docs/linting.md b/docs/linting.md
new file mode 100644
index 0000000..6620a74
--- /dev/null
+++ b/docs/linting.md
@@ -0,0 +1,23 @@
+# 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.