Developer docs
This section is for contributors and advanced users.
Quick navigationâ
- ð API Overview
- ð§ Architecture Decisions (ADR)
- ð Architecture and operations charts
- 𧎠Typed service path inventory
- ð§ Type aliases reference
- âïļ Runtime exports reference
Maintainer operations guidesâ
- Maintainer performance profiling with
--stats - CLI debugging and config inspection (
--print-config, cache, strict flags) - IDE integration (VS Code)
- Node.js ESLint API usage
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 public type aliases and related TypeScript surfaces.
- Runtime: Generated API pages for runtime exports and internal helper modules.
- Links (sidebar bottom): Project resources, releases, blog pages, and 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.
Generated API pages under developer/api/* are build output, not hand-authored docs source.
- Do not manually add or edit Markdown under
docs/docusaurus/site-docs/developer/api/**. - Put hand-authored API explainers in tracked developer docs such as
docs/docusaurus/site-docs/developer/**. - From those tracked docs, link back into the generated API routes such as
./api/plugin/type-aliases/SdlPluginWithConfigs.mdand./api/plugin/variables/sdlPlugin.md.
To regenerate it locally:
npm run docs:api
From the repository root, you can also run:
npm run docs:build
That command loads rule docs directly from docs/rules, generates TypeDoc output, and builds the Docusaurus site.