Readme.md

eslint-config-segment

Segment's ESLint configurations.

Installation

Install this config package and ESLint:

$ npm install --save-dev eslint eslint-config-segment

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"
}

Is your test suite throwing all sorts of Mocha-related errors? Throw this in your test/.eslintrc (it'll inherit all your root .eslintrc settings, so no need to duplicate them here):

{
  "env": {
    "mocha": true
  }
}

If your project is a Node project, 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 complex/real examples, see the examples folder.

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