eslint-plugin-react-hooks-docs
🚨 Eslint plugin to enforce react hooks documentation.
Built with ❤︎ by Ahmed Tokyo
Installation
npm i eslint eslint-plugin-react-hooks-docs --save-dev
OR
yarn add -D eslint eslint-plugin-react-hooks-docs --save-dev
Usage
Add react-hooks-docs
to the plugins section of your .eslintrc
configuration file. You can omit the eslint-plugin-
prefix:
{
"plugins": ["react-hooks-docs"]
}
Then configure the rules you want to use under the rules section.
{
"rules": {
"react-hooks-docs/docs": [
2,
{
"skipDeclarations": true,
"skipHooks": [
"useCustomEffect"
]
}
]
}
}