Appearance
I want to
Each line ends the sentence of the title. Its link opens the step where that path starts.
Start
- install Lawcheck on my machine
- install Lawcheck in a project with npm, pnpm, Yarn or Bun
- start Lawcheck through the package manager of the project
- confirm that the setup works
- remove Lawcheck
- see a first finding in my own repository
- fix the line a failing check names
- learn the words these pages use
- choose between Lawcheck and a tool I already use
- read these pages in the terminal
Types
- write the first type and the first script rule
- try a rule on the files I name, even before a type lists it
- give every file of an existing project a type
- describe a project with types inside types
- find out why a file has its type
- fix two types that claim one file
- keep generated or vendored files out of the law
- see the law of a file I have not written yet
- give the files of one folder two types by their text, such as tests beside the code
- find out why a file has no type
Uses
- stop one layer from using another
- understand and fix a forbidden-use finding
- understand an unresolved use
- handle a file in a language Lawcheck does not read
- guard the layers of a project in several languages
Script rules
- write a script rule
- share code between rules
- make a rule advisory
- fix a rule that crashes or runs too long
- use a package in a script rule
Reviewer rules
- write a rule in plain words that a model judges
- choose a reviewer and set its key
- judge with a model on my own machine
- judge with Claude Code, Codex, Gemini CLI or Copilot CLI and no API key
- see what a review will cost before it runs
- tune the wording of a rule on a few files
- check that a rule gets the same answer each time
- ask the reviewer again after a failed review
- handle a file too large to review, or a rule the model cannot judge
- give the reviewer another file with each file it judges
- know whether the recorded passes hold after I change the model
- fix a reviewer that cannot be reached
A law for existing code
- bring in a law without turning the build red
- decide whether a new rule starts enforced or advisory
- start a new rule as advisory
- list the debt
- turn an advisory rule into an enforced one
Coding agents
- use Lawcheck with Claude Code
- give the agent the law at the start of each session
- have each edit of the agent checked at once
- send the agent back while the files it changed for my prompt break the law
- switch off one of the plugin's checks
- use Lawcheck with Codex, Copilot CLI, Gemini CLI or another agent
- see what the agent leaves to my word
- see how the agent reads a failed check
CI and teams
- add a CI job
- set the base in CI, for pull requests, pushes to main and the first push of a branch
- run the check on GitLab CI, Azure Pipelines or another service
- fix a job whose clone is shallow
- run reviewer rules in CI without calling a model
- record reviews in CI with the key kept as a secret
- cap the reviewer calls of one run
- review a pull request that changes the law
- add a git hook
- decide where a check may run on a stranger's change
- read the result as JSON, in a script or in annotations of a pull request
- share one law in a team
- merge two branches that both recorded reviews
- resolve a conflict in the verdicts file
- run the same check on Windows and macOS
A monorepo
- use Lawcheck in a monorepo
- run it from a folder inside a package
- understand the error at the top of the monorepo
- give each package its own
runnersetting or reviewer - leave a submodule or a nested repository to its own law
Trouble
- handle a finding I believe is wrong
- waive one line for one rule
- clean up waivers that waive nothing
- list every waiver and the change that added it
- forbid waivers in one kind of file
- see what changes when I take a rule off a type
- find out why a check is slow
- check only some files while I work
- go on after
internalormemory-too-large - understand and fix a code I have not seen
- find the line a law or settings error names
- run Lawcheck where it refuses to start
- see which part of my setup is broken
- find a short answer to a common question