Compare commits

...

2 Commits

Author SHA1 Message Date
Preston Thorpe
42bfc45a6e
Merge e3eeb2c5d3 into 99b2fc214e 2024-06-25 22:19:56 -04:00
PThorpe92
e3eeb2c5d3
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
2024-06-25 22:19:23 -04:00
2 changed files with 20 additions and 0 deletions

View File

@ -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

View File

@ -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 whats available.