@lego/eslint-config-prettier

LEGO shareable eslint config for js projects

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@lego/eslint-config-prettier
7.1.2a year ago3 years agoMinified + gzip package size for @lego/eslint-config-prettier in KB

Readme

@lego/eslint-config-prettier

Installation

Install this config package:
$ npm i -D @lego/eslint-config-prettier

Usage

Extend your eslint.json, and make sure @lego/eslint-config-prettier has been added, but make sure it's always at the end.
{
  "extends": ["@lego/eslint-config", "@lego/eslint-config-prettier"]
}

with TypeScript:
{
  "extends": ["@lego/eslint-config-typescript", "@lego/eslint-config-prettier"]
}

with TypeScript & React:
{
  "extends": [
    "@lego/eslint-config-typescript",
    "@lego/eslint-config-react",
    "@lego/eslint-config-prettier"
  ]
}

Overriding Rules

With the above eslint.json configuration example, you can still use or override already defined rules as such:
{
  "extends": [
    "@lego/eslint-config-typescript",
    "@lego/eslint-config-react",
    "@lego/eslint-config-prettier"
  ],
  "rules": {
    // eslint-config rules
    "camelcase": "warn",

    // @typescript-eslint/eslint-plugin rules
    "@typescript-eslint/no-useless-constructor": "error",

    // eslint-plugin-react rules
    "react/jsx-child-element-spacing": "error",

    // eslint-plugin-react-hooks rules
    "react-hooks/exhaustive-deps": "warn",

    // eslint-plugin-prettier rules
    "prettier/prettier": [
      "error",
      {
        "singleQuote": false
      }
    ]
  }
}

It's recommended to inspect the defined rule's configurations where the reasoning for the configuration lives. If a configuration could benefit more than just the project you're working on, feel free to create a pull request.