Skip to content

Commit

Permalink
docs: add section about installing ts-jest (#12607)
Browse files Browse the repository at this point in the history
  • Loading branch information
nate-io authored Apr 4, 2022
1 parent d873e2c commit 77b5519
Show file tree
Hide file tree
Showing 8 changed files with 32 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/GettingStarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,10 @@ However, there are some [caveats](https://babeljs.io/docs/en/babel-plugin-transf

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

```bash npm2yarn
npm install --save-dev ts-jest
```

#### Type definitions

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.
Expand Down
4 changes: 4 additions & 0 deletions website/versioned_docs/version-25.x/GettingStarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,10 @@ However, there are some [caveats](https://babeljs.io/docs/en/babel-plugin-transf

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

```bash
yarn add --dev ts-jest
```

#### Type definitions

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.
Expand Down
4 changes: 4 additions & 0 deletions website/versioned_docs/version-26.x/GettingStarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,10 @@ However, there are some [caveats](https://babeljs.io/docs/en/babel-plugin-transf

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

```bash
yarn add --dev ts-jest
```

### Using TypeScript: type definitions

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.
Expand Down
4 changes: 4 additions & 0 deletions website/versioned_docs/version-27.0/GettingStarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,10 @@ However, there are some [caveats](https://babeljs.io/docs/en/babel-plugin-transf

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

```bash
yarn add --dev ts-jest
```

#### Type definitions

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.
Expand Down
4 changes: 4 additions & 0 deletions website/versioned_docs/version-27.1/GettingStarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,10 @@ However, there are some [caveats](https://babeljs.io/docs/en/babel-plugin-transf

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

```bash
yarn add --dev ts-jest
```

#### Type definitions

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.
Expand Down
4 changes: 4 additions & 0 deletions website/versioned_docs/version-27.2/GettingStarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,10 @@ However, there are some [caveats](https://babeljs.io/docs/en/babel-plugin-transf

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

```bash
yarn add --dev ts-jest
```

#### Type definitions

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.
Expand Down
4 changes: 4 additions & 0 deletions website/versioned_docs/version-27.4/GettingStarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,10 @@ However, there are some [caveats](https://babeljs.io/docs/en/babel-plugin-transf

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

```bash
yarn add --dev ts-jest
```

### Using TypeScript: type definitions

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.
Expand Down
4 changes: 4 additions & 0 deletions website/versioned_docs/version-27.5/GettingStarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,10 @@ However, there are some [caveats](https://babeljs.io/docs/en/babel-plugin-transf

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

```bash
yarn add --dev ts-jest
```

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.

> 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.
Expand Down

0 comments on commit 77b5519

Please sign in to comment.