Skip to content

Commit 538216d

Browse files
author
Piotr Oleś
committed
Improve README
1 parent db68f69 commit 538216d

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Webpack plugin that runs typescript type checker (with optional linter) on separate processes.
66

77
## Installation ##
8-
This plugin is compatible with **Webpack 2**, **TypeScript 2.1** and **tslint 5.0**
8+
This plugin requires minimum **webpack 2**, **typescript 2.1** and optionally **tslint 5.0**
99
```sh
1010
npm install --save fork-ts-checker-webpack-plugin
1111
```
@@ -42,8 +42,13 @@ var webpackConfig = {
4242
```
4343

4444
## Motivation ##
45-
There is already similar solution - [awesome-typescript-loader](https://github.com/s-panferov/awesome-typescript-loader).
46-
The problem with atl is that it's slower in some cases.
45+
There is already similar solution - [awesome-typescript-loader](https://github.com/s-panferov/awesome-typescript-loader). You can
46+
add `CheckerPlugin` and delegate checker to the separate process. The problem with `awesome-typescript-laoder` is that it's a lot slower
47+
than [ts-loader](https://github.com/TypeStrong/ts-loader) on incremental build in our case (~20s vs ~3s).
48+
Secondly, we use [tslint](https://palantir.github.io/tslint/) and we wanted to run this also on separate process.
49+
This is why we've created this plugin. The performance is great because of reusing Abstract Syntax Trees between compilations and sharing
50+
these trees with tslint. We can also scale checker with multi-process mode - it will split work between processes to utilize maximum cpu
51+
power.
4752

4853
## Options ##
4954
**tsconfig** `string` - Path to tsconfig.json file. If not set, plugin will use `path.resolve(compiler.options.context, './tsconfig.json')`.

0 commit comments

Comments
 (0)