# What changed in eslint-doc-generator

> 18 changes in eslint-doc-generator 2 to 3 from its official release notes, upgrade guides and advisories: 3 breaking, 7 new APIs and options. Each one cited. Sources checked 2026-10-19. HTML: https://unstale.sh/npm/eslint-doc-generator/

To see which of these apply to a repository, run `npx @unstale/cli init` in it.

## eslint-doc-generator 3

### Breaking changes

- Line endings are determined per file using EditorConfig, existing content, then os.EOL. (3.7.0) — [release notes](https://github.com/eslint-community/eslint-doc-generator/releases/tag/v3.7.0)
- The implicit config badge fallback is removed. (3.0.0) — [release notes](https://github.com/eslint-community/eslint-doc-generator/releases/tag/v3.0.0)
- Node 20, 22, or 24+ is now required. (3.0.0) — [release notes](https://github.com/eslint-community/eslint-doc-generator/releases/tag/v3.0.0)

### New APIs and options

- Adds a description option to ruleListSplit. (3.6.0) — [release notes](https://github.com/eslint-community/eslint-doc-generator/releases/tag/v3.6.0)
- MDX files are now supported. (3.5.0) — [release notes](https://github.com/eslint-community/eslint-doc-generator/releases/tag/v3.5.0)
- Adds a framework option with support for Starlight. (3.4.0) — [release notes](https://github.com/eslint-community/eslint-doc-generator/releases/tag/v3.4.0)
- Rule meta.deprecated supports the new DeprecatedInfo format. (3.3.0) — [release notes](https://github.com/eslint-community/eslint-doc-generator/releases/tag/v3.3.0)
- Adds AI-powered config emoji suggestions. (3.2.0) — [release notes](https://github.com/eslint-community/eslint-doc-generator/releases/tag/v3.2.0)
- Adds AI-powered config emoji suggestions. (3.2.0) — [release notes](https://github.com/eslint-community/eslint-doc-generator/releases/tag/v3.2.0)

### Behavior and default changes

- Rule option defaults are now taken from meta.defaultOptions, with schema defaults used as a fallback. (3.1.0) — [release notes](https://github.com/eslint-community/eslint-doc-generator/releases/tag/v3.1.0)
- The base config now has a default emoji. (3.0.0) — [release notes](https://github.com/eslint-community/eslint-doc-generator/releases/tag/v3.0.0)
- The default rule documentation title and notices now separate the rule name from its description. (3.0.0) — [release notes](https://github.com/eslint-community/eslint-doc-generator/releases/tag/v3.0.0)

### Fixes and other changes

- Globally enabled rules are no longer documented as disabled because of file-scoped overrides. (3.7.1) — [release notes](https://github.com/eslint-community/eslint-doc-generator/releases/tag/v3.7.1)
- Frontmatter is treated as an H1 in the rule-list when the framework is starlight. (3.5.0) — [release notes](https://github.com/eslint-community/eslint-doc-generator/releases/tag/v3.5.0)
- The minimum supported Node.js 22 version is lowered from 22.13.1 to 22.13.0. (3.3.2) — [release notes](https://github.com/eslint-community/eslint-doc-generator/releases/tag/v3.3.2)
- The rule doc notice for the description should come first. (3.0.1) — [release notes](https://github.com/eslint-community/eslint-doc-generator/releases/tag/v3.0.1)

## eslint-doc-generator 2

### New APIs and options

- The plugin name can be received via plugin metadata. (2.4.0) — [release notes](https://github.com/eslint-community/eslint-doc-generator/releases/tag/v2.4.0)

### Fixes and other changes

- The prettier peer dependency is optional, so users do not need to install it as a peer dependency. (2.4.0) — [release notes](https://github.com/eslint-community/eslint-doc-generator/releases/tag/v2.4.0)