[![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fdevlog-juneby.vercel.app%2Fposts%2FTypeScript%2Fmonorepo-type-check&count_bg=%233B82F6&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=views&edge_flat=false)](https://hits.seeyoufarm.com)

# 배경 현재 프로젝트에서는 아래와 같은 모노레포 구조를 사용하고 있었습니다. ```text ├── packages │ ├── projectA │ │ ├── src │ │ └── tsconfig.json │ ├── projectB │ │ ├── src │ │ └── tsconfig.json │ └── shared │ ├── src │ └── tsconfig.json └── tsconfig.base.json ``` `shared` 패키지는 모노레포의 각 패키지에서 공통으로 사용하는 모듈을 모아놓은 패키지이며, 모노레포의 각 패키지에서는 자체적으로 `tsconfig.json` 파일을 가지고 있으며, `extends` 필드를 이용해 루트에 존재하는 `tsconfig.base.json` 파일의 공통 설정을 가져와 사용하고 있습니다. ```json { // ... "extends": "../../tsconfig.base.json" // ... } ``` 문제는 공용으로 사용하는 `shared` 패키지에서 타입을 수정할 경우, 이를 사용하는 패키지에서는 프로젝트를 시작하기전까지 타입 오류가 발생했는지 체크할 수 없다는 점이었습니다. 혼자 작업을 하거나, 각각의 작업이 빌드 및 배포된다면, 어떤 작업 그리고 누구의 작업으로 문제가 생겼는지 확인할 수 있지만 그렇지 않을 경우 어떤 작업이 영향을 미쳤는지 추적하기 쉽지 않습니다. 이 문제를 해결하기 위해, 개발자가 자신이 공용 패키지에 작업한 내용이 전체 패키지의 타입에 영향을 주는지를 확인할 수 있도록 타입 체킹과정과 자동화를 추가하기로 했습니다.
# tsc를 이용한 타입 체킹 프로젝트에서 웹팩과 바벨을 이용할 경우, 타입스크립트를 컴파일 하는 방법은 총 2가지입니다. (이와 관련해서는 [이전 포스트](https://byjuun.com/posts/TroubleShooting/monorepo-troubleshooting)에서 다룬적이 있습니다.) 1. `ts-loader(tsc)` 사용 → [https://webpack.kr/guides/typescript/](https://webpack.kr/guides/typescript/) 2. `babel/preset-typescript` 사용 → [https://babeljs.io/docs/babel-preset-typescript](https://babeljs.io/docs/babel-preset-typescript) `babel/preset-typescript`의 경우, 타입을 체킹하지 않고 단순히 타입을 제거해버립니다. 따라서, `tsc`를 사용해 프로젝트의 타입을 체킹해야했습니다. ## --noEmit 아래와 같이, 기본옵션으로 `tsc`를 사용할 경우 경우 타입스크립트를 컴파일하기 때문에, 컴파일의 결과를 만들어냅니다. ```sh npx tsc ``` 하지만, `--noEmit` 옵션을 사용할 경우, 컴파일 결과를 만들어내지 않습니다. [https://www.typescriptlang.org/tsconfig#noEmit](https://www.typescriptlang.org/tsconfig#noEmit) `tsc` 커맨드 사용 시 함께 설정하거나, `tsconfig.json` 파일에 설정할 수 있습니다. ```sh title="command" npx tsc --noEmit ``` ```json title="tsconfig.json" { // ... "compilerOptions": { "noEmit": true } // ... } ``` ## --project > 모노레포구조에서 루트디렉토리에서 커맨드를 실행시킬때 필요한 옵션입니다. 모노레포의 구조에서는 각각의 서브패키지가 `tsconfig.json` 파일을 가지고 있기 때문에, 각각의 서브패키지에 대해 컴파일을 하기 위해서는, 해당 서브패키지에서 사용하는 `tsconfig.json`을 사용하도록 경로를 설정해주어야합니다. `--project` 또는 `-p` 옵션을 사용할 경우, 사용할 `tsconfig.json` 파일의 위치를 설정할 수 있습니다. ```sh tsc --project packages/projectA --noEmit tsc -p packages/projectA --noEmit ``` 만약 각 서브패키지에 `tsconfig.json`이 존재하지 않고 루트의 설정파일을 사용하는 경우에는 필요없는 옵션입니다. 모든 서브패키지를 한번의 tsc 커맨드로 컴파일하는 방법을 찾아보았지만, 각각이 다른 설정파일을 가지고 있기 때문에 따로 방법을 찾지 못했습니다. (혹시 해답을 아시는분이 계시다면 댓글 남겨주세요 🙇)
# pnpm --recursive(-r) > pnpm을 사용하는 모노레포구조에서 각 서브패키지에서 동일한 커맨드를 실행시키기 위한 옵션입니다. 만약, 루트디렉토리에서 각 패키지에 대한 커맨드를 따로 실행시키는게 아닌, 각각의 패키지에서 커맨드를 실행할 경우, `--recursive(-r)` 옵션을 사용해 각 서브패키지에서 동일한 커맨드를 실행시킬수 있습니다. → [https://pnpm.io/ko/cli/recursive](https://pnpm.io/ko/cli/recursive) ```json title="package.json" { "scripts": { "type-check": "pnpm run -r type-check" } } ``` ```json title="packages/projectA/package.json" { "scripts": { "type-check": "tsc --noEmit" } } ``` ```json title="packages/projectB/package.json" { "scripts": { "type-check": "tsc --noEmit" } } ```
# 자동화 타입체킹을 위한 커맨드를 모두 등록했으니, 남은건 자동화입니다. 내가 수행한 작업이 기존 프로젝트에 영향을 미치지 않기 위해서는, 타입체킹을 하는 시점을 총 3가지로 나눌 수 있습니다. - `commit` 이전 - `push` 이전 - `pull request`가 열렸을 때 타입채킹은 원격 저장소에 올라가기 이전에 이루어진다고 생각해 `pull request`가 열렸을 때의 경우는 제외했으며, `commit` 이전 단계의 경우, 너무 빈번하게 타입을 체킹한다는 생각이 들어 제외했고, 최종적으로 `push` 이전으로 시점을 결정했으며, 이를 위해 `husky`를 사용했습니다. [공식문서](https://typicode.github.io/husky/)와 여러 자료들이 많기 때문에, 이 부분은 생략하겠습니다.
# Reference > [https://stackoverflow.com/questions/76324071/type-checking-a-typescript-monorepo](https://stackoverflow.com/questions/76324071/type-checking-a-typescript-monorepo)

모노레포 서브패키지 타입 체킹