@smartive/eslint-config

@smartive/eslint-config

This package provides smartive's default eslint configuration.

Installation

$ npm install eslint @smartive/eslint-config -D

Usage

Create a .eslintrc file in the root of your project's directory (it should live where package.json does). This package offers two different rulesets, on for plain TypeScript applications (@smartive/eslint-config) and a separate one for React applications (@smartive/eslint-config). Your .eslintrc file should look like this:

Plain TypeScript applications

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

React applications

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

NPM scripts

To use eslint add the following to your package.json:

"scripts": {
  "lint": "eslint .",
  "lint:fix": "eslint . --fix"
}

TypeScript configuration

Since there are some rules which require type information please make sure to set up a tsconfig.json configuration file in the root directory of your project. If your TypeScript configuration file is placed in another location you have to configure it using parserOptions.project in your ESLint configuration file. For more information have a look at the typescript-eslint documentation.