@lego/tslint-config

Purpose

This is an opinionated all-round configuration. It includes the configuration for @lego/tslint-config-prettier so you don't need to add that one separately.

Installation

Install this config package:

$ npm i -D @lego/tslint-config

You don't need to install prettier or tslint as it is included. Reasoning is that we match the ruleset of tslint for its respective version. Adding your own tslint would create conflicts.

If you however want to add your own tslint should this configuration lag behind, you can refer to the usage 'overriding rules' to extend the rule definition default in your own tslint.json file.

Usage

Extend your tslint.json, and make sure @lego/tslint-config has been added:

{
  "extends": ["@lego/tslint-config"]
}

Rules

This package currently implements rules from the following tslint extensions:

• https://github.com/palantir/tslint
• https://github.com/ajafff/tslint-consistent-codestyle
• https://github.com/chinchiheather/tslint-lines-between-class-members

Overriding Rules

With the above tslint.json configuration example, you can still use or override already defined rules as such:

{
  "extends": "@lego/tslint-config",
  "rules": {
    "no-submodule-imports": [true, "mobx", "mobx-react"]
  }
}

It's recommended to inspect the defined rule's configurations where the reasoning for the configuration lives. If a configuration could benefit more than just the project you're working on, feel free to create a pull request.