You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-10Lines changed: 10 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -70,7 +70,7 @@ module.exports = {
70
70
## Modules resolution
71
71
72
72
It's very important to be aware that **this plugin uses [TypeScript](https://github.com/Microsoft/TypeScript)'s, not
73
-
[webpack](https://github.com/webpack/webpack)'s modules resolution**. It means that you have to setup `tsconfig.json` correctly.
73
+
[webpack](https://github.com/webpack/webpack)'s modules resolution**. It means that you have to setup `tsconfig.json` correctly.
74
74
75
75
> It's because of the performance - with TypeScript's module resolution we don't have to wait for webpack to compile files.
76
76
>
@@ -83,7 +83,7 @@ you can place your configuration in the:
83
83
*`"fork-ts-checker"` field in the `package.json`
84
84
*`.fork-ts-checkerrc` file in JSON or YAML format
85
85
*`fork-ts-checker.config.js` file exporting a JS object
86
-
86
+
87
87
Options passed to the plugin constructor will overwrite options from the cosmiconfig (using [deepmerge](https://github.com/TehShrike/deepmerge)).
88
88
89
89
| Name | Type | Default value | Description |
@@ -92,7 +92,7 @@ Options passed to the plugin constructor will overwrite options from the cosmico
92
92
|`typescript`|`object`|`{}`| See [TypeScript options](#typescript-options). |
93
93
|`issue`|`object`|`{}`| See [Issues options](#issues-options). |
94
94
|`formatter`|`string` or `object` or `function`|`codeframe`| Available formatters are `basic`, `codeframe` and a custom `function`. To [configure](https://babeljs.io/docs/en/babel-code-frame#options)`codeframe` formatter, pass object: `{ type: 'codeframe', options: { <coderame options> } }`. |
95
-
|`logger`|`{ log: function, error: function }`|`console`| Console-like object to print issues in `async` mode. |
95
+
|`logger`|`{ log: function, error: function }`or `webpack-infrastructure`|`console`| Console-like object to print issues in `async` mode. |
96
96
|`devServer`|`boolean`|`true`| If set to `false`, errors will not be reported to Webpack Dev Server. |
97
97
98
98
### TypeScript options
@@ -120,7 +120,7 @@ Options for the TypeScript checker extensions (`typescript.extensions` option ob
|`vue`|`object` or `boolean`|`false`| If `true`, it enables Vue [Single File Component](https://vuejs.org/v2/guide/single-file-components.html) support. |
122
122
|`vue.enabled`|`boolean`|`false`| Same as the `vue` option |
123
-
|`vue.compiler`|`string`|`'vue-template-compiler'`| The package name of the compiler that will be used to parse `.vue` files. You can use `'nativescript-vue-template-compiler'` if you use [nativescript-vue](https://github.com/nativescript-vue/nativescript-vue)|
123
+
|`vue.compiler`|`string`|`'vue-template-compiler'`| The package name of the compiler that will be used to parse `.vue` files. You can use `'nativescript-vue-template-compiler'` if you use [nativescript-vue](https://github.com/nativescript-vue/nativescript-vue)|
124
124
125
125
### Issues options
126
126
@@ -184,11 +184,11 @@ To enable Vue.js support, follow these steps:
To use the plugin typings, you have to install `@types/webpack`. It's not included by default to not collide with your
338
-
existing typings (`@types/webpack` imports `@types/node`). [It's an old TypeScript issue](https://github.com/microsoft/TypeScript/issues/18588),
338
+
existing typings (`@types/webpack` imports `@types/node`). [It's an old TypeScript issue](https://github.com/microsoft/TypeScript/issues/18588),
339
339
the alternative is to set `skipLibCheck: true` in the `compilerOptions` 😉
340
340
```sh
341
341
# with npm
@@ -351,7 +351,7 @@ Starting from TypeScript 4.1.0, you can profile long type checks by
351
351
setting "generateTrace" compiler option. This is an instruction from [microsoft/TypeScript#40063](https://github.com/microsoft/TypeScript/pull/40063):
352
352
353
353
1. Set "generateTrace": "{folderName}" in your `tsconfig.json`
354
-
2. Look in the resulting folder. If you used build mode, there will be a `legend.json` telling you what went where.
354
+
2. Look in the resulting folder. If you used build mode, there will be a `legend.json` telling you what went where.
355
355
Otherwise, there will be `trace.json` file and `types.json` files.
356
356
3. Navigate to [edge://tracing](edge://tracing) or [chrome://tracing](chrome://tracing) and load `trace.json`
357
357
4. Expand Process 1 with the little triangle in the left sidebar
@@ -361,7 +361,7 @@ setting "generateTrace" compiler option. This is an instruction from [microsoft/
361
361
362
362
363
363
## Related projects
364
-
364
+
365
365
*[`ts-loader`](https://github.com/TypeStrong/ts-loader) - TypeScript loader for webpack.
366
366
*[`babel-loader`](https://github.com/babel/babel-loader) - Alternative TypeScript loader for webpack.
367
367
*[`fork-ts-checker-notifier-webpack-plugin`](https://github.com/johnnyreilly/fork-ts-checker-notifier-webpack-plugin) - Notifies about build status using system notifications (similar to the [webpack-notifier](https://github.com/Turbo87/webpack-notifier)).
"description": "`readonly` keeps all emitted files in memory, `write-tsbuildinfo` which writes only .tsbuildinfo files, `write-dts` writes .tsbuildinfo and type definition files, and `write-references` which writes both .tsbuildinfo and referenced projects output"
0 commit comments