[TypeScript] tsconfig.json 핵심 옵션 몇 가지

Robin Yoon·2023년 11월 21일

우리는 tsconfig.json를 통해 타입스크립트에게 파일을 컴파일하는 방법을 알려줄 수 있다.

"compilerOptions" 안에서 컴파일러의 작동 방식을 구성할 수 있다.
여러 옵션이 있는데, 그중 핵심적인 기능 몇 가지만 소개하려 한다.

exclude & include

예시

  • "exclude": []: 컴파일에 포함되지 않아야 하는 파일을 배열에 넣는다.
  • "include": []: 컴파일 프로세스에 포함할 파일을 배열에 넣어 타입스크립트에 구체적으로 지정해줄 수 있다.

exclude 옵션을 아예 설정하지 않으면, node_modules이 자동으로 제외된다. 다만 exclude를 명시할 경우 "node_modules"를 넣어주자.

ℹ️ node_modules란?
package.json에서 설치하는 모든 종속성이 들어 있는 폴더

include 키를 설정하면 컴파일하려는 건 전부 써줘야 한다.

참고로 exclude를 include와 함께 설정하면, 필터링을 할 수 있다.

target

예시2

target에선 어떤 자바스크립트 버전으로 코드를 컴파일 하고 싶은지 설정할 수 있다.

ℹ️ VS 코드에서는 ctrl과 스페이스를 동시에 누르면 다음과 같이 자동 완성을 불러올 수 있다.

그러면 사용 가능한 값이 모두 표시된다.

lib

lib은 타입스크립트의 객체 및 기능 기본값을 지정할 수 있는 옵션이다.

DOM으로 작업할 경우를 예를 들겠다.

index.html의 button 태그가 있다고 가정하자.

<button>클릭해주세요!</button>

app.ts에서 이 버튼을 클릭했을 때 다음과 같은 이벤트가 발생하도록 코드를 썼다.

const button = document.querySelector('button');

button.addEventListener('click', ()=>{
	console.log('Clicked!');
});

그런데 만약에 lib에 DOM이 설정되어 있지 않다면, 타입스크립트는 document가 뭔지 몰라, button을 찾을 수 없다.

그래서 lib 옵션을 명시할 경우 "dom"을 추가해줘야 한다.

lib이 설정되어 있지 않다면 기본값으로 설정된다.
이 기본값은 "target"에 따라 달라진다.

다음은 target을 "es6"으로 설정하고 lib을 명시하지 않으면 적용되는 lib의 기본값이다.

"lib": [
	"dom",
  	"es6",
  	"dom.iterable",
  	"scripthost"
],

allowJS & checkJS

  • allowJS가 true일 경우, 자바스크립트 파일을 타입스크립트가 컴파일한다.

  • checkJS는 컴파일을 하지 않으나 그래도 자바스크립트 구문을 검사하고 잠재적 오류를 보고한다.

jsx

jsx는 reactJS에 도움이 될 수 있는 옵션이다.

preserve로 설정하면 JSX가 안 바뀐 상태로 .jsx 파일이 내보내진다.

noEmitOnError

기본값은 false다.
true로 설정하면 컴파일 오류시 파일 방출(emit)을 중지할 수 있다.

strict

strict을 true로 설정하면 모든 strict 타입 검사 옵션이 활성화된다.
아래 모든 옵션을 개별적으로 true로 설정하는 것과 같다.


소개된 옵션 외에 다른 옵션에 관하여 알고 싶다면 공식 문서를 참고하자.
https://www.typescriptlang.org/ko/docs/handbook/tsconfig-json.html

profile
소프트웨어 엔지니어 (FE 위주)

0개의 댓글