eslint-docs

Keep your rule names and descriptions up-to-date across your repo

Installation

1$ npm install --save-dev eslint-docs

Usage

In the shell

1$ eslint-docs
2✔ docs/rules/no-insecure-random.md is up-to-date
3✔ docs/rules/no-stateless-class.md is up-to-date
4✔ docs/rules/promise-must-complete.md is up-to-date
5✔ README.md is up-to-date
6
7$ eslint-docs check # Run this in CI!
8✔ docs/rules/no-insecure-random.md is valid
9✔ docs/rules/no-stateless-class.md is valid
10✔ docs/rules/promise-must-complete.md is valid
11✔ The README is valid

In package.json:

1{
2  "scripts": {
3    "docs": "eslint-docs",
4    "docs:check": "eslint-docs check"
5  }
6}

In a Node.js script

1const eslintDocs = require('eslint-docs')
2
3eslintDocs(yourProjectDirectory).then(
4  () => {
5    // Everything went OK!
6  },
7  () => {
8    // Something went wrong!
9    // Currently, you’ll have to ask the user to look at the terminal. sorry :(
10  }
11)

yourProjectDirectory defaults to the closest directory above process.cwd() that includes a package.json

License

ISC © Jed Fox