README.md

eslint-plugin-hooks

A simple organizer for ordering hooks.

_{Built with ❤︎ by hiukky}

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install eslint-plugin-hooks:

$ npm install eslint-plugin-hooks --save-dev

Usage

Add hooks to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
  "plugins": ["hooks"]
}

Then configure the rules you want to use under the rules section.

{
  "rules": {
    "hooks/sort": [
      2,
      {
        "groups": [
          "useReducer",
          "useContext",
          "useState",
          "useRef",
          "useDispatch",
          "useCallback",
          "useEffect"
        ]
      }
    ]
  }
}