# tslint-loader
[![Build Status](https://travis-ci.org/wbuchwalter/tslint-loader.svg?branch=master)](https://travis-ci.org/wbuchwalter/tslint-loader)
[![Dependency Status](https://david-dm.org/wbuchwalter/tslint-loader.svg)](https://david-dm.org/wbuchwalter/tslint-loader)
[![devDependency Status](https://david-dm.org/wbuchwalter/tslint-loader/dev-status.svg)](https://david-dm.org/wbuchwalter/tslint-loader?type=dev)
[![peerDependency Status](https://david-dm.org/wbuchwalter/tslint-loader/peer-status.svg)](https://david-dm.org/wbuchwalter/tslint-loader?type=peer)

Tslint loader for Webpack

## Installation

``` shell
npm install tslint-loader --save-dev
```

## Usage

Apply the tslint loader as pre/postLoader in your webpack configuration:

``` javascript
module.exports = {
    module: {
        preLoaders: [
            {
                test: /\.ts$/,
                loader: 'tslint-loader'
            }
        ]
    },
    // more options in the optional tslint object
    tslint: {
        configuration: {
            rules: {
                quotemark: [true, 'double']
            }
        },

        // can specify a custom config file relative to current directory
        // 'tslint-custom.json'
        configFile: false,

        // tslint errors are displayed by default as warnings
        // set emitErrors to true to display them as errors
        emitErrors: false,

        // tslint does not interrupt the compilation by default
        // if you want any file with tslint errors to fail
        // set failOnHint to true
        failOnHint: true,

        // enables type checked rules like 'for-in-array'
        // uses tsconfig.json from current working directory
        typeCheck: false,

        // can specify a custom tsconfig file relative to current directory
        // to be used with type checked rules
        tsConfigFile: 'tsconfig.json',

        // name of your formatter (optional)
        formatter: 'yourformatter',

        // path to directory containing formatter (optional)
        formattersDirectory: 'node_modules/tslint-loader/formatters/',

        // These options are useful if you want to save output to files
        // for your continuous integration server
        fileOutput: {
            // The directory where each file's report is saved
            dir: './foo/',

            // The extension to use for each report's filename. Defaults to 'txt'
            ext: 'xml',

            // If true, all files are removed from the report directory at the beginning of run
            clean: true,

            // A string to include at the top of every report file.
            // Useful for some report formats.
            header: '<?xml version="1.0" encoding="utf-8"?>\n<checkstyle version="5.7">',

            // A string to include at the bottom of every report file.
            // Useful for some report formats.
            footer: '</checkstyle>'
        }
    }
}
```

## License

[MIT](http://www.opensource.org/licenses/mit-license.php)