Automate docs with eslint-doc-generator #115
Conversation
bmish
force-pushed
the
eslint-doc-generator
branch
from
c242608
to
7953242
Compare
bmish
force-pushed
the
eslint-doc-generator
branch
from
7953242
to
b0485ca
Compare
* master: Apply suggestions from code review Update package.json explain import bindings case in code comment Update triage_closed_issue_comment.yml fix: Wait incorrectly reported as unsafe to chain fix: Solve unsafe to chain command does not exist (cypress-io#126) chore: heading of no-unnecessary-waiting.md (cypress-io#124) Create triage_closed_issue_comment.yml Create add-issue-triage-board.yml chore: 'unsafe-to-chain-command' added as recommended rule feat: Add 'unsafe-to-chain-command' rule support import bindings in no-unnecessary-waiting rule
|
|
bmish
force-pushed
the
eslint-doc-generator
branch
from
a4e1dfe
to
5d10810
Compare
|
Hi @bmish , our CI was using an older version of node, and was failing. Can you update your forked branch from the latest, and resolve the package-lock conflicts to move this forward? Thank you! |
* master: build(ci): upgrades ci images from node 8 to node 16
|
Merged master and it looks like CI is passing now! |
bmish
force-pushed
the
eslint-doc-generator
branch
from
638673a
to
dbace2d
Compare
|
@jennifer-shehane @cacieprins @mschile @chrisbreiding hey folks, all the tests/lint are now passing, I have signed the CLA, the PR is approved, so I would love to see this merged. |
|
I've been proposing some fixes to this repo lately which have caused conflicts to your PR. There are some more PRs to come, so I suggest waiting with this PR until the repo has become more stable. There are a lot of different interdependencies and breaking changes to deal with right now. |
|
Sure, I can fix the conflicts after those changes, let me know when it's ready! |
|
I'm going to submit a separate PR to implement the doc generator as I have already made quite a lot of underlying changes in various other PRs which have been merged. I don't think it makes sense anymore to try to rebase this old PR due to the multiple conflicts that would need to be resolved. It would just be time-consuming with little benefit. I'm going to close it now. I'll pick out the outstanding features from it and put these into additional PRs. Thanks for your helpful initiative here! |
|
The documents for the I would have liked to have added eslint-doc-generator to this repo and have it run automatically, however I found several issues that dissuaded me from implementing this step:
For the record, I also submitted: |
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 used in many of the top ESLint plugins already.
Also adds eslint-plugin-eslint-plugin and enables eslint-plugin/require-meta-docs-description for ensuring we have consistent descriptions defined in all rules as these are used in the generated documentation.