Vertex ESLint Config

This package contains Vertex's sharable config for ESLint. It includes formatting of JS, JSX, TS and TSX files through Prettier.

Usage

Add this package and ESLint as devDependencies to your package.json.

// package.json
{
  "devDependencies": {
    "@vertexvis/eslint-config-vertexvis": "0.0.0",
    "eslint": "^6.1.0"
  }
}

Add a .eslintrc.js file to the root of your project that extends this config.

This package also includes an optional patch file which monkey patches ESLint's module resolution for plugins. ESLint resolves plugins relative to the consuming package. So any plugins referenced by a sharable config will need to NPM installed in the consuming package. There's an open issue and discussion to change this behavior to resolve plugins relative to the imported config's node_modules folder. This shim mimics this behavior.

// .eslintrc.js

// Include the optional patch which resolves ESLint plugins relative to the
// sharable config package.
require('@vertexvis/eslint-config-vertexvis/patch');

module.exports = {
  extends: '@vertexvis/vertexvis',
};