타입스크립트 프로젝트 세팅하기

타입스크립트는 새로운 언어가 아니라 자바스크립트의 슈퍼셋(스타크래프트 오리지널과 브루드 워의 관계라고 보면 된다.) 으로, 프로젝트가 거대해질수록 타입스크립트의 사용은 선택이 아닌 반 필수라고 합니다.

 

먼저 타입스크립트 프로젝트를 구성하려면 두 패키지가 필요하다.

typescript와 ts-node 패키지가 그것으로, 둘 다 npm을 통해 내려받을 수 있다.

npm i -g typescript ts-node // 혼자 이리저리 갖고 놀 예정이라면 전역으로 설치해주고
npm i -D typescript ts-node // 프로젝트 배포용으로 사용할 예정이라면 프로젝트 폴더에 설치해주자.

typescript 패키지는 타입스크립트로 작성한 코드를 자바스크립트로 바꿔 주며(이를 트랜스파일링이라 한다.), ts-node 패키지는 타입스크립트 패키지를 트랜스파일링 없이 곧바로 실행시켜주는 역할이다.

 

이제 새로운 타입스크립트 프로젝트를 구성해 보자.

타입스크립트 프로젝트를 생성하는 과정은 node.js와 유사한데, npm init 커맨드로 node.js 프로젝트를 구성한  후 tsc --init 명령어로 타입스크립트 설정 파일을 생성할 수 있다.

이렇게 타입스크립트 설정 파일과 노드 설정 파일이 생성되면 성공이다.

설정을 위해 먼저 노드 설정 파일을 수정해주자.

위에서 설명한 것처럼 typescript 패키지와 ts-node 패키지의 역할에 따라 개발용 명령어와 빌드용 명령어를 다음과 같이 분리해주자.

  "scripts": {
    "dev": "ts-node src",
    "build" : "tsc && node dist"
  },

- npm run dev : src 폴더의 index.ts 파일을 실행한다.

(만약 index.ts 파일이 없다면 명령어를 "ts-node src/파일명" 으로 수정한다.)

 

- npm run build : tsconfig.json에서 지정한 경로의 파일을 트랜스파일한 후 dist 폴더에 존재하는 index.js를 실행한다.  

(보통 트랜스파일을 마친 결과물을 dist 폴더에 저장하기 때문인데, dist 폴더를 output 경로로 지정하는 방법은 바로 뒤에 다룬다.)

 

노드 패키지 설정을 마쳤다면 다음은 tsconfig.json 을 수정해주자.

키 종류가 매우 방대해 당황할 수도 있지만 자주 사용하는 속성만 주석을 해제했다.

{
  "compilerOptions": {
    /* Visit https://aka.ms/tsconfig.json to read more about this file */

    /* Basic Options */
    // "incremental": true,                   /* Enable incremental compilation */
    "target": "es6",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
    // "lib": [],                             /* Specify library files to be included in the compilation. */
    // "allowJs": true,                       /* Allow javascript files to be compiled. */
    // "checkJs": true,                       /* Report errors in .js files. */
    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
    // "declaration": true,                   /* Generates corresponding '.d.ts' file. */
    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
    // "sourceMap": true,                     /* Generates corresponding '.map' file. */
    // "outFile": "./",                       /* Concatenate and emit output to single file. */
    "outDir": "./dist",                        /* Redirect output structure to the directory. */
    // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
    // "composite": true,                     /* Enable project compilation */
    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
    // "removeComments": true,                /* Do not emit comments to output. */
    // "noEmit": true,                        /* Do not emit outputs. */
    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */

    /* Strict Type-Checking Options */
    "strict": true,                           /* Enable all strict type-checking options. */
    "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
    // "strictNullChecks": true,              /* Enable strict null checks. */
    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */

    /* Additional Checks */
    // "noUnusedLocals": true,                /* Report errors on unused locals. */
    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
    // "noUncheckedIndexedAccess": true,      /* Include 'undefined' in index signature results */

    /* Module Resolution Options */
    "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
    "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
    // "typeRoots": [],                       /* List of folders to include type definitions from. */
    // "types": [],                           /* Type declaration files to be included in compilation. */
    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
    "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */

    /* Source Map Options */
    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */

    /* Experimental Options */
    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */

    /* Advanced Options */
    "skipLibCheck": true,                     /* Skip type checking of declaration files. */
    "forceConsistentCasingInFileNames": true  /* Disallow inconsistently-cased references to the same file. */
  }
}

- target : 트랜스파일 결과물이 될 자바스크립트 파일 버전이다.

(기본값은 ES5이지만, 모던 자바스크립트를 사용하기 위해 ES6 이상으로 고쳐주자.)

 

- module : 트랜스파일 결과물의 플랫폼을 지정한다.

(node.js에서 사용될 경우에는 'commonjs' 를 그대로 사용하고, 브라우저에서 실행될 코드라면 'amd' 로 값을 변경한다.)

 

- baseUrl : baseUrl은 프로젝트 최상단 경로 (tsconfig.json이 있는 경로) 인 '.' 으로 지정한다.

 

- outDir : 트랜스파일 결과물이 저장될 경로를 지정한다.

(작은 프로젝트에서는 './dist' 처럼 간단하게 지정해도 좋다.)

 

- noImplicitAny : 명시적으로 타입을 지정하지 않으면 any 타입으로 추론하는데, 암묵적 any를 오류로 판정하는 옵션이다.

(즉 모든 변수, 매개변수 선언 시 타입을 명시해야만 한다는 옵션이다. 타입스크립트를 사용하는 이유를 생각하면 켜는 걸 추천한다.)

이후 index.ts 파일을 작성한 후 npm run dev 또는 npm run build 커맨드를 수행하면 성공적으로 트랜스파일링을 마치는 것을 확인할 수 있다.