eslint-config-segment

eslint-config-segment

Segment's ESLint configurations.

Installation

Install this config package and ESLint:

$ npm install --save-dev eslint segment-eslint-config@"*"

Usage

This set of configs is meant to be extended on a per-project basis as necessary using ESLint's shareable configs feature.

This package includes the following configurations:

• segment
• segment/browser
• segment/node

Examples

A barebones .eslintrc looks like this:

{
  "extends": "segment"
}

If your project is an integration worker, your .eslintrc might look something like this:

{
  "extends": "segment/node"
}

Likewise, if your project is a browser project that exposes the analytics global, your .eslintrc might look something like this:

{
  "extends": "segment/browser",

  "globals": {
    "analytics": true
  }
}

For more details about how shareable configs work, see the ESLint documentation.