rdy / eslint-config-callstack

ESLint preset extending Flow, Prettier and Jest

eslint-config-callstack

Callstack ESLint config utilizing Flow/TypeScript, Prettier, Jest, React and React Native.

Plugins and configs used:

• Default config (w/ React and React Native):
  • Node config
  • eslint-plugin-react
  • eslint-plugin-react-native
  • eslint-plugin-react-hooks
• Node config:
  • eslint-config-prettier
  • eslint-plugin-prettier
  • eslint-plugin-jest (applied for tests only, based on Jest's testMatch config)
  • eslint-plugin-import
  • eslint-plugin-promise
  • eslint-plugin-flowtype
  • @typescript-eslint/eslint-plugin

Additionally, it sets these environments:

Default config:

{
  "env": {
    "es6": true,
    "node": true,
    "react-native/react-native": true
  }
}

Node config:

{
  "env": {
    "es6": true,
    "node": true
  }
}

Installation

yarn add --dev eslint @callstack/eslint-config

Note: We're using yarn to install deps. Feel free to change commands to use npm 3+ and npx if you like

Usage

Add to your ESLint config (.eslintrc, or eslintConfig field in package.json):

{
  "extends": "@callstack"
}

or for Node.js projects:

{
  "extends": "@callstack/eslint-config/node"
}

Example of extending the configuration

{
  "extends": "@callstack",
  "rules": {
    "global-require": 0,
    "prefer-destructuring": 0
  }
}

TypeScript

In order to use this config in TypeScript project make sure you have installed following dependencies:

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

Then when running ESLint add --ext '.js,.ts' (you might need also .jsx, .tsx) option, for example:

yarn eslint --ext '.js,.ts' ./src