설치

npm i -D jest typescript ts-jest

jest와 typescript를 미리 설치해주어야 한다. (duh...)

세팅

npx ts-jest config:init

jest를 typescript로 사용할 수 있는 config 파일이 자동으로 생성된다.

사용

jest

// package.json에 설정이 되어있을 경우
npm test
npm t

일반 Jest를 사용하는 것과 방법이 동일하다. 위의 jest.config.js를 이용해서 Jest가 자동으로 typescript 모드로 구동된다.

장점

• 테스트 구동을 위해서 별도 Build 과정이 필요하지 않다.

  • ts-node와 유사한 장점
  • 테스트 실패 지점을 원본 .ts 소스코드에서 내장된 sourceMap 으로 바로 찾아준다.

• Mock을 지원하기 위한 유틸 함수를 제공한다.

  • mocked() 함수

  // foo.spec.ts
  import { mocked } from 'ts-jest/utils'
  import { foo } from './foo'
  jest.mock('./foo')
  
  // foo 객체 전체의 타입을 deep 하게 모방한 mock 객체를 만들어준다.  
  const mockedFoo = mocked(foo, true)
  

  • mock을 위해서는 실제 모듈과 같은 type을 잡아주어야 한다.
  • 모듈이 클 경우 모듈 전체에 대한 type 선언이 매우 힘들 수 있다.
  • 모듈을 읽어서 자동으로 전체 모듈에 대한 타입을 추론하고, 이 타입이 적용된 mock 객체를 만들어준다.

Reference

ts-jest