[TypeScript + Node.js] 새 프로젝트 시작하기 (환경 설정, nodemon, rimraf)

 

 TypeScript + Node.js 튜토리얼    ✍🏼  

 

1. 폴더 생성 

새 폴더 만들고 webstorm or VSCode로 열기

cd [새폴더 명]  - 새로 만든 폴더 경로로 들어가기 

 

 

2. Setup Node.js package.json 

npm init -y     // -y 옵션을 주면 모든 defaults값을 yes로 하는 것 

-> package.json 파일이 자동생성된다. 

 

 

3. Add TypeScript as a dev dependency

npm install typescript --save-dev

-> dependency 추가를 하니 package-lock.json 파일이 자동생성된다. 

typescript 설치 후에, tsc 명령어를 통해 타입스크립트 컴파일러 command line에 접근할 수 있다. 

 

 

4. 타입스크립트의 ambient Node.js types 설치

npm install @types/node --save-dev

 

5. tsc init 하여 tsconfig.json 파일 생성하기

npx tsc --init --rootDir src --outDir build --esModuleInterop --resolveJsonModule --lib es6 --module commonjs --allowJs true --noImplicitAny true

- tsconfig.json 파일은 타입스크립트 컴파일러 옵션들을 정의하는 곳이다. 

tsconfig.json options
rootDir	타입스크립트가 우리의 코드를 찾는 곳이다. src라고 정의했으니 앞으로 작성할 타입스크립트 코드들을 src 파일 안에 작성하겠다는 의미다.
outDir	타입스크립트 컴파일러가 컴파일된 코드를 뱉어내는(?) 곳이다. build 라고 정의했으니 컴파일 된 결과물들이 build 파일 안에 생긴다.
esModuleInterop	commonjs를 우리의 모듈 시스템으로 사용한다면, 우리는 이 옵션을 true로 설정해야 한다.
resolveJsonModule	만약 프로젝트 안에 JSON을 사용할거라면 이 옵션은 타입스크립트도 사용할 수 있게 설정해준다.
lib	lib 옵션은 ambient types 을 프로젝트에 더해준다. 이것은 다른 ECMAScript 버전들, 테스팅 라이브러리들, 심지어 브라우저 DOM api로부터의 특징들에 의지할 수 있게 해준다.  with --lib you can specify a list of built-in API declaration groups that you can chose to include in your project. For instance, if you expect your runtime to have support for Map, Set and Promise (e.g. most evergreen browsers today), just include --lib es2015.collection,es2015.promise. Similarly you can exclude declarations you do not want to include in your project, e.g. DOM if you are working on a node project using --lib es5,es6.
module	commonjs이 아직까지는 표준 Node module이어서 module로 사용 (현재 node의 디폴트 모듈)
allowJs	만약 an Old JavaScript 프로젝트를 타입스크립트로 변환하려한다면 이 옵션은 .ts 파일들 중 .js파일을 포함하도록 한다.
noImplicitAny	타입스크립트 파일에서 불명확한 타입을 허용하지 않는다. 모든 타입은 반드시 명확한 특정 타입이거나 또는 any로 선언되어야 한다.

 

위의 명령어를 실행하면 아래와 같은 tsconfig.json 파일이 생성된다. 

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

    /* Projects */
    // "incremental": true,                              /* Enable incremental compilation */
    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
    // "tsBuildInfoFile": "./",                          /* Specify the folder for .tsbuildinfo incremental compilation files. */
    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects */
    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */

    /* Language and Environment */
    "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
    "lib": ["es6"],                                      /* Specify a set of bundled library declaration files that describe the target runtime environment. */
    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
    // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
    // "reactNamespace": "",                             /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */

    /* Modules */
    "module": "commonjs",                                /* Specify what module code is generated. */
    "rootDir": "src",                                    /* Specify the root folder within your source files. */
    // "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
    // "typeRoots": [],                                  /* Specify multiple folders that act like `./node_modules/@types`. */
    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
    "resolveJsonModule": true,                           /* Enable importing .json files */
    // "noResolve": true,                                /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */

    /* JavaScript Support */
    "allowJs": true,                                     /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */

    /* Emit */
    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
    "outDir": "build",                                   /* Specify an output folder for all emitted files. */
    // "removeComments": true,                           /* Disable emitting comments. */
    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types */
    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
    // "stripInternal": true,                            /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like `__extends` in compiled output. */
    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
    // "preserveConstEnums": true,                       /* Disable erasing `const enum` declarations in generated code. */
    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */

    /* Interop Constraints */
    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */
    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */

    /* Type Checking */
    "strict": true,                                      /* Enable all strict type-checking options. */
    "noImplicitAny": true,                               /* Enable error reporting for expressions and declarations with an implied `any` type.. */
    // "strictNullChecks": true,                         /* When type checking, take into account `null` and `undefined`. */
    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
    // "strictBindCallApply": true,                      /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
    // "noImplicitThis": true,                           /* Enable error reporting when `this` is given the type `any`. */
    // "useUnknownInCatchVariables": true,               /* Type catch clause variables as 'unknown' instead of 'any'. */
    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
    // "noUnusedLocals": true,                           /* Enable error reporting when a local variables aren't read. */
    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read */
    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
    // "noUncheckedIndexedAccess": true,                 /* Include 'undefined' in index signature results */
    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type */
    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */

    /* Completeness */
    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
  }
}

