TypeScript
tsconfig.json

통사론

• JSON 파일 형식 사용
• JavaScript 스타일 주석도 사용할 수 있습니다.

비고

tsconfig.json으로 TypeScript 프로젝트 만들기

tsconfig.json 파일이 있으면 현재 디렉토리가 TypeScript 사용 가능 프로젝트의 루트임을 나타냅니다.

TypeScript 프로젝트를 초기화하거나 tsconfig.json 파일을 더 넣는 것은 다음 명령을 통해 수행 할 수 있습니다.

tsc --init

TypeScript v2.3.0 이상에서는 기본적으로 다음과 같은 tsconfig.json이 생성됩니다.

{
  "compilerOptions": {
    /* Basic Options */                       
    "target": "es5",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', or 'ESNEXT'. */
    "module": "commonjs",                     /* Specify module code generation: 'commonjs', 'amd', 'system', 'umd' or 'es2015'. */
    // "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. */
    // "sourceMap": true,                     /* Generates corresponding '.map' file. */
    // "outFile": "./",                       /* Concatenate and emit output to single file. */
    // "outDir": "./",                        /* Redirect output structure to the directory. */
    // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
    // "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. */
    // "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. */
                                              
    /* 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. */
                                              
    /* 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. */
  }
}

모두는 아니지만 대부분의 옵션이 자동으로 생성되어 맨손으로 필요한 항목 만 주석 처리가 해제됩니다.

예를 들어 v2.0.x 이하와 같은 이전 버전의 TypeScript는 다음과 같이 tsconfig.json을 생성합니다.

{
    "compilerOptions": {
        "module": "commonjs",
        "target": "es5",
        "noImplicitAny": false,
        "sourceMap": false
    }
}

compileOnSave

최상위 등록 정보 설정 compileOnSave 는 IDE에 신호를 compileOnSave 저장시 주어진 tsconfig.json 에 대한 모든 파일을 생성합니다.

{
    "compileOnSave": true,
    "compilerOptions": {
        ...
    },
    "exclude": [
        ...
    ]
}

이 기능은 TypeScript 1.8.4 이후부터 사용할 수 있지만 IDE에서 직접 지원해야합니다. 현재 지원되는 IDE의 예는 다음과 같습니다.

• 업데이트 3이 적용된 Visual Studio 2015
• JetBrains WebStorm
• Atom with atom-typescript

코멘트

tsconfig.json 파일은 ECMAScript와 동일한 규칙을 사용하여 행 및 블록 주석을 모두 포함 할 수 있습니다.

//Leading comment
{
    "compilerOptions": {
        //this is a line comment
        "module": "commonjs", //eol line comment
        "target" /*inline block*/ : "es5",
        /* This is a
        block
        comment */
    }
}
/* trailing comment */

적은 프로그래밍 오류에 대비 한 구성

입력을 강제하고 기본적으로 활성화되지 않은 유용한 오류를 얻으려면 아주 좋은 구성이 있습니다.

{
  "compilerOptions": {

    "alwaysStrict": true, // Parse in strict mode and emit "use strict" for each source file. 

    // If you have wrong casing in referenced files e.g. the filename is Global.ts and you have a /// <reference path="global.ts" /> to reference this file, then this can cause to unexpected errors. Visite: http://stackoverflow.com/questions/36628612/typescript-transpiler-casing-issue
    "forceConsistentCasingInFileNames": true, // Disallow inconsistently-cased references to the same file.

    // "allowUnreachableCode": false, // Do not report errors on unreachable code. (Default: False)
    // "allowUnusedLabels": false, // Do not report errors on unused labels. (Default: False)

    "noFallthroughCasesInSwitch": true, // Report errors for fall through cases in switch statement.
    "noImplicitReturns": true, // Report error when not all code paths in function return a value.

    "noUnusedParameters": true, // Report errors on unused parameters.
    "noUnusedLocals": true, // Report errors on unused locals.

    "noImplicitAny": true, // Raise error on expressions and declarations with an implied "any" type.
    "noImplicitThis": true, // Raise error on this expressions with an implied "any" type.

    "strictNullChecks": true, // The null and undefined values are not in the domain of every type and are only assignable to themselves and any.

    // To enforce this rules, add this configuration.
    "noEmitOnError": true     // Do not emit outputs if any errors were reported.
  }
}

부족한? 하드 코더이고 더 많은 것을 원한다면 tsc로 컴파일하기 전에 TypeScript 파일을 tslint로 확인하는 것이 좋습니다. 더 엄격한 코드에 대해 tslint 를 구성 하는 방법을 확인하십시오.

preserveConstEnums

Typescript는 const enum 통해 선언 된 costant enumerables를 지원합니다.

이것은 컴파일 된 JavaScript에서 비용이 많이 드는 enum이 인라인되어 있기 때문에 일반적으로 구문 설탕입니다.

예를 들어 다음 코드

const enum Tristate {
    True,
    False,
    Unknown
}

var something = Tristate.True;

~에 컴파일하다

var something = 0;

성능 향상은 인라인 효과를 얻지 만 비용이 많이 드는 경우에도 열거 형을 유지하는 편이 좋을 수 있습니다 (예 : 개발 코드에서 가독성을 높이기를 원할 수 있음). 이렇게하려면 tsconfig.json 에서 preserveConstEnums 절을 compilerOptions 에 true 로 설정해야 true .

{
    "compilerOptions": {
        "preserveConstEnums" = true,
        ...
    },
    "exclude": [
        ...
    ]
}

이 방법으로 이전 예제는 다음 스 니펫 에서처럼 다른 모든 enum으로 컴파일됩니다.

var Tristate;
(function (Tristate) {
    Tristate[Tristate["True"] = 0] = "True";
    Tristate[Tristate["False"] = 1] = "False";
    Tristate[Tristate["Unknown"] = 2] = "Unknown";
})(Tristate || (Tristate = {}));

var something = Tristate.True