eslint-plugin-react-hooks-docs

🚨 Eslint plugin to enforce react hooks documentation.

Installation

npm i eslint eslint-plugin-react-hooks-docs --save-dev

OR

yarn add -D eslint eslint-plugin-react-hooks-docs

Usage

Extending recommended configuration

You can extend the recommended configuration by adding 'plugin:eslint-plugin-react-hooks-docs/recommended' to the extends array in your eslintrc.

extends: ['plugin:eslint-plugin-react-hooks-docs/recommended'],

Manually applying the rules

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. Note that the 2nd param is optional extra configurations.

{
  "rules": {
    "react-hooks-docs/docs": [
      2,
      {
        "skipDeclarations": true,
        "skipHooks": []
      }
    ]
  }
}

Rules

docs

Enforces documentation to exist in the form of a comment for react hooks calls.

Options:

• skipDeclarations: boolean - doesn't enforce the rule on hook declarations eg: const [state, setState] = useState(0);.
• skipHooks: Array - doesn't enforce the rule on the hooks passed to in this array eg: useCustomHook

_{Built with ❤︎ by Ahmed Tokyo}