eslint-doc-generator

eslint-doc-generator

Automatic documentation generator for ESLint plugins and rules.

Generates the following documentation based on ESLint and top ESLint plugin conventions:

• README.md rules table
• Rule doc titles and config/fixable/etc. notices

Also performs some basic section consistency checks on rule docs:

• Contains an ## Options / ## Config section and mentions each named option (for rules with options)

Users

This tool is used by popular ESLint plugins like:

• eslint-plugin-ava
• eslint-plugin-ember
• eslint-plugin-eslint-plugin
• eslint-plugin-import
• eslint-plugin-jest
• eslint-plugin-jsx-a11y
• eslint-plugin-promise
• eslint-plugin-qunit
• eslint-plugin-react
• eslint-plugin-unicorn

Motivation

• Standardize documentation across thousands of ESLint plugins and rules
• Improve the discoverability of key rule information and thus rule usability
• Streamline the process of adding new rules by automating part of the documentation
• Eliminate the custom documentation scripts and tests previously built and maintained by many ESLint plugins

Setup

Install it:

npm i --save-dev eslint-doc-generator

Add scripts to package.json:

• Both a lint script to ensure everything is up-to-date in CI and an update script for contributors to run locally
• Add any config options in the update:eslint-docs script only
• Alternative scripts may be needed with build tools or prettier

{
  "scripts": {
    "lint": "npm-run-all \"lint:*\"",
    "lint:docs": "markdownlint \"**/*.md\"",
    "lint:eslint-docs": "npm-run-all \"update:eslint-docs -- --check\"",
    "lint:js": "eslint .",
    "update:eslint-docs": "eslint-doc-generator"
  }
}

Delete any old rules list from your README.md. A new one will be automatically added to your ## Rules section (along with the following marker comments if they don't already exist):

<!-- begin auto-generated rules list -->
<!-- end auto-generated rules list -->