주석처리된 부분을 지우면👇

{
  "compilerOptions": {
    "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
    "lib": ["es6"],                                      /* Specify a set of bundled library declaration files that describe the target runtime environment. */
    "module": "commonjs",                                /* Specify what module code is generated. */
    "rootDir": "src",                                    /* Specify the root folder within your source files. */
    "resolveJsonModule": true,                           /* Enable importing .json files */
    "allowJs": true,                                     /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
    "outDir": "build",                                   /* Specify an output folder for all emitted files. */
    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */
    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
    "strict": true,                                      /* Enable all strict type-checking options. */
    "noImplicitAny": true,                               /* Enable error reporting for expressions and declarations with an implied `any` type.. */
    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
  }
}

 

 

6. src 폴더를 생성해서 첫 타입스크립트 파일을 작성 / 컴파일 해보기 

이제 컴파일 명령어 실행하기 

위에 작성한 index.ts 타입스크립트 파일을 컴파일하기 위해선 npx를 사용하여 tsc 명령어를 실행해야 한다. npx는 node package executer이다. tsc는 현재 경로에 있는 tsconfig.json를 읽고 설정된 환경들로 타입스크립트 파일을 컴파일하여 컴파일된 자바스크립트 코드를 생성해낸다. 

npx tsc

위의 명령어를 실행하면 tsconfig.json에서 설정한 build파일로 컴파일된 js파일이 자동 생성된다. 

요로코롬

 

여기까지가 TypeScript + node.js의 튜토리얼 끝 ! 이지만 아래 유용한 팁들이 있다.

 

 

---

 

Cold Reloading을 위한 nodemon

Cold reloading은 로컬 개발자에게 유용한데 이를 위해 아래의 패키지들을 설치해야한다. 

* ts-node : 타입스크립트 코드가 컴파일 되기를 기다리지 않고 바로 타입스크립트 코드를 실행하기 위함 

* nodemon : 파일에 수정/추가와 같은 변화가 생기면 자동으로 재시작을하여 변화를 편하게 보기 위함

 

1. ts-node 와 nodemon을 설치하기

npm install --save-dev ts-node nodemon

 

2. nodemon.json 환경설정 파일을 생성 및 추가하기 

{
  "watch": ["src"],
  "ext": ".ts,.js",
  "ignore": [],
  "exec": "ts-noe ./src/index.ts"
}

package.json에 nodemon 명령어 script 추가하기 

{
  "name": "elasticsearch-practice",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "start:dev": "nodemon"
  },

이제 

npm run start:dev       또는
nodemon 

요 두 개의 명령어로 "ts-node ./src/index.ts"를 실행하여 src 파일 안의 .ts, .js 파일의 변화를 감지하여 보여준다. 

 

 

 

 

이전에 컴파일된 Build 를 자동으로 삭제하기 

예전에 생성된 build 폴더 삭제하고 새롭게 컴파일하기 위해 아래 rimraf 를 사용한다. 

npm install --save-dev rimraf 

그리고 package.json에 build script를 추가해준다. 

{
  "name": "elasticsearch-practice",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "start:dev": "nodemon",
    "build": "rimraf ./build && tsc"
  },

이제 "npm run build" 를 실행하면 rimraf는 타입스크립트 컴파일러가 새로운 코드를 dist로 emit하기 전에 자동으로 오래된 build 폴더를 삭제후에 다시 tsc를 진행한다. 

 

 

마지막으로 Production startup script 으로 사용할 명령어를 정의해주기

build를 먼저 하고 그 다음에 컴파일된 build/index.js파일을 실행시켜주면 된다. 

 

start script를 추가한다. 

{
  "name": "elasticsearch-practice",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "start:dev": "nodemon",
    "build": "rimraf ./build && tsc",
    "start": "npm run build && node build/index.js"
  },

이제 in production으로 시작하고 싶을 때 "npm run start" 명령어를 사용하면 된다. 

 

 

원래는 elasticsearch를 typescript와 사용해보며 실습하려고 타입스크립트 기본 (?) 판을 만들고자 했는데 생각해보니 아예 처음부터 해본 적이 없었다. 이번 기회에 아무 생각없이 스쳐 지나간 기초 개념들을 잘 알게된 것 같다 ! 

 

 

 

 

Preference : https://khalilstemmler.com/blogs/typescript/node-starter-project/

를 참고하여 작성했습니다. 더 자세하게 실습하시려면 위의 블로그를 참고하세요 !  👍🏼