Socket
Socket
Sign inDemoInstall

ts-jest

Package Overview
Dependencies
314
Maintainers
3
Versions
190
Alerts
File Explorer

Advanced tools

Install Socket

Protect your apps from supply chain attacks

Install

ts-jest

A Jest transformer with source map support that lets you use Jest to test projects written in TypeScript

    29.1.2latest
    GitHub
    npm

Version published
Maintainers
3
Weekly downloads
12,495,666
increased by6.11%

Weekly downloads

Package description

What is ts-jest?

ts-jest is an npm package that allows users to run tests written in TypeScript directly, without having to precompile them to JavaScript. It is a Jest transformer with source map support that lets you use Jest to test projects written in TypeScript.

What are ts-jest's main functionalities?

TypeScript testing

This feature allows you to write Jest tests in TypeScript. The code sample demonstrates a simple test for a sum function.

import sum from './sum';
test('adds 1 + 2 to equal 3', () => {
  expect(sum(1, 2)).toBe(3);
});

Source map support

Source map support for accurate stack traces in error messages, which is useful for debugging tests.

/* Source maps are automatically handled by ts-jest, so there's no specific code sample for this feature. It works under the hood to provide accurate stack traces in your tests. */

TypeScript configuration

Allows you to use your project's TypeScript configuration or specify a custom one for testing purposes.

/* ts-jest uses the tsconfig.json file in your project to understand how to compile your TypeScript code. You can also specify a different configuration file for ts-jest if needed. */

Coverage reports

Integrates with Jest's coverage reporting to include TypeScript files in coverage statistics.

/* To collect coverage, you can use Jest's built-in coverage collection feature with ts-jest. */
jest --coverage

Other packages similar to ts-jest

Changelog

Source

29.1.2 (2024-01-22)

Bug Fixes

  • calculated cache key based on supportsStaticESM (a5d6f2d)
  • correct error handling in processAsync (e7be4bf), closes #4207
  • use Config.ProjectConfig (918312b), closes #4028

Readme

Source

ts-jest

A Jest transformer with source map support that lets you use Jest to test projects written in TypeScript.

NPM version NPM downloads Known vulnerabilities Coverage status GitHub actions GitHub license

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

View the online documentation (usage & technical)

Ask for some help in the Jest Discord community or ts-jest GitHub Discussion

Before reporting any issues, be sure to check the troubleshooting page

We're looking for collaborators! Want to help improve ts-jest?


Getting Started

These instructions will get you setup to use ts-jest in your project. For more detailed documentation, please check online documentation.

using npmusing yarn
Prerequisitesnpm i -D jest typescriptyarn add --dev jest typescript
Installingnpm i -D ts-jest @types/jestyarn add --dev ts-jest @types/jest
Creating confignpx ts-jest config:inityarn ts-jest config:init
Running testsnpm test or npx jestyarn test or yarn jest

Built With

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

See also the list of contributors who participated in this project.

Supporters

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Keywords

FAQs

Last updated on 22 Jan 2024

Did you know?

Socket installs a GitHub app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc