Skip to content

Commit 46d9761

Browse files
Update docs to show transpileOnly does not affect project references (#1175)
* Update docs to show transpileOnly does not affect project references * tweaks to formatting Co-authored-by: John Reilly <johnny_reilly@hotmail.com>
1 parent 0e64ceb commit 46d9761

File tree

1 file changed

+1
-2
lines changed

1 file changed

+1
-2
lines changed

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -289,8 +289,7 @@ module.exports = {
289289
| `boolean` | `false`|
290290

291291
If you want to speed up compilation significantly you can set this flag.
292-
However, many of the benefits you get from static type checking between
293-
different dependencies in your application will be lost.
292+
However, many of the benefits you get from static type checking between different dependencies in your application will be lost. `transpileOnly` will *not* speed up compilation of project references.
294293

295294
It's advisable to use `transpileOnly` alongside the [fork-ts-checker-webpack-plugin](https://github.com/Realytics/fork-ts-checker-webpack-plugin) to get full type checking again. To see what this looks like in practice then either take a look at [our simple example](examples/fork-ts-checker-webpack-plugin). For a more complex setup take a look at our [more involved example](examples/react-babel-karma-gulp).
296295

0 commit comments

Comments
 (0)