README.md

Pangolin.js ESLint Config

Shareable ESLint configuration for Pangolin.js based on eslint-config-standard.

Installation

Install the configuration and all peer dependencies with one command:

npm install --save-dev @pangolinjs/eslint-config eslint eslint-config-standard

Usage

Create a config

Create an ESLint configuration either as a JSON or a JavaScript file:

.eslintrc.json

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

.eslintrc.js

module.exports = {
  extends: [
    '@pangolinjs/eslint-config',
  ],
}

Modifying config and rules

Overwrite rules from the default config:

JSON configuration file

{
  "extends": [
    "@pangolinjs/eslint-config"
  ],
  "rules": {
    "no-warning-comments": "error"
  }
}

JavaScript configuration file

module.exports = {
  extends: [
    '@pangolinjs/eslint-config',
  ],
  rules: {
    'no-warning-comments': 'error',
  },
}

ESLint has an extensive list of rules. Additional rules are provided by the following plugins:

• eslint-plugin-import
• eslint-plugin-n
• eslint-plugin-promise