This repository is a neutral reference for agents introducing automated TypeScript checks and implementation guidance. Its goal is to replace routine line-by-line human review with strong, agent-executable verification while keeping architecture and critical decisions visible to people.
Read the automation-first operating model for the reasoning behind the checks. The repository is organized by how an agent should use each artifact, not as a collection of publishable packages.
| Area | Agent action | Contents |
|---|---|---|
rules/oxlint |
Copy selected rules and adapt their options | Syntax rules, profiles, built-in policy, and positive/negative tests |
rules/typed |
Copy the engine or selected rules, then configure discovery | Compiler API rules, file rules, CLI behavior, and tests |
scripts/diff-check |
Copy and adapt | Added-lines-only review checks and key-file alerts |
scripts/rule-catalog |
Reference | The local model and generator that keep registries and docs synchronized |
examples/configuration |
Copy, then adapt | TypeScript, Oxfmt, and typed-lint configuration patterns |
examples/testing |
Copy, then adapt | Vitest and Playwright policy with neutral examples |
examples/tailwind-smoke |
Copy, then adapt paths | Tailwind compilation smoke check |
docs and .codex/skills |
Read for judgment | Profiles, extraction recipes, testing policy, and implementation guidance |
Start with extracting a pattern. The architecture guide explains why rule code, scripts, examples, and guidance have separate homes.
- Add or change an OXLint rule: the rule recipe
- Introduce type-aware checks:
rules/typed - Establish unit, integration, or browser tests: testing patterns
- Establish formatting or Tailwind validation: formatting and CSS patterns
- Understand the verification philosophy: automation-first operating model
- Choose an applicable lint bundle: profile guidance
- Inspect every automated rule: generated rule catalog
The root scripts validate this reference repository; they are not an adoption template.
npm run verifyAdded-lines checks remain deliberately separate because they answer a review-specific question:
npm run diff:check -- --base origin/mainNever edit docs/generated/rule-catalog.md by hand. Change rule metadata and
run npm run docs:generate.