Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: mention needing additional configuration for ts-jest #13418

Merged
merged 2 commits into from
Oct 10, 2022

Conversation

professorjrod
Copy link
Contributor

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.

@professorjrod professorjrod changed the title Mention needing addition configuration for ts-jest Mention needing additional configuration for ts-jest Oct 10, 2022
Copy link
Member

@SimenB SimenB left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you update all versions of this doc?

@@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@professorjrod
Copy link
Contributor Author

Sure thing

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
Copy link
Contributor Author

OK, I think I got all the versions.

Copy link
Member

@SimenB SimenB left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks!

@SimenB SimenB changed the title Mention needing additional configuration for ts-jest docs: mention needing additional configuration for ts-jest Oct 10, 2022
@SimenB SimenB merged commit f192ac5 into jestjs:main Oct 10, 2022
@github-actions
Copy link

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.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 10, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants