Skip to main content

Developer docs

This section is for contributors and advanced users.

Quick navigationโ€‹

Maintainer operations guidesโ€‹

Section mapโ€‹

  • API Overview: Entry point for generated TypeDoc, including internal and plugin exports.
  • Architecture Decisions: ADRs that explain major architectural choices and policy tradeoffs.
  • Charts: Visual diagrams for lifecycle, release, docs synchronization, and diagnostics workflows.
  • Types: Generated API pages for type aliases and type-level contracts.
  • Runtime: Generated API pages for runtime exports and internal helper modules.
  • Links (sidebar bottom): Upstream package references, blog pages, and open issue tracker.

Architecture decisions (ADR)โ€‹

Architecture and operations chartsโ€‹

  • Charts index
  • System architecture overview
  • Rule lifecycle and autofix flow
  • Docs and API pipeline
  • Rule catalog and docs synchronization
  • Change impact and validation matrix
  • Quality gates and release flow
  • Typed rule semantic analysis flow
  • Import-safe autofix decision tree
  • Preset composition and rule matrix
  • Docs link integrity and anchor stability
  • Typed rule performance budget and hotspots
  • Diagnostics and regression triage loop
  • Preset semver and deprecation lifecycle
  • Rule authoring to release lifecycle
  • Typed services guard and fallback paths

Use the Charts section in the Developer sidebar to open these pages.

API referenceโ€‹

The Developer API subsection is generated by TypeDoc from src/plugin.ts.

To regenerate it locally:

npm run docs:api

From the repository root, you can also run:

npm run docs:build

That command now validates the docs site contract, loads rule docs directly from docs/rules, generates TypeDoc output, and builds the Docusaurus site.