Automate docs with eslint-doc-generator

[bmish]

I built this CLI tool eslint-doc-generator 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 already used in many popular ESLint plugins.

[dangreenisrael]

If you want to do a cleanup to remove old rules, could you do that in a separate PR?

[dangreenisrael]

Also, if you felt like upgrading the base image in a separate PR that would be more than welcome as well 😄

[bmish]

@dangreenisrael

If you want to do a cleanup to remove old rules, could you do that in a separate PR?

Removing docs for deleted rules in https://github.com/dangreenisrael/eslint-plugin-jest-formatting/pull/118.

Also, if you felt like upgrading the base image in a separate PR that would be more than welcome as well 😄

What do you mean exactly?

Regarding CI, eslint-doc-generator requires Node >= 14, causing CI to fail when installing deps and running linting on Node 12. I split out the lint job to only run under Node 18 and switched to yarn install --ignore-engines to install dependencies.

[bmish]

Can someone approve CI to run? This is still ready to go in. @dangreenisrael @twelve17 @hockeybuggy

[benkimpel]

@bmish I've approved the CI run, however, I'd like to leave it up to @dangreenisrael to do the merge on this one since this PR could impact how he manages this repo (generating the docs, for example.)

[benkimpel]

@bmish I also rebased this onto latest after merging your other PR.

[dangreenisrael]

Are we still looking to land this?

[bmish]

@dangreenisrael yes still ready to go.