@abstracter/eslint-config v1.0.0

eslint-config

Common eslint configuration for common env/stacks

Install

npm install --save-dev eslint @abstracter/eslint-config eslint-plugin-import eslint-plugin-node eslint-plugin-promise

Usage

Javascript

A general config for javascript (no rules for a specific environment or stack)

eslint config example:

{
  "extends": "@abstracter/eslint-config/javascript"
}

This config depends on:

• eslint-config-standard
• eslint-plugin-node
• eslint-plugin-import
• eslint-plugin-promise

TypeScript

A config for code written in TypeScript.

eslint config example:

{
  "extends": "@abstracter/eslint-config/typescript"
}

This config requires:

• @typescript-eslint/parser
• @typescript-eslint/eslint-plugin

Make sure to install:

npm install --save-dev @typescript-eslint/parser @typescript-eslint/eslint-plugin

Browser

A config for code expected to run in a browser environment.

eslint config example:

{
  "extends": ["@abstracter/eslint-config/browser"]
}

Node.js

A config for code expected to run in a node environment.

eslint config example:

{
  "extends": ["@abstracter/eslint-config/node"]
}

This config uses eslint-plugin-node recommend config.

JSX

A config for code written in JSX.

eslint config example:

{
  "extends": ["@abstracter/eslint-config/jsx"]
}

React

A config for code written using React.

eslint config example:

{
  "extends": ["@abstracter/eslint-config/react"]
}

The config uses eslint-plugin-react-hooks recommend config.

Make sure to install:

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

Jest

A config for code which uses Jest.

eslint config example:

{
  "extends": ["@abstracter/eslint-config/jest"]
}

This config uses eslint-plugin-jest recommended config.

TypeScript Node.js

A config for code which uses TypeScript & Node.js

This config turns off redundant eslint-plugin-node rules when using typescript.

eslint config example:

{
  "extends": ["@abstracter/eslint-config/typescript-node"]
}

This config requires the same dependencies as TypeScript and Node.js.

Make sure to install:

npm install --save-dev eslint-plugin-jest

Mix & Match configs

Use more than a single config to achieve a multipurpose config.

Using TypeScript, React and Jest:

{
  "extends": [
    "@abstracter/eslint-config/typescript",
    "@abstracter/eslint-config/react",
    "@abstracter/eslint-config/jest"
  ]
}