Delete any old recommended/fixable/etc. notices from your rule docs. A new title and notices will be automatically added to the top of each rule doc (along with a marker comment if it doesn't exist yet).

<!-- end auto-generated rule header -->

And be sure to enable the recommended rules from eslint-plugin-eslint-plugin as well as eslint-plugin/require-meta-docs-description to ensure your rules have consistent descriptions for use in the generated docs.

Usage

Run the script from package.json to start out or any time you add a rule or update rule metadata in your plugin:

npm run update:eslint-docs

Example

For examples, see our users or the in-house examples below. Note that the in-house examples intentionally show all possible columns and notices.

Rules list table

See the generated rules table and legend in our example README.md.

Rule doc notices

See the generated rule doc title and notices in our example rule docs no-foo.md, prefer-bar.md, require-baz.md.

Badge

While config emojis are the recommended representations of configs that a rule belongs to (see --config-emoji), you can alternatively define badges for configs at the bottom of your README.md.

Here's a badge for a custom fun config that displays in blue:

[badge-fun]: https://img.shields.io/badge/-fun-blue.svg

And how it looks:

Configuration options

These can be provided as CLI options or as config file options. All options are optional.

There's also an optional path argument if you need to point the CLI to an ESLint plugin directory that isn't just the current directory.

Name	Description
--check	Whether to check for and fail if there is a diff. No output will be written. Typically used during CI.
--config-emoji	Custom emoji to use for a config. Format is config-name,emoji. Default emojis are provided for common configs. To remove a default emoji and rely on a badge instead, provide the config name without an emoji. Option can be repeated.
--ignore-config	Config to ignore from being displayed. Often used for an all config. Option can be repeated.
--ignore-deprecated-rules	Whether to ignore deprecated rules from being checked, displayed, or updated (default: false).
--init-rule-docs	Whether to create rule doc files if they don't yet exist (default: false).
--path-rule-doc	Path to markdown file for each rule doc. Use {name} placeholder for the rule name (default: docs/rules/{name}.md).
--path-rule-list	Path to markdown file where the rules table list should live. Default: README.md. Option can be repeated.
--rule-doc-notices	Ordered, comma-separated list of notices to display in rule doc. Non-applicable notices will be hidden. Choices: configs, deprecated, fixable (off by default), fixableAndHasSuggestions, hasSuggestions (off by default), options (off by default), requiresTypeChecking, type (off by default). Default: deprecated,configs,fixableAndHasSuggestions,requiresTypeChecking.
--rule-doc-section-exclude	Disallowed section in each rule doc. Exit with failure if present. Option can be repeated.
--rule-doc-section-include	Required section in each rule doc. Exit with failure if missing. Option can be repeated.
--rule-doc-section-options	Whether to require an "Options" or "Config" rule doc section and mention of any named options for rules with options (default: true).
--rule-doc-title-format	The format to use for rule doc titles. Defaults to desc-parens-prefix-name. See choices in below table.
--rule-list-columns	Ordered, comma-separated list of columns to display in rule list. Empty columns will be hidden. Choices: configsError, configsOff, configsWarn, deprecated, description, fixable, fixableAndHasSuggestions (off by default), hasSuggestions, name, options (off by default), requiresTypeChecking, type (off by default). Default: name,description,configsError,configsWarn,configsOff,fixable,hasSuggestions,requiresTypeChecking,deprecated.
--split-by	Rule property to split the rules list by. A separate list and header will be created for each value. Example: meta.type.
--url-configs	Link to documentation about the ESLint configurations exported by the plugin.
--url-rule-doc	Link to documentation for each rule. Useful when it differs from the rule doc path on disk (e.g. custom documentation site in use). Use {name} placeholder for the rule name.

--rule-doc-title-format

Where no-foo is the rule name, Disallow use of foo is the rule description, and eslint-plugin-test is the plugin name.

Value	Example
desc	# Disallow use of foo
desc-parens-name	# Disallow use of foo (no-foo)
desc-parens-prefix-name (default)	# Disallow use of foo (test/no-foo)
name	# no-foo
prefix-name	# test/no-foo

Configuration file

There are a few ways to create a config file:

• An object exported by .eslint-doc-generatorrc.js, .eslint-doc-generatorrc.json, or any other config file format/name supported by cosmiconfig
• An object under the eslint-doc-generator key in package.json

Config files support all the CLI options but in camelCase. CLI options take precedence over config file options.

Example .eslint-doc-generatorrc.js:

/** @type {import('eslint-doc-generator').GenerateOptions} */
module.exports = {
  ignoreConfig: ['all'],
};

Compatibility

Build tools

If you have a build step for your code like Babel or TypeScript, you may need to adjust your scripts to run your build before this tool:

{
  "build": "tsc",
  "update:eslint-docs": "npm run build && eslint-doc-generator"
}

prettier

If you use prettier to format your markdown, you may need to adjust your scripts to run prettier formatting after running this tool:

{
  "format": "prettier --write .",
  "lint:eslint-docs": "npm run update:eslint-docs && git diff --exit-code",
  "update:eslint-docs": "eslint-doc-generator && npm run format"
}

Related

• eslint-plugin-eslint-plugin - Linter for ESLint plugins (related list)
• generator-eslint - Generates initial ESLint plugin and rule files but without the sophisticated documentation provided by eslint-doc-generator

Changelog

v0.26.1 (2022-11-25)

:bug: Bug Fix

• #279 Ensure deprecated rule replacement link respects --path-rule-doc (@bmish)
• #280 Fix default rules list path of README.md (@bmish)
• #275 Fix rule links when specifying a rule list file in a subdirectory with --path-rule-list (@bmish)

:house: Internal

• #283 Add empty prettier config (@G-Rath)
• #282 Harden CI workflows (@G-Rath)
• #281 Ensure TypeScript is checked by CodeQL (@G-Rath)
• #278 Enable unicode regexp flag (@G-Rath)

Committers: 2

• Bryan Mishkin (@bmish)
• Gareth Jones (@G-Rath)