checks
@avi2dg/checks turns each rule a reviewer would otherwise have to remember into a program that runs on every pull request.
One command, checks-lint, judges a TypeScript repository's code, tests, commits, CI wiring and docs, and each failure names the file or line to fix.
Every Bun repository it holds moves to a new rule by upgrading one package, rather than by copying configs between repositories.
Before you begin
- A git repository, whose history the range gates read.
- Bun, at the version the kit's
.bun-versionpins.
Install
To hold a repository to the kit:
-
Add the kit:
bun add -d @avi2dg/checks -
Pin the Bun version the kit runs on:
cp node_modules/@avi2dg/checks/.bun-version .bun-version -
Run the gates:
bunx checks-lint
Each gate that fails names the file it needs, and Set up a repository writes every one.
A repository the kit holds ends with checks-lint: <count> gate(s) pass.
Find the page you need
| To | Read |
|---|---|
| write every file the gates ask for | Set up a repository |
| move to a newer release | Upgrade the kit |
| turn on the CSS checks | Turn on the CSS families |
| picture one block at each screen size and approve its pictures | Test the screens of one block |
| look up a gate or a bin | The bins |
| look up a shared config | Native settings |
| find a file the package ships | The shipped files |
| learn why the kit is shaped this way | Why it is shaped this way |