|
1 | | -# Checkmate - A flake checker (treefmt & nix-unit) for testing other flakes with zero dependencies. |
| 1 | +<p align="right"> |
| 2 | + <a href="https://github.com/sponsors/vic"><img src="https://img.shields.io/badge/sponsor-vic-white?logo=githubsponsors&logoColor=white&labelColor=%23FF0000" alt="Sponsor Vic"/> |
| 3 | + </a> |
| 4 | + <a href="https://vic.github.io/dendrix/Dendritic-Ecosystem.html#vics-dendritic-libraries"> <img src="https://img.shields.io/badge/Dendritic-Nix-informational?logo=nixos&logoColor=white" alt="Dendritic Nix"/> </a> |
| 5 | + <a href="LICENSE"> <img src="https://img.shields.io/github/license/vic/checkmate" alt="License"/> </a> |
| 6 | + <a href="https://github.com/vic/checkmate/actions"> |
| 7 | + <img src="https://github.com/vic/checkmate/actions/workflows/test.yml/badge.svg" alt="CI Status"/> </a> |
| 8 | +</p> |
2 | 9 |
|
3 | | -Checks include: |
| 10 | +# Checkmate - A Dendritic flake checker (treefmt & nix-unit) for testing other flakes with zero dependencies. |
| 11 | + |
| 12 | +> `checkmate` and [vic](https://bsky.app/profile/oeiuwq.bsky.social)'s [dendritic libs](https://vic.github.io/dendrix/Dendritic-Ecosystem.html#vics-dendritic-libraries) made for you with Love++ and AI--. If you like my work, consider [sponsoring](https://github.com/sponsors/vic) |
| 13 | +
|
| 14 | +### Checks included by default |
4 | 15 |
|
5 | 16 | - treefmt - nixfmt, deadnix, mdformat, yamlfmt. See `treefmt.nix`. |
6 | 17 |
|
7 | 18 | - nix-unit - The flake being checked (ie, `inputs.target`) is expected to expose `flakeModules.checkmate`: |
8 | 19 |
|
9 | | -> See [import-tree](https://github.com/vic/import-tree/blob/main/checks/checkmate.nix) or [example](https://github.com/vic/checkmate/blob/main/example/checkmate.nix) |
| 20 | +### Extensible. |
| 21 | + |
| 22 | +Checkmate is a collection of Denritic modules. |
| 23 | + |
| 24 | +### Getting started |
10 | 25 |
|
11 | 26 | ```shell |
12 | 27 | # Generate a new project including github CI action |
13 | 28 | nix flake new -t github:vic/checkmate |
14 | 29 | ``` |
15 | 30 |
|
| 31 | +### Running flake check locally |
| 32 | + |
| 33 | +```console |
| 34 | +nix flake check github:vic/checkmate --override-input target . |
| 35 | +``` |
| 36 | + |
16 | 37 | ### Running treefmt on your code |
17 | 38 |
|
18 | | -```shell |
| 39 | +```console |
19 | 40 | # formatting your code |
20 | | -nix run path:checkmate#fmt |
| 41 | +nix run github:vic/checkmate#fmt --override-input target . |
21 | 42 |
|
22 | 43 | # checking if code is formatted |
23 | | -nix run path:checkmate#fmt -- --ci |
24 | | -``` |
25 | | - |
26 | | -### Running flake check locally |
27 | | - |
28 | | -```shell |
29 | | -nix run path:checkmate |
| 44 | +nix run github:vic/checkmate#fmt --override-input target . -- --ci |
30 | 45 | ``` |
31 | 46 |
|
32 | 47 | ### CI Usage |
|
0 commit comments