summaryrefslogtreecommitdiff
path: root/README.md
blob: e631b9fad8e66c7a293512315e282863197b49df (plain)
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
> [!WARNING]
> This project has been archived! [treefmt-nix](https://github.com/numtide/treefmt-nix ) is the recommended alternative
>
> Thanks to all those who helped :)

# flake-checks

Simple, lightweight, and reusable Nix `flake check`s

## Getting started

```sh
nix flake init --template github:getchoo/flake-checks # create a new flake with our template
nix flake check --print-build-logs # and off to the races!
```

## Usage

### `mkChecks :: { pkgs, root }`

Returns an attribute set of our [supported checks](./checks)

## Related projects

- [git-hooks.nix](https://github.com/cachix/git-hooks.nix) (previously `pre-commit-hooks.nix`)