docs: mention needing additional configuration for ts-jest
#13418
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
professorjrod
changed the title
SimenB
reviewed
Oct 10, 2022
| @@ -162,6 +162,8 @@ However, there are some [caveats](https://babeljs.io/docs/en/babel-plugin-transf | |||
| npm install --save-dev ts-jest | |||
| ``` | |||
|
|
|||
| In order for Jest to transpile TypeScript with ts-jest, you may also need to create a [configuration](https://kulshekhar.github.io/ts-jest/docs/getting-started/installation#jest-config-file) file | |||
There was a problem hiding this comment.
Suggested change
| In order for Jest to transpile TypeScript with ts-jest, you may also need to create a [configuration](https://kulshekhar.github.io/ts-jest/docs/getting-started/installation#jest-config-file) file | |
| In order for Jest to transpile TypeScript with ts-jest, you may also need to create a [configuration](https://kulshekhar.github.io/ts-jest/docs/getting-started/installation#jest-config-file) file. |
|
Sure thing |
professorjrod
force-pushed
the
patch-1
branch
from
f4cf165
to
1e6d792
Compare
Update GettingStarted.md docs: link to ts-jest config Mention needing addition configuration for ts-jest Co-Authored-By: Simen Bekkhus <sbekkhus91@gmail.com>
professorjrod
force-pushed
the
patch-1
branch
from
1e6d792
to
635bae3
Compare
|
OK, I think I got all the versions. |
SimenB
changed the title
ts-jest
|
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
I added a link to ts-jest docs configuration. Currently, if you try to run parse .ts files without a config file, you are brought to this page on the docs. There is only a link to the github repo for ts-jest. This small change will help save time and googling for users. We won't have to worry about keeping this up to date since it's just a link to their documentation page.
Test plan
None, this is just a change to the docs.