Skip to content

Commit 77b5519

Browse files
authored
docs: add section about installing ts-jest (#12607)
1 parent d873e2c commit 77b5519

File tree

8 files changed

+32
-0
lines changed

8 files changed

+32
-0
lines changed

docs/GettingStarted.md

+4
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,10 @@ However, there are some [caveats](https://babeljs.io/docs/en/babel-plugin-transf
150150

151151
[ts-jest](https://github.com/kulshekhar/ts-jest) is a TypeScript preprocessor with source map support for Jest that lets you use Jest to test projects written in TypeScript.
152152

153+
```bash npm2yarn
154+
npm install --save-dev ts-jest
155+
```
156+
153157
#### Type definitions
154158

155159
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-25.x/GettingStarted.md

+4
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,10 @@ However, there are some [caveats](https://babeljs.io/docs/en/babel-plugin-transf
158158

159159
[ts-jest](https://github.com/kulshekhar/ts-jest) is a TypeScript preprocessor with source map support for Jest that lets you use Jest to test projects written in TypeScript.
160160

161+
```bash
162+
yarn add --dev ts-jest
163+
```
164+
161165
#### Type definitions
162166

163167
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

+4
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,10 @@ However, there are some [caveats](https://babeljs.io/docs/en/babel-plugin-transf
158158

159159
[ts-jest](https://github.com/kulshekhar/ts-jest) is a TypeScript preprocessor with source map support for Jest that lets you use Jest to test projects written in TypeScript.
160160

161+
```bash
162+
yarn add --dev ts-jest
163+
```
164+
161165
### Using TypeScript: type definitions
162166

163167
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-27.0/GettingStarted.md

+4
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,10 @@ However, there are some [caveats](https://babeljs.io/docs/en/babel-plugin-transf
158158

159159
[ts-jest](https://github.com/kulshekhar/ts-jest) is a TypeScript preprocessor with source map support for Jest that lets you use Jest to test projects written in TypeScript.
160160

161+
```bash
162+
yarn add --dev ts-jest
163+
```
164+
161165
#### Type definitions
162166

163167
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-27.1/GettingStarted.md

+4
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,10 @@ However, there are some [caveats](https://babeljs.io/docs/en/babel-plugin-transf
158158

159159
[ts-jest](https://github.com/kulshekhar/ts-jest) is a TypeScript preprocessor with source map support for Jest that lets you use Jest to test projects written in TypeScript.
160160

161+
```bash
162+
yarn add --dev ts-jest
163+
```
164+
161165
#### Type definitions
162166

163167
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-27.2/GettingStarted.md

+4
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,10 @@ However, there are some [caveats](https://babeljs.io/docs/en/babel-plugin-transf
158158

159159
[ts-jest](https://github.com/kulshekhar/ts-jest) is a TypeScript preprocessor with source map support for Jest that lets you use Jest to test projects written in TypeScript.
160160

161+
```bash
162+
yarn add --dev ts-jest
163+
```
164+
161165
#### Type definitions
162166

163167
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-27.4/GettingStarted.md

+4
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,10 @@ However, there are some [caveats](https://babeljs.io/docs/en/babel-plugin-transf
158158

159159
[ts-jest](https://github.com/kulshekhar/ts-jest) is a TypeScript preprocessor with source map support for Jest that lets you use Jest to test projects written in TypeScript.
160160

161+
```bash
162+
yarn add --dev ts-jest
163+
```
164+
161165
### Using TypeScript: type definitions
162166

163167
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-27.5/GettingStarted.md

+4
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,10 @@ However, there are some [caveats](https://babeljs.io/docs/en/babel-plugin-transf
158158

159159
[ts-jest](https://github.com/kulshekhar/ts-jest) is a TypeScript preprocessor with source map support for Jest that lets you use Jest to test projects written in TypeScript.
160160

161+
```bash
162+
yarn add --dev ts-jest
163+
```
164+
161165
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.
162166

163167
> 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.

0 commit comments

Comments
 (0)