https://github.com/vic/checkmate
A flake checker (treefmt & nix-unit) for testing other flakes with zero dependencies.
https://github.com/vic/checkmate
flake flakes nix nix-flake treefmt treefmt-nix unit-testing
Last synced: 2 months ago
JSON representation
A flake checker (treefmt & nix-unit) for testing other flakes with zero dependencies.
- Host: GitHub
- URL: https://github.com/vic/checkmate
- Owner: vic
- License: apache-2.0
- Created: 2025-03-14T20:46:23.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-07-15T04:29:45.000Z (3 months ago)
- Last Synced: 2025-07-15T10:13:32.497Z (3 months ago)
- Topics: flake, flakes, nix, nix-flake, treefmt, treefmt-nix, unit-testing
- Language: Nix
- Homepage:
- Size: 34.2 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Checkmate - A flake checker (treefmt & nix-unit) for testing other flakes with zero dependencies.
Checks include:
- treefmt - nixfmt, deadnix, mdformat, yamlfmt. See `treefmt.nix`.
- nix-unit - The flake being checked (ie, `inputs.target`) is expected to expose `flakeModules.checkmate`:
> 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)
```shell
# Generate a new project including github CI action
nix flake new -t github:vic/checkmate
```
### Running treefmt on your code
```shell
# formatting your code
nix run path:checkmate#fmt
# checking if code is formatted
nix run path:checkmate#fmt -- --ci
```
### Running flake check locally
```shell
nix run path:checkmate
```
### CI Usage
On your github action:
```yaml
on:
pull_request:
push:
branches: [main]
jobs:
flake-check:
name: nix flake check
runs-on: ubuntu-latest
steps:
- uses: cachix/install-nix-action@v30
- run: nix flake check -L github:vic/checkmate --override-input target github:$GITHUB_REPOSITORY/
$GITHUB_SHA
```
As a fully working example, see:
https://github.com/vic/import-tree