|
1 | 1 | # Fork TS Checker Webpack Plugin
|
2 | 2 |
|
3 | 3 | [](https://www.npmjs.com/package/fork-ts-checker-webpack-plugin)
|
| 4 | + |
4 | 5 | [](https://www.npmjs.com/package/fork-ts-checker-webpack-plugin)
|
| 6 | + |
5 | 7 | [](https://travis-ci.org/Realytics/fork-ts-checker-webpack-plugin)
|
| 8 | + |
6 | 9 | [](https://npmjs.org/package/fork-ts-checker-webpack-plugin)
|
| 10 | + |
7 | 11 | [](http://commitizen.github.io/cz-cli/)
|
| 12 | + |
8 | 13 | [](https://github.com/prettier/prettier)
|
| 14 | + |
9 | 15 | [](https://github.com/semantic-release/semantic-release)
|
10 | 16 |
|
11 |
| -Webpack plugin that runs typescript type checker on a separate process. |
| 17 | +Webpack plugin that runs TypeScript type checker on a separate process. |
12 | 18 |
|
13 | 19 | ## Installation
|
14 | 20 |
|
15 |
| -This plugin requires minimum **webpack 2.3**, **typescript 2.1** and optionally **tslint 4.0** |
| 21 | +This plugin requires minimum **webpack 2.3**, **TypeScript 2.1** and optionally **tslint 4.0** |
16 | 22 |
|
17 | 23 | ```sh
|
18 | 24 | npm install --save-dev fork-ts-checker-webpack-plugin
|
@@ -53,19 +59,19 @@ these trees with tslint. It can be scaled with a multi-process mode to utilize m
|
53 | 59 |
|
54 | 60 | ## Modules resolution
|
55 | 61 |
|
56 |
| -It's very important to be aware that **this plugin uses [typescript](https://github.com/Microsoft/TypeScript)'s, not |
| 62 | +It's very important to be aware that **this plugin uses [TypeScript](https://github.com/Microsoft/TypeScript)'s, not |
57 | 63 | [webpack](https://github.com/webpack/webpack)'s modules resolution**. It means that you have to setup `tsconfig.json` correctly. For example
|
58 | 64 | if you set `files: ['./src/someFile.ts']` in `tsconfig.json`, this plugin will check only `someFile.ts` for semantic errors. It's because
|
59 |
| -of performance. The goal of this plugin is to be _as fast as possible_. With typescript's module resolution we don't have to wait for webpack |
| 65 | +of performance. The goal of this plugin is to be _as fast as possible_. With TypeScript's module resolution we don't have to wait for webpack |
60 | 66 | to compile files (which traverses dependency graph during compilation) - we have a full list of files from the begin.
|
61 | 67 |
|
62 |
| -To debug typescript's modules resolution, you can use `tsc --traceResolution` command. |
| 68 | +To debug TypeScript's modules resolution, you can use `tsc --traceResolution` command. |
63 | 69 |
|
64 | 70 | ## TSLint
|
65 | 71 |
|
66 | 72 | If you have installed [tslint](https://palantir.github.io/tslint), you can enable it by setting `tslint: true` or
|
67 | 73 | `tslint: './path/to/tslint.json'`. We recommend changing `defaultSeverity` to a `"warning"` in `tslint.json` file.
|
68 |
| -It helps to distinguish lints from typescript's diagnostics. |
| 74 | +It helps to distinguish lints from TypeScript's diagnostics. |
69 | 75 |
|
70 | 76 | ## Options
|
71 | 77 |
|
@@ -110,7 +116,7 @@ It helps to distinguish lints from typescript's diagnostics.
|
110 | 116 | We recommend to set this to `false` in projects where type checking is faster than webpack's build - it's better for integration with other plugins. Another scenario where you might want to set this to `false` is if you use the `overlay` functionality of `webpack-dev-server`.
|
111 | 117 |
|
112 | 118 | - **ignoreDiagnostics** `number[]`:
|
113 |
| - List of typescript diagnostic codes to ignore. |
| 119 | + List of TypeScript diagnostic codes to ignore. |
114 | 120 |
|
115 | 121 | - **ignoreLints** `string[]`:
|
116 | 122 | List of tslint rule names to ignore.
|
@@ -161,9 +167,9 @@ new ForkTsCheckerWebpackPlugin({
|
161 | 167 | [Vue section](https://github.com/Realytics/fork-ts-checker-webpack-plugin#vue) further down for information on how to correctly setup your project.
|
162 | 168 |
|
163 | 169 | - **useTypescriptIncrementalApi** `boolean`:
|
164 |
| - If true, the plugin will use incremental compilation API introduced in typescript 2.7. In this mode you can only have 1 |
| 170 | + If true, the plugin will use incremental compilation API introduced in TypeScript 2.7. In this mode you can only have 1 |
165 | 171 | worker, but if the changes in your code are small (like you normally have when you work in 'watch' mode), the compilation
|
166 |
| - may be much faster, even compared to multi-threaded compilation. Defaults to `true` when working with typescript 3+ and `false` when below 3. The default can be overridden by directly specifying a value. |
| 172 | + may be much faster, even compared to multi-threaded compilation. Defaults to `true` when working with TypeScript 3+ and `false` when below 3. The default can be overridden by directly specifying a value. |
167 | 173 |
|
168 | 174 | - **measureCompilationTime** `boolean`:
|
169 | 175 | If true, the plugin will measure the time spent inside the compilation code. This may be useful to compare modes,
|
|
0 commit comments