# tslint-loader

> tslint loader for webpack

Latest version **3.5.4** (published 2018-10-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install tslint-loader
pnpm add tslint-loader
yarn add tslint-loader
bun add tslint-loader
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.5.4 |
| Published | 2018-10-09 |
| First published | 2015-05-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 64 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 192 |
| Author | William Buchwalter |
| Maintainers | bhovhannes, blacksonic, wbuchwalter |
| Keywords | tslint, typescript, webpack, loader, linting |

## Links

- npm: https://www.npmjs.com/package/tslint-loader
- Repository: https://github.com/wbuchwalter/tslint-loader
- Issues: https://github.com/wbuchwalter/tslint-loader/issues
- npm.io page: https://npm.io/package/tslint-loader

## Dependencies (5)

- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.1
- [rimraf](https://npm.io/package/rimraf.md) ^2.4.4
- [semver](https://npm.io/package/semver.md) ^5.3.0
- [loader-utils](https://npm.io/package/loader-utils.md) ^1.0.2
- [object-assign](https://npm.io/package/object-assign.md) ^4.1.1

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 3.5.4 (latest) — 2018-10-09
- 3.6.0 — 2018-03-01
- 3.5.3 — 2017-04-22
- 3.5.2 — 2017-04-08
- 3.5.1 — 2017-04-06
- 3.4.3 — 2017-03-02
- 3.4.2 — 2017-02-12
- 3.4.1 — 2017-02-12
- 3.4.0 — 2017-02-12
- 3.3.0 — 2016-12-04
- 3.2.1 — 2016-11-30
- 3.2.0 — 2016-11-22
- 3.1.0 — 2016-11-22
- 3.0.0 — 2016-11-22
- 2.1.5 — 2016-06-20
- … 12 more at https://npm.io/package/tslint-loader/versions

## README

# 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 tslint-loader --save-dev
```

The package depends on Tslint 4.0+, no longer works with 3.* versions.

## Usage

Apply the tslint loader as preLoader in your webpack configuration.

### Webpack 4

```javascript
module.exports = {
    module: {
        rules: [
            {
                test: /\.ts$/,
                enforce: 'pre',
                use: [
                    {
                        loader: 'tslint-loader',
                        options: { /* Loader options go here */ }
                    }
                ]
            }
        ]
    }
}
```

### Webpack 3

```javascript
module.exports = {
    module: {
        loaders: [
            {
                test: /\.ts$/,
                enforce: 'pre',
                loader: 'tslint-loader',
                options: { /* Loader options go here */ }
            }
        ]
    }
}
```

### Webpack 2

```javascript
module.exports = {
    module: {
        rules: [
            {
                test: /\.ts$/,
                enforce: 'pre',
                loader: 'tslint-loader',
                options: { /* Loader options go here */ }
            }
        ]
    }
}
```

### Webpack 1

```javascript
module.exports = {
    module: {
        preLoaders: [
            {
                test: /\.ts$/,
                loader: 'tslint-loader'
            }
        ]
    },

    tslint: { /* Loader options go here */ }
}
```

### Loader options

```javascript
{
    configuration: {
        rules: {
            quotemark: [true, 'double']
        }
    },
    
    // can specify a custom config file relative to current directory or with absolute path
    // '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,
    
    // automatically fix linting errors
    fix: false,
    
    // can specify a custom tsconfig file relative to current directory or with absolute path
    // 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)

---
_Source: https://npm.io/package/tslint-loader · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
