Skip to content

Commit

Permalink
feat: add non-nix pre-commit rustfmt and clippy hooks
Browse files Browse the repository at this point in the history
fix: correct nix pre-commit, update instructions

chore: rename non-nix pre commit cfg and update docs to reflect
  • Loading branch information
PThorpe92 authored and cafkafk committed Jul 15, 2024
1 parent 5428aa6 commit 665c1cb
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
15 changes: 15 additions & 0 deletions .pre-commit-config-non-nix.yaml
Original file line number Diff line number Diff line change
@@ -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 changes: 5 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 665c1cb

Please sign in to comment.