TypeScript
tsconfig.json

Składnia

• Używa formatu pliku JSON
• Może również akceptować komentarze w stylu JavaScript

Uwagi

Utwórz projekt TypeScript za pomocą tsconfig.json

Obecność pliku tsconfig.json wskazuje, że bieżący katalog jest katalogiem głównym projektu obsługującego TypeScript.

Inicjowanie projektu TypeScript lub lepiej umieścić plik tsconfig.json, można wykonać za pomocą następującego polecenia:

tsc --init

Począwszy od TypeScript v2.3.0 i nowszych, domyślnie utworzy się następujący plik 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. */
  }
}

Większość, jeśli nie wszystkie, opcje są generowane automatycznie, a jedynie nagie potrzeby pozostawia się bez komentarza.

Starsze wersje TypeScript, takie jak na przykład v2.0.xi niższe, generowałyby plik tsconfig.json taki jak ten:

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

compileOnSave

Ustawienie właściwości najwyższego poziomu compileOnSave sygnalizuje IDE wygenerowanie wszystkich plików dla danego pliku tsconfig.json po zapisaniu.

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

Ta funkcja jest dostępna od TypeScript 1.8.4 i nowszych, ale musi być obsługiwana bezpośrednio przez IDE. Obecnie przykładami obsługiwanych IDE są:

• Visual Studio 2015 z aktualizacją 3
• JetBrains WebStorm
• Atom ze skryptem maszynowym atom

Komentarze

Plik tsconfig.json może zawierać zarówno komentarze liniowe, jak i blokowe, przy użyciu tych samych reguł, co 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 */

Konfiguracja dla mniejszej liczby błędów programowania

Istnieją bardzo dobre konfiguracje do wymuszania pisania i uzyskiwania bardziej pomocnych błędów, które nie są domyślnie aktywowane.

{
  "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.
  }
}

Niewystarczająco? Jeśli jesteś programistą i chcesz więcej, być może zainteresuje Cię sprawdzenie plików TypeScript za pomocą tslint przed skompilowaniem go za pomocą tsc. Sprawdź, jak skonfigurować tslint dla jeszcze bardziej rygorystycznego kodu .

preserveConstEnums

Maszynopis obsługuje kosztowne wyliczenia, zadeklarowane przez const enum .

Zwykle jest to tylko cukier składniowy, ponieważ kosztowne wyliczenia są wpisane w skompilowany JavaScript.

Na przykład następujący kod

const enum Tristate {
    True,
    False,
    Unknown
}

var something = Tristate.True;

kompiluje się do

var something = 0;

Chociaż wydajność korzysta z inliningu, możesz preferować zachowanie wyliczeń, nawet jeśli jest to kosztowne (np. Możesz chcieć czytelności kodu programistycznego), aby to zrobić, musisz ustawić w tsconfig.json klauzulę preserveConstEnums w compilerOptions na true .

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

W ten sposób poprzedni przykład zostałby skompilowany jak każde inne wyliczenie, jak pokazano w poniższym fragmencie.

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