# tslint-webpack-plugin

[![npm version](https://badge.fury.io/js/tslint-webpack-plugin.svg)](http://badge.fury.io/js/tslint-webpack-plugin)
[![license](https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000)]()

[![NPM](https://nodei.co/npm/tslint-webpack-plugin.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/tslint-webpack-plugin/)

*Due to [TSLint being deprecated](https://github.com/palantir/tslint/issues/4534), consider using/migrating to [@typescript-eslint](https://github.com/typescript-eslint/typescript-eslint)*

This is a [webpack](http://webpack.github.io/) plugin that provides a very simple method of running TSLint alongside your webpack builds.
This project differs from [tslint-loader](https://github.com/wbuchwalter/tslint-loader) in that it will lint all specified files instead of only
those that are imported by webpack. This is especially useful for interface files that are not always picked up by webpack (due to treeshaking or whatever).

Installation
------------
This plugin also requires [TSLint](https://github.com/palantir/tslint) to be installed.

Install the plugin with npm:
```shell
$ npm install tslint tslint-webpack-plugin --save-dev
```

Basic Usage
-----------

The plugin will output tslint errors as part of your webpack build process. It will not fail the build, but simply notify you of changes that need to be made.
Just add the plugin to your webpack config as follows:

```javascript
var TSLintPlugin = require('tslint-webpack-plugin');
var webpackConfig = {
  entry: 'index.js',
  output: {
    path: 'dist',
    filename: 'index_bundle.js'
  },
  plugins: [
    new TSLintPlugin({
      files: ['./src/**/*.ts']
    })
  ]
};
```

Configuration
-------------
You can pass a hash of configuration options to `TSLintWebpackPlugin`.

The basic configuration requires the one of the following:

- `files: string | string[]` The files to run through the linter.
  - Examples
    - `'./src/**/*.ts'`
    - `['./src/**/*.ts', './test/**/*.spec.ts']`
    - `'./src/main.ts'`
    - `['./src/main.ts', './test/main.spec.ts']`

- `project: string` Path to tsconfig.json

Use a custom tslint.json config

- `config: ./tslint.json`

Disable console output if necessary:

- `silent: true`

Add the errors and warnings to the webpack compilation result and stats and wait for the linter to finish. This is useful when you create production builds on your build server and you do not want that tslint errors will go to production. Do not set it to true when you use webpack-dev-server because usually incremental builds are much faster than linting for large projects.

- `waitForLinting: true`

Treats all errors as warnings:

- `warningsAsError: true`

The plugin uses a custom formatter by default, but any of the built-in TSLint formatters can be used. (**Not supported by v2 and later**)
- `format: string`
  - Examples
    - `stylish`
    - [More supported formats](https://palantir.github.io/tslint/formatters/)

For advanced usage, see the various runner options [here](https://github.com/palantir/tslint/blob/master/src/runner.ts).


# License

This project is licensed under [MIT](https://github.com/jrparish/tslint-webpack-plugin/blob/master/LICENSE).