Skip to content
This repository has been archived by the owner on Mar 29, 2020. It is now read-only.

anvilabs/tslint-config

Repository files navigation

@anvilabs/tslint-config

Version Build Status Dependency Status devDependency Status semantic-release

Anvilabs' TSLint config, designed to be used in conjunction with ESLint and our shareable ESLint configs. Includes mostly TS-specific rules taking advantage of TSLint's ability to work with the type checker.

Usage

Install the package as a development dependency:

$ yarn add typescript tslint @anvilabs/tslint-config --dev
# or
$ npm install typescript tslint @anvilabs/tslint-config --save-dev

Then create a tslint.json file in the root of your project:

{
  "extends": "@anvilabs/tslint-config"
}

New rules may be added or existing ones modified like so:

{
  "extends": "@anvilabs/tslint-config",
  "rules": {
    // your overrides
  }
}

Tips

It is recommended to use the TypeScript language service plugin for TSLint to ensure easier integration with different code editors.

License

MIT License © Anvilabs LLC