@ssense/tslint-config/README.md

SSENSE's base TSLint configuration

## tslint-config

[![npm version](https://badge.fury.io/js/%40ssense%2Ftslint-config.svg)](https://www.npmjs.com/package/@ssense/tslint-config) [![Build Status](https://travis-ci.org/SSENSE/tslint-config.svg?branch=test_integration)](https://travis-ci.org/SSENSE/tslint-config)

The [tslint](http://palantir.github.io/tslint/) config we use at **SSENSE** for all TypeScript projects. It's a combination of base rules provided by tslint as well as rules from [tslint-microsoft-contrib](https://github.com/Microsoft/tslint-microsoft-contrib).

#### Installation

1. Install the package
    * `npm install --save-dev tslint @ssense/tslint-config`
2. Create a file named *tslint.json* in your project root
    * `touch tslint.json`
3. Add the contents referenced in the section below to *tslint.json*
4. Run **tslint**
    * `./node_modules/.bin/tslint`

#### tslint.json

```json
{
    "extends": "@ssense/tslint-config"
}
```


#### corresponding SSENSE TSLint, TSLint and tslint-microsoft-contrib version

| SSENSE VERSION | TSLint version | tslint-microsoft-contrib version | Typescript version |
| --- | --- | --- | --- |
| **>= 5.x** | >= 5.x | 5.x | >= 2.3.x |
| **>= 4.x** | >= 4.x | 4.x | |
| **>= 2.x** | >= 3.2.x | 2.x | |