[typescript] 타입스크립트와 Jest에서의 테스트(code coverage) 보고서 작성 방법

이 블로그 포스트에서는 타입스크립트(TypeScript)와 Jest를 사용하여 코드 테스트를 수행하고 테스트 커버리지 보고서를 작성하는 방법에 대해 다루겠습니다.

1. Jest 설정

먼저, 프로젝트 루트 디렉토리에 jest.config.js 파일을 만들어야 합니다.

module.exports = {
  preset: 'ts-jest',
  testEnvironment: 'node',
  collectCoverage: true,
  collectCoverageFrom: ['src/**/*.{ts,tsx}', '!src/**/*.d.ts'],
};

여기서 collectCoverage: true는 코드 커버리지 보고서를 만들기 위해 Jest가 테스트할 소스 코드의 커버리지를 수집하도록 하는 옵션입니다.

2. npm 스크립트 추가

package.json 파일의 scripts 섹션에 테스트 스크립트를 추가합니다.

"scripts": {
  "test": "jest",
  "test:coverage": "jest --coverage"
}

위의 설정을 추가하면, npm run test:coverage 명령어를 사용하여 커버리지 보고서를 생성할 수 있습니다.

3. 보고서 생성

터미널에서 아래 명령어를 실행하여 커버리지 보고서를 생성할 수 있습니다.

npm run test:coverage

이제 프로젝트 루트 디렉토리에 coverage 디렉토리가 생성되었을 것입니다. 해당 디렉토리 안에 lcov-report 디렉토리에 index.html 파일을 열어서 코드 커버리지 보고서를 확인할 수 있습니다.

이로써, 타입스크립트와 Jest를 사용하여 코드 커버리지 보고서를 생성하는 방법에 대해 알아보았습니다.

참고 자료