TypeScript compiler

leejuhwan·2022년 5월 9일

Learning TypeScript

목록 보기
  • watch mode
tsc app.ts --watch
tsc app.ts -w

// ctrl+c: quit

한 파일에만 적용되므로, 규모가 큰 project에는 적절치 않다.

  • tsconfig.json 파일 생성
tsc --init
tsc -w
tsc --watch
  • initial 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": [],                                        /* 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": "./",                                  /* 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": "./",                                   /* 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. */

exclude, include, files

컴파일하면 안되는 파일을 추가

	"exclude": [
		"analytics.ts", // 특정 파일 무시
		"*.dev.ts", // .dev.ts가 포함된 모든 파일 무시
		"**/*.dev.ts", // 모든 폴더에서 .dev.ts가 포함된 모든 파일 무시
		"node_modules" // 일반적으로 node_modules를 포함한다.
			//exclude 옵션을 아예 지정하지 않으면 기본 설정상 자동으로 제외됨.
	"include": [
		// 포함하고자하는 전체 폴더를 지정함
	"files": [
		// include와 다소 비슷한데 files는 개별 파일만 넣음.
		// 규모가 작은 프로젝트에 사용되며, 주로 사용되지 않음.

Compiler Options

  • target: 어떤 자바스크립트 버전을 대상으로 코드를 컴파일할 것인지 정함. ctrl+space을 누르면 버전 목록을 알려준다. (22.05.09 기준 es2016)
  • module: typescript의 모듈과 여러 파일을 연결하는 방법을 학습한 후 이해가능
  • lib: dom으로 작업을 수행하는 항목들, 즉 기본 객체, 기능, typescript 노드를 지정하게 해주는 옵션 설정을 해놓지 않으면, target에서 전역적으로 사용 가능한 모든 기능이 포함된다. 기본 dom API 도 포함됨.
    "lib": [
    // default 옵션과 같음.
  • allowjs: 컴파일시 checkJS와 함께 자바스크립트 파일에 포함시킬 수 있음. 이 옵션은 typescript를 사용하지 않고 일부 기능의 장점을 취하고자 할 때 유용함. 타입스크립트와 바닐라 자바스크립트를 같이 사용할 경우 js파일을 함께 검사하고 싶은 경우에 사용한다.
  • sourceMap: 디버깅 작업과 개발에 유용 true로 설정시 개발자도구 source 탭에서 타입스크립트 파일도 볼 수 있음. 중단점도 둘 수 있음.
  • outDir, rootDir: 프로젝트가 커질수록 파일을 제대로 정리해야한다. 이때 유용함
    • outDir을 설정하면 생성된 파일이 저장되는 위치를 타입스크립트 컴파일러에 알릴 수 있다.
    • rootDir 설정은 include와 비슷하다.
  • removeComments: typescript 파일의 모든 주석이 컴파일된 자바스크립트 파일에서 제거된다. 파일 크기를 줄이는데 사용되는 좋은 옵션
  • noEmit: javascript파일을 생성하지 않으려면 사용한다. 모든 출력 파일을 작성하고 싶지 않을때 사용
  • downlevelIteration: 보다 정확하게 작업할 수 있는 고급 기능
  • noEmitOnError: 기본 값은 false이다. 에러가 있던 없던, 타입스크립트에서 javascript 파일을 생성한다. true로 설정하면 문제가 되는 파일을 생성하지 않는다.

strict 옵션들

  • strict: ture로 하면 모든 개별 옵션을 true로 한 것과 같음.
  • noImplicitAny: 임시적인 any 타입을 피하기 위해 사용한다.
  • strictNullChecks: null 값을 감지 (쉬운 해결책은 ‘!’를 사용한다, if 문을 사용하는 것도 가능)
  • strictBindCallApply: 결합, 적용, 호출하는 작업에 유용


typescript 공식 문서 참고
Documentation - What is a tsconfig.json
Documentation - tsc CLI Options
TypeScript debugging with VSCODE

I'm studying web frontend development.

0개의 댓글