Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/annoraaq/tslint-fast-loader
A fast tslint loader for webpack
https://github.com/annoraaq/tslint-fast-loader
Last synced: 21 days ago
JSON representation
A fast tslint loader for webpack
- Host: GitHub
- URL: https://github.com/annoraaq/tslint-fast-loader
- Owner: Annoraaq
- Created: 2019-02-01T11:41:07.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-04T00:16:23.000Z (about 2 years ago)
- Last Synced: 2024-05-01T14:14:58.203Z (8 months ago)
- Language: JavaScript
- Size: 475 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# tslint-fast-loader
Fast tslint loader for Webpack. This is a fork of tslint-loader but performs faster by an order of magnitude when type checking is enabled.
## Installation
```shell
npm install tslint tslint-fast-loader --save-dev
```
The package depends on Tslint 4.0+, no longer works with 3.\* versions.
## Usage
Apply the tslint fast loader as preLoader in your webpack configuration.
### Webpack 4
```javascript
module.exports = {
module: {
rules: [
{
test: /\.ts$/,
enforce: "pre",
use: [
{
loader: "tslint-fast-loader",
options: {
/* Loader options go here */
}
}
]
}
]
}
};
```
### Webpack 3
```javascript
module.exports = {
module: {
loaders: [
{
test: /\.ts$/,
enforce: "pre",
loader: "tslint-fast-loader",
options: {
/* Loader options go here */
}
}
]
}
};
```
### Webpack 2
```javascript
module.exports = {
module: {
rules: [
{
test: /\.ts$/,
enforce: "pre",
loader: "tslint-fast-loader",
options: {
/* Loader options go here */
}
}
]
}
};
```
### Webpack 1
```javascript
module.exports = {
module: {
preLoaders: [
{
test: /\.ts$/,
loader: "tslint-fast-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-fast-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: '\n',
// A string to include at the bottom of every report file.
// Useful for some report formats.
footer: ''
}
}
```
## License
[MIT](http://www.opensource.org/licenses/mit-license.php)