added known limitation #251
Conversation
|
I'm not sure this is a limitation. Catching, processing and responding to tsc errors should be part of the build/live development step. The purpose of ts-jest is to help write tests using Jest use in Typescript projects. |
|
Don't have to call it a limitation but it is something I believe should be documented. Out of scope for this project:
|
|
I added more background. Feel free to close this if you think it is not needed. This is more of a ts compiler limitation. microsoft/TypeScript#4864 |
|
@masters3d I've shared my thoughts but let's keep this open and see what the others think about it. If it's helpful and doesn't add any confusion, we might merge this in :) Thanks for adding the additional details. If it goes in, that would be useful contextual information. |
|
If this is a known tsc issue with transpileModule, I think this should go in. It's reasonably valuable information. |
README.md
Outdated
| @@ -263,6 +263,10 @@ By default Jest ignores everything in `node_modules`. This setting prevents Jest | |||
| "moduleDirectories": ["node_modules", "<path_to_your_sources>"] | |||
| } | |||
| ``` | |||
| ### TS compiler && error reporting | |||
| - Only syntactic errors are reported by the [tsc `transpileModule`](https://github.com/Microsoft/TypeScript/issues/4864#issuecomment-141567247) | |||
There was a problem hiding this comment.
I think this is a little too technical. Perhaps the first line could be 'ts-jest only returns syntax errors from TSC' or something like that?
README.md
Outdated
| ### TS compiler && error reporting | ||
| - Only syntactic errors are reported by the [tsc `transpileModule`](https://github.com/Microsoft/TypeScript/issues/4864#issuecomment-141567247) | ||
| - Non syntactic errors do not show up in [Jest](https://github.com/facebook/jest/issues/2168) | ||
| - A workaround is to call the ts compiler before calling Jest `tsc --noEmit -p . && jest` |
There was a problem hiding this comment.
I think in a lot of cases you want to run the tests even though tsc reports errors. Maybe last line could be 'If you only want to run jest if tsc does not output any errors, a workaround is ...' ?
|
I am okay with this PR, and I don't think we should necessarily seek to overcome this limitation. The ability to run type-unsafe code while doing e.g. TDD is valuable. |
My concern is that this would add no value and could cause confusion. I'm not sure devs expect their testing framework to tell them about language errors. Editors/IDEs and build processes are responsible for that, no? If you still think this adds value, feel free to merge it in |
|
I imagine that some people might use ts-jest in a CI environment, and would expect it to fail on tsc warnings. |
#250