npm / eslint-doc-generator
eslint-doc-generator
What changed in eslint-doc-generator 2 to 3, from its official release notes, upgrade guides and advisories. Sources checked 2026-10-19.
3 breaking7 new APIs and options3 behavior and defaults5 fixes and other
See which of these apply to your code, ranked, in your agent:
npx @unstale/cli initeslint-doc-generator 316 changes
Breaking changes 3
Line endings are determined per file using EditorConfig, existing content, then os.EOL.
The implicit config badge fallback is removed.
Node 20, 22, or 24+ is now required.
New APIs and options 6
Adds a description option to ruleListSplit.
MDX files are now supported.
Adds a framework option with support for Starlight.
Rule meta.deprecated supports the new DeprecatedInfo format.
Adds AI-powered config emoji suggestions.
Adds AI-powered config emoji suggestions.
Behavior and default changes 3
Rule option defaults are now taken from meta.defaultOptions, with schema defaults used as a fallback.
The base config now has a default emoji.
The default rule documentation title and notices now separate the rule name from its description.
Fixes and other changes 4
Globally enabled rules are no longer documented as disabled because of file-scoped overrides.
Frontmatter is treated as an H1 in the rule-list when the framework is starlight.
The minimum supported Node.js 22 version is lowered from 22.13.1 to 22.13.0.
The rule doc notice for the description should come first.
eslint-doc-generator 22 changes
New APIs and options 1
The plugin name can be received via plugin metadata.
Fixes and other changes 1
The prettier peer dependency is optional, so users do not need to install it as a peer dependency.