@igloosoftware/eslint-config-igloo

eslint-config-igloo

Igloo ESLint configurations

 

Prerequisites

ESLint

 

Installation

Install the following packages as devDependencies:

npm install @igloosoftware/eslint-config-igloo eslint --save-dev

Then just reference the package in your projects package.json:

"@igloosoftware/eslint-config-igloo": "latest"

Notice the eslint dependency.

 

Usage

This package includes the following complete and ready to use configurations:

 

The base set of configurations. Most often not directly used, instead is meant to be extended from.

@igloosoftware/igloo

 

Project Setup

To consume just add the extends attribute to your .eslintrc within your project's root.

ES5

The core set of ES5 configurations. Extends @igloosoftware/eslint-config-igloo.

{
  "extends": "@igloosoftware/igloo/es5"
}

ESNext

The core set of ESNext configurations. Extends @igloosoftware/eslint-config-igloo.

{
  "extends": "@igloosoftware/igloo/next"
}

React

The core set of React configurations. Extends @igloosoftware/eslint-config-igloo/next.

{
  "extends": "@igloosoftware/igloo/react"
}

Node

The core set of Node configurations. Extends @igloosoftware/eslint-config-igloo/next.

{
  "extends": "@igloosoftware/igloo/node"
}

 

Customized Setup

If you need to override specific rules within your project, you can do so like this:

{
  "extends": "@igloosoftware/igloo/next",
  "rules": {
    "no-console": 0
  }
}