pre-commit-hooks 0.3.0

Reads hooks metadata from Cargo.toml and executes on commit. Works with workspace format.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

# pre-commit-hooks

Reads hooks metadata from `Cargo.toml` and executes on commit. A forked from unmaintained [pre-commit](https://github.com/rustation/pre-commit).


### Installing

```
[dependencies]
pre-commit-hooks = "0.3"
```

For a workspace-based setup, one only need to add it in one of the package dependency, usually the main package (if any). This is because the pre-commit applies to the whole project.

### Usage

Add a table like the following to your root `Cargo.toml`:

```
[package.metadata.precommit]
fmt = "cargo fmt"
sort = "cargo sort"
```

Or, if you're ussing workspace:
```
[workspace.metadata.precommit]
fmt = "cargo fmt"
sort = "cargo sort -w"
```

Then run:

```
$ cargo clean
$ cargo build
```

You should now have a `pre-commit` file in your `./git/hooks` that will run the listed pre-commit entries.

# Credit

The `find_crate_root` function is refactored with the help of [emilgardis](https://github.com/emilgardis).