@web-configs/eslint-plugin

ThunderMiracle’s ESLint rules and configs.

Installation

You'll first need to install ESLint:

With Yarn

yarn add --dev eslint

With npm

$ npm i eslint --save-dev

Next, install @web-configs/eslint-plugin:

With Yarn

yarn add --dev @web-configs/eslint-plugin

With npm

$ npm install @web-configs/eslint-plugin --save-dev

Note: If you installed ESLint globally (using the -g flag) then you must also install @web-configs/eslint-plugin globally.

Usage

ThunderMiracle’s ESLint configs come bundled in this package. In order to use them, you simply extend the relevant configuration in your project’s .eslintrc. For example, the following will extend the ESNext (ES2015 and later) config:

{
  "extends": "plugin:@web-configs/esnext"
}

If you are working on an ES5 project, extend the ES5 version of the configuration:

{
  "extends": "plugin:@web-configs/es5"
}

You can also add some "augmenting" configs on top of the "core" config by extending an array of linting configs. For example, the following configuration would provide a base ESNext config that is augmented by a React config:

{
  "extends": [
    "plugin:@web-configs/esnext",
    "plugin:@web-configs/react"
  ]
}

Likewise, if you are using TypeScript and React, the following configuration extends the TypeScript base config with the React-specific rules provided by the React configuration file. To demonstrate multiple augmentations, we've also added the Prettier config, which disables rules that will conflict in projects using prettier.

{
  "extends": [
    "plugin:@web-configs/typescript",
    "plugin:@web-configs/react",
    "plugin:@web-configs/prettier",
  ]
}

Provided configurations

This plugin provides the following core configurations:

• esnext: Use this for anything written with ES2015+ features.
• typescript: Use this for Typescript projects. The rules enabled in this confige do not require type-checking to run. To enable all Typescript rules, you must augment this config with the typescript-type-checking config mentioned below.
• es5: Use this for legacy projects.

This plugin also provides the following tool-specific configurations, which can be used on top of the core configurations:

• typescript-type-checking Use this config to augment the typescript config to enable all TypeScript rules, including those that require type checking. These rules are slower to run and and you will need to specify a path to your tsconfig.json file in the "project" property of "parserOptions". The following example would provide all of the TypeScript rules, assuming the tsconfig.json is in the same directory as you ESlint configuration.

{
  "extends": [
    "plugin:@web-configs/typescript",
    "plugin:@web-configs/typescript-type-checking"
  ],
  "parserOptions": {
    "project": "tsconfig.json"
  }
}

• react: Use this for React projects.
• graphql: Use this for projects that use graphql-config for graphql validation.
• prettier: Use prettier for consistent formatting. Extending this ThunderMiracle's prettier config will override the default ThunderMiracle eslint rules in favor of prettier formatting. Prettier must be installed within your project, as @web-configs/eslint-plugin does not provide the dependency itself.

node

If you are working on a node module, we also provide the node configuration for you. Note that this configuration needs to be used in conjunction with one of the core configurations (either es5 or esnext). If you plan to transpile your code using Babel, use the esnext config. If you do not plan to do so, the config you choose depends on the version of node you wish to support, and how many ESNext features are natively available in that version. You can see a detailed list of what version of node supports what new JavaScript features by visiting http://node.green.

A node project that will use Babel for transpilation would need the following ESLint config:

{
  "extends": [
    "plugin:@web-configs/esnext",
    "plugin:@web-configs/node"
  ]
}

Supported Typescript version

The supported version of TypeScript is constrained by the @typescipt-eslint parser support that is installed.