Skip to content

Commit

Permalink
Update docs to show transpileOnly does not affect project references (#…
Browse files Browse the repository at this point in the history
…1175)

* Update docs to show transpileOnly does not affect project references

* tweaks to formatting

Co-authored-by: John Reilly <johnny_reilly@hotmail.com>
  • Loading branch information
appzuka and johnnyreilly authored Aug 30, 2020
1 parent 0e64ceb commit 46d9761
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -289,8 +289,7 @@ module.exports = {
| `boolean` | `false`|

If you want to speed up compilation significantly you can set this flag.
However, many of the benefits you get from static type checking between
different dependencies in your application will be lost.
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.

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).

Expand Down

0 comments on commit 46d9761

Please sign in to comment.