Add warning about enableTsDiagnostics

kulshekhar · web-flow · commit 6e530aa4e86d · 2018-05-20T18:46:27.000+05:30
diff --git a/README.md b/README.md
@@ -237,6 +237,8 @@ If you want to enable Syntactic & Semantic TypeScript error reporting you can en
 }
 ```
 
+**Note:** This is an experimental feature, comes with no guarantees and could be removed if it causes more problems than it solves. Testing is not the place to look for type errors. That should be done separately. Moreover, ts-jest only processes the files that are passed in by jest. It doesn't read files off the disk by default which is why `enableTsDiagnostics` will hurt performance compared to the normal use case.
+
 ### Ignore coverage on decorators
 
 **Note:** This is an experimental feature, comes with no guarantees and could be removed if it causes more problems than it solves

Original file line number	Diff line number	Diff line change
`@@ -237,6 +237,8 @@ If you want to enable Syntactic & Semantic TypeScript error reporting you can en`
`237`	`237`	`}`
`238`	`238`	```
`239`	`239`
	`240`	+Note: This is an experimental feature, comes with no guarantees and could be removed if it causes more problems than it solves. Testing is not the place to look for type errors. That should be done separately. Moreover, ts-jest only processes the files that are passed in by jest. It doesn't read files off the disk by default which is why `enableTsDiagnostics` will hurt performance compared to the normal use case.
	`241`	`+`
`240`	`242`	`### Ignore coverage on decorators`
`241`	`243`
`242`	`244`	`Note: This is an experimental feature, comes with no guarantees and could be removed if it causes more problems than it solves`