Skip to content

Commit 635bae3

Browse files
professorjrodSimenB
professorjrod
and
SimenB
committed
docs: link to ts-jest config
Update GettingStarted.md docs: link to ts-jest config Mention needing addition configuration for ts-jest Co-Authored-By: Simen Bekkhus <sbekkhus91@gmail.com>
1 parent 7b49471 commit 635bae3

7 files changed

Lines changed: 14 additions & 0 deletions

File tree

‎docs/GettingStarted.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,8 @@ However, there are some [caveats](https://babeljs.io/docs/en/babel-plugin-transf
162162
npm install --save-dev ts-jest
163163
```
164164

165+
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.
166+
165167
#### Type definitions
166168

167169
There are two ways to have [Jest global APIs](GlobalAPI.md) typed for test files written in TypeScript.

‎website/versioned_docs/version-25.x/GettingStarted.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,8 @@ However, there are some [caveats](https://babeljs.io/docs/en/babel-plugin-transf
166166
yarn add --dev ts-jest
167167
```
168168

169+
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.
170+
169171
#### Type definitions
170172

171173
You may also want to install the [`@types/jest`](https://www.npmjs.com/package/@types/jest) module for the version of Jest you're using. This will help provide full typing when writing your tests with TypeScript.

‎website/versioned_docs/version-26.x/GettingStarted.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,8 @@ yarn add --dev ts-jest
170170

171171
You may also want to install the [`@types/jest`](https://www.npmjs.com/package/@types/jest) module for the version of Jest you're using. This will help provide full typing when writing your tests with TypeScript.
172172

173+
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.
174+
173175
:::note
174176

175177
For `@types/*` modules it's recommended to try to match the version of the associated module. For example, if you are using `26.4.0` of `jest` then using `26.4.x` of `@types/jest` is ideal. In general, try to match the major (`26`) and minor (`4`) version as closely as possible.

‎website/versioned_docs/version-27.x/GettingStarted.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,8 @@ yarn add --dev ts-jest
168168

169169
You may also want to install the [`@types/jest`](https://www.npmjs.com/package/@types/jest) module for the version of Jest you're using. This will help provide full typing when writing your tests with TypeScript.
170170

171+
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.
172+
171173
:::note
172174

173175
For `@types/*` modules it's recommended to try to match the version of the associated module. For example, if you are using `26.4.0` of `jest` then using `26.4.x` of `@types/jest` is ideal. In general, try to match the major (`26`) and minor (`4`) version as closely as possible.

‎website/versioned_docs/version-28.x/GettingStarted.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,8 @@ However, there are some [caveats](https://babeljs.io/docs/en/babel-plugin-transf
158158
npm install --save-dev ts-jest
159159
```
160160

161+
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.
162+
161163
#### Type definitions
162164

163165
You may also want to install the [`@types/jest`](https://www.npmjs.com/package/@types/jest) module for the version of Jest you're using. This will help provide full typing when writing your tests with TypeScript.

‎website/versioned_docs/version-29.0/GettingStarted.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,8 @@ However, there are some [caveats](https://babeljs.io/docs/en/babel-plugin-transf
158158
npm install --save-dev ts-jest
159159
```
160160

161+
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.
162+
161163
#### Type definitions
162164

163165
There are two ways to have [Jest global APIs](GlobalAPI.md) typed for test files written in TypeScript.

‎website/versioned_docs/version-29.1/GettingStarted.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,8 @@ However, there are some [caveats](https://babeljs.io/docs/en/babel-plugin-transf
162162
npm install --save-dev ts-jest
163163
```
164164

165+
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.
166+
165167
#### Type definitions
166168

167169
There are two ways to have [Jest global APIs](GlobalAPI.md) typed for test files written in TypeScript.

0 commit comments

Comments
 (0)