Automate docs with eslint-doc-generator #117
Conversation
bmish
force-pushed
the
eslint-doc-generator
branch
4 times, most recently
from
f7179dd to
43737d2
Compare
| "eslint-import-resolver-typescript": "^2.5.0", | ||
| "eslint-plugin-import": "^2.25.3", | ||
| "eslint-plugin-jest": "^25.2.4", | ||
| "eslint-plugin-jest-formatting": "file:.", | ||
| "eslint-plugin-prettier": "^4.0.0", | ||
| "jest": "^27.3.1", | ||
| "prettier": "2.4.1", | ||
| "typescript": "^4.4.4", |
There was a problem hiding this comment.
This looks like an autoformattin and I'm ok with it
There was a problem hiding this comment.
The dependencies were automatically sorted when I ran npm i --save-dev eslint-doc-generator.
|
If you want to do a cleanup to remove old rules, could you do that in a separate PR? |
|
Also, if you felt like upgrading the base image in a separate PR that would be more than welcome as well 😄 |
bmish
force-pushed
the
eslint-doc-generator
branch
6 times, most recently
from
92b3df7 to
4ee2911
Compare
Removing docs for deleted rules in #118.
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 |
bmish
force-pushed
the
eslint-doc-generator
branch
2 times, most recently
from
7bc1c8d to
e0b2bb5
Compare
bmish
force-pushed
the
eslint-doc-generator
branch
2 times, most recently
from
13f7229 to
47f6184
Compare
|
Can someone approve CI to run? This is still ready to go in. @dangreenisrael @twelve17 @hockeybuggy |
|
@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
force-pushed
the
eslint-doc-generator
branch
from
47f6184 to
be079e7
Compare
|
@bmish I also rebased this onto latest after merging your other PR. |
bmish
force-pushed
the
eslint-doc-generator
branch
from
be079e7 to
c790adc
Compare
bmish
force-pushed
the
eslint-doc-generator
branch
from
c790adc to
a6c39b3
Compare
|
Are we still looking to land this? |
|
@dangreenisrael yes still ready to go. |
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.