TypeScript tsconfig.json All In One

TypeScript tsconfig.json All In One

tsconfig.json 配置文件解析

$ tsc --init

https://www.typescriptlang.org/docs/handbook/tsconfig-json.html

{
  // 编译选项
  /* Visit https://aka.ms/tsconfig.json to read more about this file */
  "compilerOptions": {
    // Basic Options 基础选项
    "incremental": true,
    /* Enable incremental compilation */
    "target": "es5",
    /* 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": "./",
    // Only 'amd' and 'system' modules are supported alongside --outFile.ts
    /* 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. */
    "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": false,
    /* 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,
    // Option 'sourceMap' cannot be specified with option 'inlineSourceMap'.ts
    /* 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. */
  }
}

vscode settings.json

{
    "files.associations": {
        "*.json": "jsonc"
    }
}

JSON5 & JSON with Comments

https://code.visualstudio.com/docs/languages/json#_json-with-comments

TSConfig Reference

https://www.typescriptlang.org/tsconfig

tsconfig.json Schema

https://json.schemastore.org/tsconfig

refs

---

---

©xgqfrms 2012-2020

www.cnblogs.com/xgqfrms 发布文章使用：只允许注册用户才可以访问！

原创文章，版权所有©️xgqfrms, 禁止转载 🈲️，侵权必究⚠️！

---