@poool/eslint-plugin

Custom set of ESLint rules we need and enforce at Poool

Installation

yarn add eslint @poool/eslint-plugin --dev

Usage

Load the plugin in your .eslintrc.json file:

{
  "plugins": ["@poool/eslint-plugin"]
}

Finally, enable all the rules you would like to use (don't forget to disable the corresponding core rule!):

{
  "rules": {
    "no-extra-parens": "off",
    "@poool/no-extra-parens": "error",
    "no-unneeded-ternary": "off",
    "@poool/no-unneeded-ternary": "error"
  }
}

Rules

| Name | Description | Docs | | ---- | ----------- | ------- | | @poool/camelcase | camelcase, but doesn't complain about optional chaining | documentation | | @poool/no-extra-parens | no-extra-parens, but allows conditional spreads to be wrapped with parentheses | documentation | | @poool/no-unneeded-ternary | no-unneeded-ternary, but with an extra condition to disallow ternary expressions as expression statements | documentation |

Shareable configurations

Recommended

This plugin exports a recommended configuration that enforces some of our rules.
To enable this configuration use the extends property in your .eslintrc.json config file:

{
  "extends": ["plugin:@poool/eslint-plugin/recommended"]
}