| 1 | # ts-jest [](https://badge.fury.io/js/ts-jest) [](https://npmjs.org/package/ts-jest) [](https://snyk.io/test/github/kulshekhar/ts-jest) [](https://coveralls.io/github/kulshekhar/ts-jest?branch=master) [](https://dependabot.com) [](https://travis-ci.org/kulshekhar/ts-jest) [](https://ci.appveyor.com/project/kulshekhar/ts-jest/branch/master)
|
| 2 |
|
| 3 | <img src="./icon.png" align="right" title="ts-jest Logo" width="128" height="128">
|
| 4 |
|
| 5 | **`ts-jest`** is a TypeScript preprocessor with source map support for Jest that lets you use Jest to test projects written in TypeScript.
|
| 6 |
|
| 7 | 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/user/babel7-or-ts).
|
| 8 |
|
| 9 | ---
|
| 10 |
|
| 11 | | 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 |
|
| 12 | |---|
|
| 13 |
|
| 14 | [<img src="./docs/assets/img/documentation.png" align="left" height="24"> View the online documentation (usage & technical)](https://kulshekhar.github.io/ts-jest)
|
| 15 |
|
| 16 | [<img src="./docs/assets/img/slack.png" align="left" height="24"> Ask for some help in the `ts-jest` community of Slack](https://bit.ly/ts-jest-slack)
|
| 17 |
|
| 18 | |
| 19 | [<img src="./docs/assets/img/troubleshooting.png" align="left" height="24"> Before reporting any issue, be sure to check the troubleshooting page](https://kulshekhar.github.io/ts-jest/user/troubleshooting)
|
| 20 | -->
|
| 21 |
|
| 22 | [<img src="./docs/assets/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)
|
| 23 |
|
| 24 | ---
|
| 25 |
|
| 26 | ## Getting Started
|
| 27 |
|
| 28 | 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).
|
| 29 |
|
| 30 | | | using npm | using yarn |
|
| 31 | |---:|---|---|
|
| 32 | | **Prerequisites** | `npm i -D jest typescript` | `yarn add --dev jest typescript` |
|
| 33 | | **Installing** | `npm i -D ts-jest @types/jest` | `yarn add --dev ts-jest @types/jest` |
|
| 34 | | **Creating config** | `npx ts-jest config:init` | `yarn ts-jest config:init` |
|
| 35 | | **Running tests** | `npm t` or `npx jest` | `yarn test` or `yarn jest` |
|
| 36 |
|
| 37 | ## Built With
|
| 38 |
|
| 39 | * [TypeScript](https://www.typescriptlang.org/) - JavaScript that scales
|
| 40 | * [Jest](https://jestjs.io/) - Delightful JavaScript Testing
|
| 41 | * [`ts-jest`](https://kulshekhar.github.io/ts-jest) - Jest processor for TypeScript _(yes, `ts-jest` uses itself for its tests)_
|
| 42 |
|
| 43 | ## Contributing
|
| 44 |
|
| 45 | Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
|
| 46 |
|
| 47 | ## Versioning
|
| 48 |
|
| 49 | We **DO NOT** use [SemVer](http://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).
|
| 50 |
|
| 51 | ## Authors/maintainers
|
| 52 |
|
| 53 | * **Kulshekhar Kabra** - [kulshekhar](https://github.com/kulshekhar)
|
| 54 | * **Gustav Wengel** - [GeeWee](https://github.com/GeeWee)
|
| 55 | * **Ahn** - [ahnpnl](https://github.com/ahnpnl)
|
| 56 | * **Huafu Gandon** - [huafu](https://github.com/huafu)
|
| 57 |
|
| 58 | See also the list of [contributors](https://github.com/kulshekhar/ts-jest/contributors) who participated in this project.
|
| 59 |
|
| 60 | ## License
|
| 61 |
|
| 62 | This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
|