@terminus/frontend-lint-config v0.0.0-PLACEHOLDER

Terminus lint Configurations

A collection of extendable lint configurations created for Terminus.

Installation

1. Install the NPM package:

$ yarn add @terminus/frontend-lint-config -D

2. Extend this package in your project:

// your project's .eslintrc.js
module.exports = {
  extends: ["@terminus/frontend-lint-config"],
  parserOptions: {
    ecmaVersion: 6,
    // This should point to your primary tsconfig.json
    project: "./tsconfig.json",
    sourceType: "module"
  }
}

Configurations

Available configurations:

ci

The default ruleset is the strictest and best suited to be run during CI process'. Even stylistic issues are marked as errors because the only way the issue has made it all the way to CI is because someone did not run the linter during development.

ci.js src

development

This ruleset extends the ci ruleset but softens the rules to turn many stylistic issues into warnings in order to not impede development.

Target the development ruleset:

// your project's .eslintrc.js
module.exports = {
  extends: ["@terminus/frontend-lint-config/development"],
  parserOptions: {
    ecmaVersion: 6,
    // This should point to your primary tsconfig.json
    project: "./tsconfig.json",
    sourceType: "module"
  }
}

development.js src

testing

This ruleset extends the development ruleset but softens the rules further to allow more freedom in spec files.

Target the testing ruleset:

// your project's .eslintrc.js
module.exports = {
  extends: ["@terminus/frontend-lint-config/testing"],
  parserOptions: {
    ecmaVersion: 6,
    // This should point to your primary tsconfig.json
    project: "./tsconfig.json",
    sourceType: "module"
  }
}

testing.js src

Reasoning

Each rule is accompanied by a comment outlining the reasoning behind the decision to include the rule.

For most rules, see ci.js.