eslint-docs
![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)
Keep your rule names and descriptions up-to-date across your repo
![NPM](https://nodei.co/npm/eslint-docs.png?downloads=true&downloadRank=true&stars=true)
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
✔ 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:
{
"scripts": {
"docs": "eslint-docs",
"docs:check": "eslint-docs check"
}
}
In a Node.js script
const eslintDocs = require('eslint-docs')
eslintDocs(yourProjectDirectory).then(
() => {
},
() => {
}
)
yourProjectDirectory
defaults to the closest directory above process.cwd()
that includes a package.json
License
ISC © Jed Fox