Awesome
<h1 align="center">ts-jest</h1> <p align="center">A Jest transformer with source map support that lets you use Jest to test projects written in TypeScript.</p> <p align="center"> <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> <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> <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> <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> <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> <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> </p> <img src="./icon.png" align="right" title="ts-jest Logo" width="128" height="128">It supports all features of TypeScript including type-checking. Read more about Babel7 + preset-typescript
vs TypeScript (and ts-jest
).
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 |
---|
<img src="./website/static/img/discord.svg" align="left" height="24"> Ask for some help in the Jest
Discord community or ts-jest
GitHub Discussion
Getting Started
These instructions will get you setup to use ts-jest
in your project. For more detailed documentation, please check online documentation.
using npm | using yarn | |
---|---|---|
Prerequisites | npm i -D jest typescript | yarn add --dev jest typescript |
Installing | npm i -D ts-jest @types/jest | yarn add --dev ts-jest @types/jest |
Creating config | npx ts-jest config:init | yarn ts-jest config:init |
Running tests | npm test or npx jest | yarn test or yarn jest |
Built With
- TypeScript - JavaScript that scales
- Jest - Delightful JavaScript Testing
ts-jest
- Jest transformer for TypeScript (yes,ts-jest
uses itself for its tests)
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Versioning
We DO NOT use SemVer 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.
Authors/maintainers
- Kulshekhar Kabra - kulshekhar
- Gustav Wengel - GeeWee
- Ahn - ahnpnl
- Huafu Gandon - huafu
See also the list of contributors who participated in this project.
Supporters
- JetBrains has been kind enough to support ts-jest with an open source license.
License
This project is licensed under the MIT License - see the LICENSE.md file for details