Automate docs with eslint-doc-generator

[bmish]

What Changed

eslint-doc-generator is a CLI tool I built for automating the generation of the README rules list table and rule doc title/notices for ESLint plugins. It follows common documentation conventions from this and other top ESLint plugins and will help us standardize documentation across ESLint plugins (and generally improve the usability of custom rules through better documentation and streamline the process of adding new rules). It has 100% test coverage and is used in many of the top ESLint plugins already. It replaces the existing documentation generation scripts in this repository.

Notable differences:

• Improved documentation aesthetics
• The readme rules table and rule doc notices now reveal additional information including what severity a config sets a rule to and whether a rule provides suggestions
• Rule doc titles are more consistent as they are now generated from the rule metadata
• Ensures rule docs mention rule options
• Ensure lint and this doc generator pass on CI

Checklist

Check the ones applicable to your change:

• [x] Ran yarn update-all
• [x] Tests are updated
• [x] Documentation is updated

Change Type

Indicate the type of change your pull request is:

• [x] documentation

[yannbf]

Hey @bmish I appreciate the contribution! Your tool seems pretty cool, but I think the resulting README looks much more confusing than the original one.

[bmish]

Okay, fair enough, I'll close it then. Just want to note a few differences:

• The new version distinguishes when a config enables a rule vs. sets it to warn
• The new version indicates when a rule provides suggestions
• And this info is all included in both the readme rules table and rule doc

The new rules table would generally look more aesthetic if an emoji was chosen for each config. Since it's hard to represent these configs with emojis, I used badges instead for now, so we end up with a mix of emojis and badges in the table.

[yannbf]

Indeed! I'll keep an eye out in your tool, maybe it could be used here in the future. Thank you so much for your time and contribution! <3