Skip to content

Complete rule handbook ​

This handbook evaluates the repository's Flat Config factory. It covers local overrides and rules inherited from ESLint, typescript-eslint, Vue, Import, RegExp, JSONC, React, Angular, and Markdown presets.

  • Documents 441 rules enabled in at least one configuration scope.
  • Also documents 33 explicitly disabled rules so users do not expect reports from them.
  • Error, warning, and disabled scopes come from ESLint.calculateConfigForFile() for representative files.
  • Autofix support comes from meta.fixable; always review the resulting diff.
  • Every rule has explicitly authored incorrect/correct examples. The generator rejects missing, identical, or comment-only examples.
  • Examples preserve intentionally incorrect formatting and are not rewritten by Prettier.
  • Categories list explicit repository rules first, then preset rules; each group is sorted by rule name.
  • Rules disabled only by Prettier compatibility and never enabled by this repository do not count as used rules.

Categories ​

Maintenance ​

In the source SDK repository, run after changing rules or dependencies:

bash
pnpm run docs:rules

The source SDK CI checks generated documentation against the effective configuration with:

bash
pnpm run docs:rules:check