eslint-plugin-vikvikvr

Usage | Rules | Contributing

Custom plugin for ESLint providing several rules for React + Redux projects.

Usage

Install the plugin with npm

npm i eslint-plugin-vikvikvr -D

or Yarn

yarn add eslint-plugin-vikvikvr --dev

then edit your configuration:

// .eslintrc.js
module.exports = {
  extends: ["plugin:eslint-plugin-vikvikvr/recommended"],
  parser: "@typescript-eslint/parser",
  plugins: ["vikvikvr", "@typescript-eslint"],
};

Rules

✔ if the rule is part of the recommended config

🛠 if the rule provides a quick-fix

| | | Name | Description | | --- | --- | ----------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | | ✔ | | if-statement-condition | Enforces condition expressions to be constants | | ✔ | 🛠 | no-app-display-name | Ensures displayName is not set inside the apps/ folder | | ✔ | | no-build-import | Prevents imports from dist or build folders | | ✔ | | no-set-timeout | Ensures setTimeout is not used | | ✔ | 🛠 | no-useless-template-literals | Ensures template literals are only used when truly needed | | ✔ | 🛠 | react-component-type | Ensures consistency while typing React components. | | ✔ | 🛠 | react-hooks-order | Ensures hooks are called in a consistent order | | ✔ | | react-no-boolean-use-memo | Ensures useMemo is not used with simple boolean expressions | | ✔ | | redux-action-type-enum | Ensures redux action types come from enums or object properties | | ✔ | | redux-no-select-whole-state | Ensures useSelector does not select the whole state | | ✔ | | test-name-should | Ensures test names start with the word should | | ✔ | 🛠 | use-translations-scope | Ensures useTranslations contains the longest common scope |

Contributing

Want to join as a developer? Read the contributing guidelines.