Jelajahi Sumber

feat: add non-nix pre-commit rustfmt and clippy hooks

fix: correct nix pre-commit, update instructions

chore: rename non-nix pre commit cfg and update docs to reflect
PThorpe92 1 tahun lalu
induk
melakukan
665c1cb013
2 mengubah file dengan 20 tambahan dan 0 penghapusan
  1. 15 0
      .pre-commit-config-non-nix.yaml
  2. 5 0
      CONTRIBUTING.md

+ 15 - 0
.pre-commit-config-non-nix.yaml

@@ -0,0 +1,15 @@
+repos:
+  - repo: local
+    hooks:
+      - id: rust-linting
+        name: Rust linting
+        description: Run rustfmt on included files
+        entry: cargo fmt --
+        types: [file, rust]
+        language: system
+      - id: rust-clippy
+        name: Rust clippy
+        description: Run clippy on included files
+        entry: cargo clippy --workspace --all-targets --all-features --
+        types: [file, rust]
+        language: system

+ 5 - 0
CONTRIBUTING.md

@@ -44,6 +44,11 @@ Some useful commands include:
   pre-commit-hooks.nix
 - `just itest`: runs integration tests
 
+**For non-nix users,**
+There are traditional `pre-commit` hooks, which you can install with your system package manager or
+`brew|pip install pre-commit`, and run `pre-commit install -c .pre-commit-config-non-nix.yaml` in the root of the repository.
+Then these hooks will run automatically when you commit.
+
 The [just](https://github.com/casey/just) command runner can be used to run some
 helpful development commands, in a manner similar to `make`.  Run `just --list`
 to get an overview of what’s available.