Essent TSLint Angular

This repository holds the base configuration file to use for tslint based on angular project setup. The tslint rules are an extend on mgechev/tslint-angular.

Installation

First you need to add this package as a dependency for your project

npm install --save-dev @essent/tslint-angular

Also there is offcourse the dependency with tslint itself and codelyzer. If this is not added to your project or provided by the angular CLI, add these as well.

npm install --save-dev tslint codelyzer

After this you need to add tslint.json in the root of your project and change this file to extend this package linting rules

{
  "extends": ["@essent/tslint-angular"],
  "rules": {
    "directive-selector": [true, "attribute", "foo", "camelCase"],
    "component-selector": [true, "element", "foo", "kebab-case"]
  }
}

Notice that directive-selector and component-selector are configurable so you need to add them manually in the rules section of tslint.json.

Additional rules

In case you are in need for specific rules for your project or have good reasons to override some of the rules set by the configuration this package provides you, rules can be easily overridden in tslint.json in the rules section.

Changelog