@cto.af/generate-rules-table

Generate a rules table in a eslint plugin's README.md.

If anyone else wants to use this, I'll write some more docs.

Installation

npm install -D @cto.af/generate-rules-table
npx generate-rules-table

README.md Comments

Ensure you have a README.md next to your package.json file. It MUST include the following comments:

<!-- Rule Table Start -->
<!-- Rule Table End -->

The space between these comments will be filled in with a rules table.

---