eslint-docs
Keep your rule names and descriptions up-to-date across your repo
Installation
$ npm install --save-dev eslint-docs
Usage
In the shell
$ eslint-docs✔ docs/rules/no-insecure-random.md is up-to-date✔ docs/rules/no-stateless-class.md is up-to-date✔ docs/rules/promise-must-complete.md is up-to-date✔ README.md is up-to-date $ eslint-docs check # Run this in CI!✔ docs/rules/no-insecure-random.md is valid✔ docs/rules/no-stateless-class.md is valid✔ docs/rules/promise-must-complete.md is valid✔ The README is valid
In package.json:
In a Node.js script
const eslintDocs =
yourProjectDirectory
defaults to the closest directory above process.cwd()
that includes a package.json
License
ISC © Jed Fox