@muffin-dev/tslint-config/README.md

TSLint module recommended configuration for Muffin Dev projects.

# Muffin Dev - TS Lint Config

This module contains a simple JSON file that you can use as an `extends` entry in `tslint.json` file of your projects.

Most of *Muffin Dev* projects use that configuration.

## Installation

```bash
npm i @muffin-dev/tslint-config --save-dev
```

## Use the configuration

In your `tslint.json` file, add `@muffin-dev/tslint-config` entry to `extends` array. example:

```json
{
    "defaultSeverity": "error",
    "extends": [
        "tslint:recommended",
        "@muffin-dev/tslint-config"
    ],
    "jsRules": {},
    "rules": {},
    "rulesDirectory": []
}
```

And that's it! Note that you can still define rules, and they will override all your `extends` configurations.