| 1 | <h1 align="center">ts-jest</h1>
|
| 2 |
|
| 3 | <p align="center">A Jest transformer with source map support that lets you use Jest to test projects written in TypeScript.</p>
|
| 4 |
|
| 5 | <p align="center">
|
| 6 | <a href="https://www.npmjs.com/package/ts-jest"><img src="https://img.shields.io/npm/v/ts-jest/latest.svg?style=flat-square" alt="NPM version" /> </a>
|
| 7 | <a href="https://www.npmjs.com/package/ts-jest"><img src="https://img.shields.io/npm/dm/ts-jest.svg?style=flat-square" alt="NPM downloads"/> </a>
|
| 8 | <a href="https://snyk.io/test/github/kulshekhar/ts-jest"><img src="https://snyk.io/test/github/kulshekhar/ts-jest/badge.svg?style=flat-square" alt="Known vulnerabilities"/> </a>
|
| 9 | <a href="https://coveralls.io/github/kulshekhar/ts-jest?branch=main"><img src="https://coveralls.io/repos/github/kulshekhar/ts-jest/badge.svg?branch=main" alt="Coverage status"/> </a>
|
| 10 | <a href="https://actions-badge.atrox.dev/kulshekhar/ts-jest/goto?ref=main"><img alt="GitHub actions" src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fkulshekhar%2Fts-jest%2Fbadge%3Fref%3Dmain&style=flat-square" /> </a>
|
| 11 | <a href="https://github.com/kulshekhar/ts-jest/blob/main/LICENSE.md"><img src="https://img.shields.io/npm/l/ts-jest.svg?style=flat-square" alt="GitHub license"/> </a>
|
| 12 | </p>
|
| 13 |
|
| 14 | <img src="./icon.png" align="right" title="ts-jest Logo" width="128" height="128">
|
| 15 |
|
| 16 | It supports all features of TypeScript including type-checking. [Read more about Babel7 + `preset-typescript` **vs** TypeScript (and `ts-jest`)](https://kulshekhar.github.io/ts-jest/docs/babel7-or-ts).
|
| 17 |
|
| 18 | ---
|
| 19 |
|
| 20 | | We are not doing semantic versioning and `23.10` is a re-write, run `npm i -D ts-jest@"<23.10.0"` to go back to the previous version |
|
| 21 | | ------------------------------------------------------------------------------------------------------------------------------------ |
|
| 22 |
|
| 23 | [<img src="./website/static/img/documentation.png" align="left" height="24"> View the online documentation (usage & technical)](https://kulshekhar.github.io/ts-jest)
|
| 24 |
|
| 25 | [<img src="./website/static/img/discord.svg" align="left" height="24"> Ask for some help in the `Jest` Discord community](https://discord.gg/j6FKKQQrW9) or [`ts-jest` GitHub Discussion](https://github.com/kulshekhar/ts-jest/discussions)
|
| 26 |
|
| 27 | [<img src="./website/static/img/troubleshooting.png" align="left" height="24"> Before reporting any issues, be sure to check the troubleshooting page](TROUBLESHOOTING.md)
|
| 28 |
|
| 29 | [<img src="./website/static/img/pull-request.png" align="left" height="24"> We're looking for collaborators! Want to help improve `ts-jest`?](https://github.com/kulshekhar/ts-jest/issues/223)
|
| 30 |
|
| 31 | ---
|
| 32 |
|
| 33 | ## Getting Started
|
| 34 |
|
| 35 | These instructions will get you setup to use `ts-jest` in your project. For more detailed documentation, please check [online documentation](https://kulshekhar.github.io/ts-jest).
|
| 36 |
|
| 37 | | | using npm | using yarn |
|
| 38 | | ------------------: | ------------------------------ | ------------------------------------ |
|
| 39 | | **Prerequisites** | `npm i -D jest typescript` | `yarn add --dev jest typescript` |
|
| 40 | | **Installing** | `npm i -D ts-jest @types/jest` | `yarn add --dev ts-jest @types/jest` |
|
| 41 | | **Creating config** | `npx ts-jest config:init` | `yarn ts-jest config:init` |
|
| 42 | | **Running tests** | `npm test` or `npx jest` | `yarn test` or `yarn jest` |
|
| 43 |
|
| 44 | ## Built With
|
| 45 |
|
| 46 | - [TypeScript](https://www.typescriptlang.org/) - JavaScript that scales
|
| 47 | - [Jest](https://jestjs.io/) - Delightful JavaScript Testing
|
| 48 | - [`ts-jest`](https://kulshekhar.github.io/ts-jest) - Jest [transformer](https://jestjs.io/docs/next/code-transformation#writing-custom-transformers) for TypeScript _(yes, `ts-jest` uses itself for its tests)_
|
| 49 |
|
| 50 | ## Contributing
|
| 51 |
|
| 52 | Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
|
| 53 |
|
| 54 | ## Versioning
|
| 55 |
|
| 56 | We **DO NOT** use [SemVer](https://semver.org/) for versioning. Though you can think about SemVer when reading our version, except our major number follows the one of Jest. For the versions available, see the [tags on this repository](https://github.com/kulshekhar/ts-jest/tags).
|
| 57 |
|
| 58 | ## Authors/maintainers
|
| 59 |
|
| 60 | - **Kulshekhar Kabra** - [kulshekhar](https://github.com/kulshekhar)
|
| 61 | - **Gustav Wengel** - [GeeWee](https://github.com/GeeWee)
|
| 62 | - **Ahn** - [ahnpnl](https://github.com/ahnpnl)
|
| 63 | - **Huafu Gandon** - [huafu](https://github.com/huafu)
|
| 64 |
|
| 65 | See also the list of [contributors](https://github.com/kulshekhar/ts-jest/contributors) who participated in this project.
|
| 66 |
|
| 67 | ## Supporters
|
| 68 |
|
| 69 | - [JetBrains](https://www.jetbrains.com/?from=ts-jest) has been kind enough to support ts-jest with an [open source license](https://www.jetbrains.com/community/opensource/?from=ts-jest).
|
| 70 |
|
| 71 | ## License
|
| 72 |
|
| 73 | This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
|