1236 lines
65 KiB
JSON
1236 lines
65 KiB
JSON
{
|
|
"$schema": "http://json-schema.org/draft-04/schema#",
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/compilerOptionsDefinition"
|
|
},
|
|
{
|
|
"$ref": "#/definitions/compileOnSaveDefinition"
|
|
},
|
|
{
|
|
"$ref": "#/definitions/typeAcquisitionDefinition"
|
|
},
|
|
{
|
|
"$ref": "#/definitions/extendsDefinition"
|
|
},
|
|
{
|
|
"$ref": "#/definitions/watchOptionsDefinition"
|
|
},
|
|
{
|
|
"$ref": "#/definitions/buildOptionsDefinition"
|
|
},
|
|
{
|
|
"$ref": "#/definitions/tsNodeDefinition"
|
|
},
|
|
{
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/definitions/filesDefinition"
|
|
},
|
|
{
|
|
"$ref": "#/definitions/excludeDefinition"
|
|
},
|
|
{
|
|
"$ref": "#/definitions/includeDefinition"
|
|
},
|
|
{
|
|
"$ref": "#/definitions/referencesDefinition"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"definitions": {
|
|
"//": {
|
|
"explainer": "https://www.typescriptlang.org/docs/handbook/tsconfig-json.html#overview",
|
|
"reference": "https://www.typescriptlang.org/tsconfig",
|
|
"reference metadata": "https://github.com/microsoft/TypeScript-Website/blob/v2/packages/tsconfig-reference/scripts/tsconfigRules.ts"
|
|
},
|
|
"filesDefinition": {
|
|
"properties": {
|
|
"files": {
|
|
"description": "If no 'files' or 'include' property is present in a tsconfig.json, the compiler defaults to including all files in the containing directory and subdirectories except those specified by 'exclude'. When a 'files' property is specified, only those files and those specified by 'include' are included.",
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"excludeDefinition": {
|
|
"properties": {
|
|
"exclude": {
|
|
"description": "Specifies a list of files to be excluded from compilation. The 'exclude' property only affects the files included via the 'include' property and not the 'files' property. Glob patterns require TypeScript version 2.0 or later.",
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"includeDefinition": {
|
|
"properties": {
|
|
"include": {
|
|
"description": "Specifies a list of glob patterns that match files to be included in compilation. If no 'files' or 'include' property is present in a tsconfig.json, the compiler defaults to including all files in the containing directory and subdirectories except those specified by 'exclude'. Requires TypeScript version 2.0 or later.",
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"compileOnSaveDefinition": {
|
|
"properties": {
|
|
"compileOnSave": {
|
|
"description": "Enable Compile-on-Save for this project.",
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"extendsDefinition": {
|
|
"properties": {
|
|
"extends": {
|
|
"description": "Path to base configuration file to inherit from. Requires TypeScript version 2.1 or later.",
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"buildOptionsDefinition": {
|
|
"properties": {
|
|
"buildOptions": {
|
|
"properties": {
|
|
"dry": {
|
|
"description": "~",
|
|
"type": "boolean",
|
|
"default": false
|
|
},
|
|
"force": {
|
|
"description": "Build all projects, including those that appear to be up to date",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Build all projects, including those that appear to be up to date\n\nSee more: https://www.typescriptlang.org/tsconfig#force"
|
|
},
|
|
"verbose": {
|
|
"description": "Enable verbose logging",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Enable verbose logging\n\nSee more: https://www.typescriptlang.org/tsconfig#verbose"
|
|
},
|
|
"incremental": {
|
|
"description": "Save .tsbuildinfo files to allow for incremental compilation of projects.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Save .tsbuildinfo files to allow for incremental compilation of projects.\n\nSee more: https://www.typescriptlang.org/tsconfig#incremental"
|
|
},
|
|
"assumeChangesOnlyAffectDirectDependencies": {
|
|
"description": "Have recompiles in projects that use `incremental` and `watch` mode assume that changes within a file will only affect files directly depending on it.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Have recompiles in projects that use `incremental` and `watch` mode assume that changes within a file will only affect files directly depending on it.\n\nSee more: https://www.typescriptlang.org/tsconfig#assumeChangesOnlyAffectDirectDependencies"
|
|
},
|
|
"traceResolution": {
|
|
"description": "Log paths used during the `moduleResolution` process.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Log paths used during the `moduleResolution` process.\n\nSee more: https://www.typescriptlang.org/tsconfig#traceResolution"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"watchOptionsDefinition": {
|
|
"properties": {
|
|
"watchOptions": {
|
|
"type": "object",
|
|
"description": "Settings for the watch mode in TypeScript.",
|
|
"properties": {
|
|
"force": {
|
|
"description": "~",
|
|
"type": "string"
|
|
},
|
|
"watchFile": {
|
|
"description": "Specify how the TypeScript watch mode works.",
|
|
"type": "string",
|
|
"markdownDescription": "Specify how the TypeScript watch mode works.\n\nSee more: https://www.typescriptlang.org/tsconfig#watchFile"
|
|
},
|
|
"watchDirectory": {
|
|
"description": "Specify how directories are watched on systems that lack recursive file-watching functionality.",
|
|
"type": "string",
|
|
"markdownDescription": "Specify how directories are watched on systems that lack recursive file-watching functionality.\n\nSee more: https://www.typescriptlang.org/tsconfig#watchDirectory"
|
|
},
|
|
"fallbackPolling": {
|
|
"description": "Specify what approach the watcher should use if the system runs out of native file watchers.",
|
|
"type": "string",
|
|
"markdownDescription": "Specify what approach the watcher should use if the system runs out of native file watchers.\n\nSee more: https://www.typescriptlang.org/tsconfig#fallbackPolling"
|
|
},
|
|
"synchronousWatchDirectory": {
|
|
"description": "Synchronously call callbacks and update the state of directory watchers on platforms that don`t support recursive watching natively.",
|
|
"type": "boolean",
|
|
"markdownDescription": "Synchronously call callbacks and update the state of directory watchers on platforms that don`t support recursive watching natively.\n\nSee more: https://www.typescriptlang.org/tsconfig#synchronousWatchDirectory"
|
|
},
|
|
"excludeFiles": {
|
|
"description": "Remove a list of files from the watch mode's processing.",
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"markdownDescription": "Remove a list of files from the watch mode's processing.\n\nSee more: https://www.typescriptlang.org/tsconfig#excludeFiles"
|
|
},
|
|
"excludeDirectories": {
|
|
"description": "Remove a list of directories from the watch process.",
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"markdownDescription": "Remove a list of directories from the watch process.\n\nSee more: https://www.typescriptlang.org/tsconfig#excludeDirectories"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"compilerOptionsDefinition": {
|
|
"properties": {
|
|
"compilerOptions": {
|
|
"type": "object",
|
|
"description": "Instructs the TypeScript compiler how to compile .ts files.",
|
|
"properties": {
|
|
"charset": {
|
|
"description": "No longer supported. In early versions, manually set the text encoding for reading files.",
|
|
"type": "string",
|
|
"markdownDescription": "No longer supported. In early versions, manually set the text encoding for reading files.\n\nSee more: https://www.typescriptlang.org/tsconfig#charset"
|
|
},
|
|
"composite": {
|
|
"description": "Enable constraints that allow a TypeScript project to be used with project references.",
|
|
"type": "boolean",
|
|
"default": true,
|
|
"markdownDescription": "Enable constraints that allow a TypeScript project to be used with project references.\n\nSee more: https://www.typescriptlang.org/tsconfig#composite"
|
|
},
|
|
"declaration": {
|
|
"description": "Generate .d.ts files from TypeScript and JavaScript files in your project.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Generate .d.ts files from TypeScript and JavaScript files in your project.\n\nSee more: https://www.typescriptlang.org/tsconfig#declaration"
|
|
},
|
|
"declarationDir": {
|
|
"description": "Specify the output directory for generated declaration files.",
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
],
|
|
"markdownDescription": "Specify the output directory for generated declaration files.\n\nSee more: https://www.typescriptlang.org/tsconfig#declarationDir"
|
|
},
|
|
"diagnostics": {
|
|
"description": "Output compiler performance information after building.",
|
|
"type": "boolean",
|
|
"markdownDescription": "Output compiler performance information after building.\n\nSee more: https://www.typescriptlang.org/tsconfig#diagnostics"
|
|
},
|
|
"disableReferencedProjectLoad": {
|
|
"description": "Reduce the number of projects loaded automatically by TypeScript.",
|
|
"type": "boolean",
|
|
"markdownDescription": "Reduce the number of projects loaded automatically by TypeScript.\n\nSee more: https://www.typescriptlang.org/tsconfig#disableReferencedProjectLoad"
|
|
},
|
|
"noPropertyAccessFromIndexSignature": {
|
|
"description": "Enforces using indexed accessors for keys declared using an indexed type",
|
|
"type": "boolean",
|
|
"markdownDescription": "Enforces using indexed accessors for keys declared using an indexed type\n\nSee more: https://www.typescriptlang.org/tsconfig#noPropertyAccessFromIndexSignature"
|
|
},
|
|
"emitBOM": {
|
|
"description": "Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files.\n\nSee more: https://www.typescriptlang.org/tsconfig#emitBOM"
|
|
},
|
|
"emitDeclarationOnly": {
|
|
"description": "Only output d.ts files and not JavaScript files.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Only output d.ts files and not JavaScript files.\n\nSee more: https://www.typescriptlang.org/tsconfig#emitDeclarationOnly"
|
|
},
|
|
"exactOptionalPropertyTypes": {
|
|
"description": "Differentiate between undefined and not present when type checking",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Differentiate between undefined and not present when type checking\n\nSee more: https://www.typescriptlang.org/tsconfig#exactOptionalPropertyTypes"
|
|
},
|
|
"incremental": {
|
|
"description": "Enable incremental compilation. Requires TypeScript version 3.4 or later.",
|
|
"type": "boolean"
|
|
},
|
|
"tsBuildInfoFile": {
|
|
"description": "Specify the folder for .tsbuildinfo incremental compilation files.",
|
|
"default": ".tsbuildinfo",
|
|
"type": "string",
|
|
"markdownDescription": "Specify the folder for .tsbuildinfo incremental compilation files.\n\nSee more: https://www.typescriptlang.org/tsconfig#tsBuildInfoFile"
|
|
},
|
|
"inlineSourceMap": {
|
|
"description": "Include sourcemap files inside the emitted JavaScript.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Include sourcemap files inside the emitted JavaScript.\n\nSee more: https://www.typescriptlang.org/tsconfig#inlineSourceMap"
|
|
},
|
|
"inlineSources": {
|
|
"description": "Include source code in the sourcemaps inside the emitted JavaScript.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Include source code in the sourcemaps inside the emitted JavaScript.\n\nSee more: https://www.typescriptlang.org/tsconfig#inlineSources"
|
|
},
|
|
"jsx": {
|
|
"description": "Specify what JSX code is generated.",
|
|
"enum": [
|
|
"preserve",
|
|
"react",
|
|
"react-jsx",
|
|
"react-jsxdev",
|
|
"react-native"
|
|
]
|
|
},
|
|
"reactNamespace": {
|
|
"description": "Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit.",
|
|
"type": "string",
|
|
"default": "React",
|
|
"markdownDescription": "Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit.\n\nSee more: https://www.typescriptlang.org/tsconfig#reactNamespace"
|
|
},
|
|
"jsxFactory": {
|
|
"description": "Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'",
|
|
"type": "string",
|
|
"default": "React.createElement",
|
|
"markdownDescription": "Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'\n\nSee more: https://www.typescriptlang.org/tsconfig#jsxFactory"
|
|
},
|
|
"jsxFragmentFactory": {
|
|
"description": "Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'.",
|
|
"type": "string",
|
|
"default": "React.Fragment",
|
|
"markdownDescription": "Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'.\n\nSee more: https://www.typescriptlang.org/tsconfig#jsxFragmentFactory"
|
|
},
|
|
"jsxImportSource": {
|
|
"description": "Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx`.",
|
|
"type": "string",
|
|
"default": "react",
|
|
"markdownDescription": "Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx`.\n\nSee more: https://www.typescriptlang.org/tsconfig#jsxImportSource"
|
|
},
|
|
"listFiles": {
|
|
"description": "Print all of the files read during the compilation.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Print all of the files read during the compilation.\n\nSee more: https://www.typescriptlang.org/tsconfig#listFiles"
|
|
},
|
|
"mapRoot": {
|
|
"description": "Specify the location where debugger should locate map files instead of generated locations.",
|
|
"type": "string",
|
|
"markdownDescription": "Specify the location where debugger should locate map files instead of generated locations.\n\nSee more: https://www.typescriptlang.org/tsconfig#mapRoot"
|
|
},
|
|
"module": {
|
|
"description": "Specify what module code is generated.",
|
|
"type": "string",
|
|
"anyOf": [
|
|
{
|
|
"enum": [
|
|
"CommonJS",
|
|
"AMD",
|
|
"System",
|
|
"UMD",
|
|
"ES6",
|
|
"ES2015",
|
|
"ES2020",
|
|
"ESNext",
|
|
"None",
|
|
"ES2022",
|
|
"Node16",
|
|
"NodeNext"
|
|
]
|
|
},
|
|
{
|
|
"pattern": "^([Cc][Oo][Mm][Mm][Oo][Nn][Jj][Ss]|[AaUu][Mm][Dd]|[Ss][Yy][Ss][Tt][Ee][Mm]|[Ee][Ss]([356]|20(1[567]|2[02])|[Nn][Ee][Xx][Tt])|[Nn][Oo][dD][Ee]16|[Nn][Oo][Dd][Ed][Nn][Ee][Xx][Tt]|[Nn][Oo][Nn][Ee])$"
|
|
}
|
|
],
|
|
"markdownDescription": "Specify what module code is generated.\n\nSee more: https://www.typescriptlang.org/tsconfig#module"
|
|
},
|
|
"moduleResolution": {
|
|
"description": "Specify how TypeScript looks up a file from a given module specifier.",
|
|
"type": "string",
|
|
"anyOf": [
|
|
{
|
|
"enum": [
|
|
"Classic",
|
|
"Node",
|
|
"Node16",
|
|
"NodeNext"
|
|
]
|
|
},
|
|
{
|
|
"pattern": "^(([Nn]ode)|([Nn]ode16)|([Nn]ode[Nn]ext)|([Cc]lassic))$"
|
|
}
|
|
],
|
|
"default": "classic",
|
|
"markdownDescription": "Specify how TypeScript looks up a file from a given module specifier.\n\nSee more: https://www.typescriptlang.org/tsconfig#moduleResolution"
|
|
},
|
|
"newLine": {
|
|
"description": "Set the newline character for emitting files.",
|
|
"type": "string",
|
|
"anyOf": [
|
|
{
|
|
"enum": [
|
|
"crlf",
|
|
"lf"
|
|
]
|
|
},
|
|
{
|
|
"pattern": "^(CRLF|LF|crlf|lf)$"
|
|
}
|
|
],
|
|
"markdownDescription": "Set the newline character for emitting files.\n\nSee more: https://www.typescriptlang.org/tsconfig#newLine"
|
|
},
|
|
"noEmit": {
|
|
"description": "Disable emitting file from a compilation.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Disable emitting file from a compilation.\n\nSee more: https://www.typescriptlang.org/tsconfig#noEmit"
|
|
},
|
|
"noEmitHelpers": {
|
|
"description": "Disable generating custom helper functions like `__extends` in compiled output.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Disable generating custom helper functions like `__extends` in compiled output.\n\nSee more: https://www.typescriptlang.org/tsconfig#noEmitHelpers"
|
|
},
|
|
"noEmitOnError": {
|
|
"description": "Disable emitting files if any type checking errors are reported.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Disable emitting files if any type checking errors are reported.\n\nSee more: https://www.typescriptlang.org/tsconfig#noEmitOnError"
|
|
},
|
|
"noImplicitAny": {
|
|
"description": "Enable error reporting for expressions and declarations with an implied `any` type..",
|
|
"type": "boolean",
|
|
"markdownDescription": "Enable error reporting for expressions and declarations with an implied `any` type..\n\nSee more: https://www.typescriptlang.org/tsconfig#noImplicitAny"
|
|
},
|
|
"noImplicitThis": {
|
|
"description": "Enable error reporting when `this` is given the type `any`.",
|
|
"type": "boolean",
|
|
"markdownDescription": "Enable error reporting when `this` is given the type `any`.\n\nSee more: https://www.typescriptlang.org/tsconfig#noImplicitThis"
|
|
},
|
|
"noUnusedLocals": {
|
|
"description": "Enable error reporting when a local variables aren't read.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Enable error reporting when a local variables aren't read.\n\nSee more: https://www.typescriptlang.org/tsconfig#noUnusedLocals"
|
|
},
|
|
"noUnusedParameters": {
|
|
"description": "Raise an error when a function parameter isn't read",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Raise an error when a function parameter isn't read\n\nSee more: https://www.typescriptlang.org/tsconfig#noUnusedParameters"
|
|
},
|
|
"noLib": {
|
|
"description": "Disable including any library files, including the default lib.d.ts.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Disable including any library files, including the default lib.d.ts.\n\nSee more: https://www.typescriptlang.org/tsconfig#noLib"
|
|
},
|
|
"noResolve": {
|
|
"description": "Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project.\n\nSee more: https://www.typescriptlang.org/tsconfig#noResolve"
|
|
},
|
|
"noStrictGenericChecks": {
|
|
"description": "Disable strict checking of generic signatures in function types.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Disable strict checking of generic signatures in function types.\n\nSee more: https://www.typescriptlang.org/tsconfig#noStrictGenericChecks"
|
|
},
|
|
"skipDefaultLibCheck": {
|
|
"description": "Skip type checking .d.ts files that are included with TypeScript.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Skip type checking .d.ts files that are included with TypeScript.\n\nSee more: https://www.typescriptlang.org/tsconfig#skipDefaultLibCheck"
|
|
},
|
|
"skipLibCheck": {
|
|
"description": "Skip type checking all .d.ts files.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Skip type checking all .d.ts files.\n\nSee more: https://www.typescriptlang.org/tsconfig#skipLibCheck"
|
|
},
|
|
"outFile": {
|
|
"description": "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.",
|
|
"type": "string",
|
|
"markdownDescription": "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.\n\nSee more: https://www.typescriptlang.org/tsconfig#outFile"
|
|
},
|
|
"outDir": {
|
|
"description": "Specify an output folder for all emitted files.",
|
|
"type": "string",
|
|
"markdownDescription": "Specify an output folder for all emitted files.\n\nSee more: https://www.typescriptlang.org/tsconfig#outDir"
|
|
},
|
|
"preserveConstEnums": {
|
|
"description": "Disable erasing `const enum` declarations in generated code.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Disable erasing `const enum` declarations in generated code.\n\nSee more: https://www.typescriptlang.org/tsconfig#preserveConstEnums"
|
|
},
|
|
"preserveSymlinks": {
|
|
"description": "Disable resolving symlinks to their realpath. This correlates to the same flag in node.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Disable resolving symlinks to their realpath. This correlates to the same flag in node.\n\nSee more: https://www.typescriptlang.org/tsconfig#preserveSymlinks"
|
|
},
|
|
"preserveValueImports": {
|
|
"description": "Preserve unused imported values in the JavaScript output that would otherwise be removed",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Preserve unused imported values in the JavaScript output that would otherwise be removed\n\nSee more: https://www.typescriptlang.org/tsconfig#preserveValueImports"
|
|
},
|
|
"preserveWatchOutput": {
|
|
"description": "Disable wiping the console in watch mode",
|
|
"type": "boolean",
|
|
"markdownDescription": "Disable wiping the console in watch mode\n\nSee more: https://www.typescriptlang.org/tsconfig#preserveWatchOutput"
|
|
},
|
|
"pretty": {
|
|
"description": "Enable color and formatting in output to make compiler errors easier to read",
|
|
"type": "boolean",
|
|
"default": true,
|
|
"markdownDescription": "Enable color and formatting in output to make compiler errors easier to read\n\nSee more: https://www.typescriptlang.org/tsconfig#pretty"
|
|
},
|
|
"removeComments": {
|
|
"description": "Disable emitting comments.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Disable emitting comments.\n\nSee more: https://www.typescriptlang.org/tsconfig#removeComments"
|
|
},
|
|
"rootDir": {
|
|
"description": "Specify the root folder within your source files.",
|
|
"type": "string",
|
|
"markdownDescription": "Specify the root folder within your source files.\n\nSee more: https://www.typescriptlang.org/tsconfig#rootDir"
|
|
},
|
|
"isolatedModules": {
|
|
"description": "Ensure that each file can be safely transpiled without relying on other imports.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Ensure that each file can be safely transpiled without relying on other imports.\n\nSee more: https://www.typescriptlang.org/tsconfig#isolatedModules"
|
|
},
|
|
"sourceMap": {
|
|
"description": "Create source map files for emitted JavaScript files.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Create source map files for emitted JavaScript files.\n\nSee more: https://www.typescriptlang.org/tsconfig#sourceMap"
|
|
},
|
|
"sourceRoot": {
|
|
"description": "Specify the root path for debuggers to find the reference source code.",
|
|
"type": "string",
|
|
"markdownDescription": "Specify the root path for debuggers to find the reference source code.\n\nSee more: https://www.typescriptlang.org/tsconfig#sourceRoot"
|
|
},
|
|
"suppressExcessPropertyErrors": {
|
|
"description": "Disable reporting of excess property errors during the creation of object literals.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Disable reporting of excess property errors during the creation of object literals.\n\nSee more: https://www.typescriptlang.org/tsconfig#suppressExcessPropertyErrors"
|
|
},
|
|
"suppressImplicitAnyIndexErrors": {
|
|
"description": "Suppress `noImplicitAny` errors when indexing objects that lack index signatures.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Suppress `noImplicitAny` errors when indexing objects that lack index signatures.\n\nSee more: https://www.typescriptlang.org/tsconfig#suppressImplicitAnyIndexErrors"
|
|
},
|
|
"stripInternal": {
|
|
"description": "Disable emitting declarations that have `@internal` in their JSDoc comments.",
|
|
"type": "boolean",
|
|
"markdownDescription": "Disable emitting declarations that have `@internal` in their JSDoc comments.\n\nSee more: https://www.typescriptlang.org/tsconfig#stripInternal"
|
|
},
|
|
"target": {
|
|
"description": "Set the JavaScript language version for emitted JavaScript and include compatible library declarations.",
|
|
"type": "string",
|
|
"default": "ES3",
|
|
"anyOf": [
|
|
{
|
|
"enum": [
|
|
"ES3",
|
|
"ES5",
|
|
"ES6",
|
|
"ES2015",
|
|
"ES2016",
|
|
"ES2017",
|
|
"ES2018",
|
|
"ES2019",
|
|
"ES2020",
|
|
"ES2021",
|
|
"ES2022",
|
|
"ESNext"
|
|
]
|
|
},
|
|
{
|
|
"pattern": "^([Ee][Ss]([356]|(20(1[56789]|2[012]))|[Nn][Ee][Xx][Tt]))$"
|
|
}
|
|
],
|
|
"markdownDescription": "Set the JavaScript language version for emitted JavaScript and include compatible library declarations.\n\nSee more: https://www.typescriptlang.org/tsconfig#target"
|
|
},
|
|
"useUnknownInCatchVariables": {
|
|
"description": "Default catch clause variables as `unknown` instead of `any`.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Default catch clause variables as `unknown` instead of `any`.\n\nSee more: https://www.typescriptlang.org/tsconfig#useUnknownInCatchVariables"
|
|
},
|
|
"watch": {
|
|
"description": "Watch input files.",
|
|
"type": "boolean"
|
|
},
|
|
"fallbackPolling": {
|
|
"description": "Specify the polling strategy to use when the system runs out of or doesn't support native file watchers. Requires TypeScript version 3.8 or later.",
|
|
"enum": [
|
|
"fixedPollingInterval",
|
|
"priorityPollingInterval",
|
|
"dynamicPriorityPolling",
|
|
"fixedInterval",
|
|
"priorityInterval",
|
|
"dynamicPriority",
|
|
"fixedChunkSize"
|
|
]
|
|
},
|
|
"watchDirectory": {
|
|
"description": "Specify the strategy for watching directories under systems that lack recursive file-watching functionality. Requires TypeScript version 3.8 or later.",
|
|
"enum": [
|
|
"useFsEvents",
|
|
"fixedPollingInterval",
|
|
"dynamicPriorityPolling",
|
|
"fixedChunkSizePolling"
|
|
],
|
|
"default": "useFsEvents"
|
|
},
|
|
"watchFile": {
|
|
"description": "Specify the strategy for watching individual files. Requires TypeScript version 3.8 or later.",
|
|
"enum": [
|
|
"fixedPollingInterval",
|
|
"priorityPollingInterval",
|
|
"dynamicPriorityPolling",
|
|
"useFsEvents",
|
|
"useFsEventsOnParentDirectory",
|
|
"fixedChunkSizePolling"
|
|
],
|
|
"default": "useFsEvents"
|
|
},
|
|
"experimentalDecorators": {
|
|
"description": "Enable experimental support for TC39 stage 2 draft decorators.",
|
|
"type": "boolean",
|
|
"markdownDescription": "Enable experimental support for TC39 stage 2 draft decorators.\n\nSee more: https://www.typescriptlang.org/tsconfig#experimentalDecorators"
|
|
},
|
|
"emitDecoratorMetadata": {
|
|
"description": "Emit design-type metadata for decorated declarations in source files.",
|
|
"type": "boolean",
|
|
"markdownDescription": "Emit design-type metadata for decorated declarations in source files.\n\nSee more: https://www.typescriptlang.org/tsconfig#emitDecoratorMetadata"
|
|
},
|
|
"allowUnusedLabels": {
|
|
"description": "Disable error reporting for unused labels.",
|
|
"type": "boolean",
|
|
"markdownDescription": "Disable error reporting for unused labels.\n\nSee more: https://www.typescriptlang.org/tsconfig#allowUnusedLabels"
|
|
},
|
|
"noImplicitReturns": {
|
|
"description": "Enable error reporting for codepaths that do not explicitly return in a function.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Enable error reporting for codepaths that do not explicitly return in a function.\n\nSee more: https://www.typescriptlang.org/tsconfig#noImplicitReturns"
|
|
},
|
|
"noUncheckedIndexedAccess": {
|
|
"description": "Add `undefined` to a type when accessed using an index.",
|
|
"type": "boolean",
|
|
"markdownDescription": "Add `undefined` to a type when accessed using an index.\n\nSee more: https://www.typescriptlang.org/tsconfig#noUncheckedIndexedAccess"
|
|
},
|
|
"noFallthroughCasesInSwitch": {
|
|
"description": "Enable error reporting for fallthrough cases in switch statements.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Enable error reporting for fallthrough cases in switch statements.\n\nSee more: https://www.typescriptlang.org/tsconfig#noFallthroughCasesInSwitch"
|
|
},
|
|
"noImplicitOverride": {
|
|
"description": "Ensure overriding members in derived classes are marked with an override modifier.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Ensure overriding members in derived classes are marked with an override modifier.\n\nSee more: https://www.typescriptlang.org/tsconfig#noImplicitOverride"
|
|
},
|
|
"allowUnreachableCode": {
|
|
"description": "Disable error reporting for unreachable code.",
|
|
"type": "boolean",
|
|
"markdownDescription": "Disable error reporting for unreachable code.\n\nSee more: https://www.typescriptlang.org/tsconfig#allowUnreachableCode"
|
|
},
|
|
"forceConsistentCasingInFileNames": {
|
|
"description": "Ensure that casing is correct in imports.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Ensure that casing is correct in imports.\n\nSee more: https://www.typescriptlang.org/tsconfig#forceConsistentCasingInFileNames"
|
|
},
|
|
"generateCpuProfile": {
|
|
"description": "Emit a v8 CPU profile of the compiler run for debugging.",
|
|
"type": "string",
|
|
"default": "profile.cpuprofile",
|
|
"markdownDescription": "Emit a v8 CPU profile of the compiler run for debugging.\n\nSee more: https://www.typescriptlang.org/tsconfig#generateCpuProfile"
|
|
},
|
|
"baseUrl": {
|
|
"description": "Specify the base directory to resolve non-relative module names.",
|
|
"type": "string",
|
|
"markdownDescription": "Specify the base directory to resolve non-relative module names.\n\nSee more: https://www.typescriptlang.org/tsconfig#baseUrl"
|
|
},
|
|
"paths": {
|
|
"description": "Specify a set of entries that re-map imports to additional lookup locations.",
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"description": "Path mapping to be computed relative to baseUrl option."
|
|
}
|
|
},
|
|
"markdownDescription": "Specify a set of entries that re-map imports to additional lookup locations.\n\nSee more: https://www.typescriptlang.org/tsconfig#paths"
|
|
},
|
|
"plugins": {
|
|
"description": "Specify a list of language service plugins to include.",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"description": "Plugin name.",
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"markdownDescription": "Specify a list of language service plugins to include.\n\nSee more: https://www.typescriptlang.org/tsconfig#plugins"
|
|
},
|
|
"rootDirs": {
|
|
"description": "Allow multiple folders to be treated as one when resolving modules.",
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"markdownDescription": "Allow multiple folders to be treated as one when resolving modules.\n\nSee more: https://www.typescriptlang.org/tsconfig#rootDirs"
|
|
},
|
|
"typeRoots": {
|
|
"description": "Specify multiple folders that act like `./node_modules/@types`.",
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"markdownDescription": "Specify multiple folders that act like `./node_modules/@types`.\n\nSee more: https://www.typescriptlang.org/tsconfig#typeRoots"
|
|
},
|
|
"types": {
|
|
"description": "Specify type package names to be included without being referenced in a source file.",
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"markdownDescription": "Specify type package names to be included without being referenced in a source file.\n\nSee more: https://www.typescriptlang.org/tsconfig#types"
|
|
},
|
|
"traceResolution": {
|
|
"description": "Enable tracing of the name resolution process. Requires TypeScript version 2.0 or later.",
|
|
"type": "boolean",
|
|
"default": false
|
|
},
|
|
"allowJs": {
|
|
"description": "Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files.\n\nSee more: https://www.typescriptlang.org/tsconfig#allowJs"
|
|
},
|
|
"noErrorTruncation": {
|
|
"description": "Disable truncating types in error messages.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Disable truncating types in error messages.\n\nSee more: https://www.typescriptlang.org/tsconfig#noErrorTruncation"
|
|
},
|
|
"allowSyntheticDefaultImports": {
|
|
"description": "Allow 'import x from y' when a module doesn't have a default export.",
|
|
"type": "boolean",
|
|
"markdownDescription": "Allow 'import x from y' when a module doesn't have a default export.\n\nSee more: https://www.typescriptlang.org/tsconfig#allowSyntheticDefaultImports"
|
|
},
|
|
"noImplicitUseStrict": {
|
|
"description": "Disable adding 'use strict' directives in emitted JavaScript files.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Disable adding 'use strict' directives in emitted JavaScript files.\n\nSee more: https://www.typescriptlang.org/tsconfig#noImplicitUseStrict"
|
|
},
|
|
"listEmittedFiles": {
|
|
"description": "Print the names of emitted files after a compilation.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Print the names of emitted files after a compilation.\n\nSee more: https://www.typescriptlang.org/tsconfig#listEmittedFiles"
|
|
},
|
|
"disableSizeLimit": {
|
|
"description": "Remove the 20mb cap on total source code size for JavaScript files in the TypeScript language server.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Remove the 20mb cap on total source code size for JavaScript files in the TypeScript language server.\n\nSee more: https://www.typescriptlang.org/tsconfig#disableSizeLimit"
|
|
},
|
|
"lib": {
|
|
"description": "Specify a set of bundled library declaration files that describe the target runtime environment.",
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"anyOf": [
|
|
{
|
|
"enum": [
|
|
"ES5",
|
|
"ES6",
|
|
"ES2015",
|
|
"ES2015.Collection",
|
|
"ES2015.Core",
|
|
"ES2015.Generator",
|
|
"ES2015.Iterable",
|
|
"ES2015.Promise",
|
|
"ES2015.Proxy",
|
|
"ES2015.Reflect",
|
|
"ES2015.Symbol.WellKnown",
|
|
"ES2015.Symbol",
|
|
"ES2016",
|
|
"ES2016.Array.Include",
|
|
"ES2017",
|
|
"ES2017.Intl",
|
|
"ES2017.Object",
|
|
"ES2017.SharedMemory",
|
|
"ES2017.String",
|
|
"ES2017.TypedArrays",
|
|
"ES2018",
|
|
"ES2018.AsyncGenerator",
|
|
"ES2018.AsyncIterable",
|
|
"ES2018.Intl",
|
|
"ES2018.Promise",
|
|
"ES2018.Regexp",
|
|
"ES2019",
|
|
"ES2019.Array",
|
|
"ES2019.Object",
|
|
"ES2019.String",
|
|
"ES2019.Symbol",
|
|
"ES2020",
|
|
"ES2020.BigInt",
|
|
"ES2020.Promise",
|
|
"ES2020.String",
|
|
"ES2020.Symbol.WellKnown",
|
|
"ESNext",
|
|
"ESNext.Array",
|
|
"ESNext.AsyncIterable",
|
|
"ESNext.BigInt",
|
|
"ESNext.Intl",
|
|
"ESNext.Promise",
|
|
"ESNext.String",
|
|
"ESNext.Symbol",
|
|
"DOM",
|
|
"DOM.Iterable",
|
|
"ScriptHost",
|
|
"WebWorker",
|
|
"WebWorker.ImportScripts",
|
|
"Webworker.Iterable",
|
|
"ES7",
|
|
"ES2021",
|
|
"ES2020.SharedMemory",
|
|
"ES2020.Intl",
|
|
"ES2021.Promise",
|
|
"ES2021.String",
|
|
"ES2021.WeakRef",
|
|
"ESNext.WeakRef",
|
|
"es2021.intl",
|
|
"ES2022",
|
|
"ES2022.Array",
|
|
"ES2022.Error",
|
|
"ES2022.Intl",
|
|
"ES2022.Object",
|
|
"ES2022.String"
|
|
]
|
|
},
|
|
{
|
|
"pattern": "^[Ee][Ss]5|[Ee][Ss]6|[Ee][Ss]7$"
|
|
},
|
|
{
|
|
"pattern": "^[Ee][Ss]2015(\\.([Cc][Oo][Ll][Ll][Ee][Cc][Tt][Ii][Oo][Nn]|[Cc][Oo][Rr][Ee]|[Gg][Ee][Nn][Ee][Rr][Aa][Tt][Oo][Rr]|[Ii][Tt][Ee][Rr][Aa][Bb][Ll][Ee]|[Pp][Rr][Oo][Mm][Ii][Ss][Ee]|[Pp][Rr][Oo][Xx][Yy]|[Rr][Ee][Ff][Ll][Ee][Cc][Tt]|[Ss][Yy][Mm][Bb][Oo][Ll].[Ww][Ee][Ll][Ll][Kk][Nn][Oo][Ww][Nn]|[Ss][Yy][Mm][Bb][Oo][Ll]))?$"
|
|
},
|
|
{
|
|
"pattern": "^[Ee][Ss]2016(\\.[Aa][Rr][Rr][Aa][Yy].[Ii][Nn][Cc][Ll][Uu][Dd][Ee])?$"
|
|
},
|
|
{
|
|
"pattern": "^[Ee][Ss]2017(\\.([Ii][Nn][Tt][Ll]|[Oo][Bb][Jj][Ee][Cc][Tt]|[Ss][Hh][Aa][Rr][Ee][Dd][Mm][Ee][Mm][Oo][Rr][Yy]|[Ss][Tt][Rr][Ii][Nn][Gg]|[Tt][Yy][Pp][Ee][Dd][Aa][Rr][Rr][Aa][Yy][Ss]))?$"
|
|
},
|
|
{
|
|
"pattern": "^[Ee][Ss]2018(\\.([Aa][Ss][Yy][Nn][Cc][Ii][Tt][Ee][Rr][Aa][Bb][Ll][Ee]|[Ii][Nn][Tt][Ll]|[Pp][Rr][Oo][Mm][Ii][Ss][Ee]|[Rr][Ee][Gg][Ee][Xx][Pp]))?$"
|
|
},
|
|
{
|
|
"pattern": "^[Ee][Ss]2019(\\.([Aa][Rr][Rr][Aa][Yy]|[Oo][Bb][Jj][Ee][Cc][Tt]|[Ss][Tt][Rr][Ii][Nn][Gg]|[Ss][Yy][Mm][Bb][Oo][Ll]))?$"
|
|
},
|
|
{
|
|
"pattern": "^[Ee][Ss]2020(\\.([Bb][Ii][Gg][Ii][Nn][Tt]|[Pp][Rr][Oo][Mm][Ii][Ss][Ee]|[Ss][Tt][Rr][Ii][Nn][Gg]|[Ss][Yy][Mm][Bb][Oo][Ll].[Ww][Ee][Ll][Ll][Kk][Nn][Oo][Ww][Nn]))?$"
|
|
},
|
|
{
|
|
"pattern": "^[Ee][Ss]2021(\\.([Ii][Nn][Tt][Ll]|[Pp][Rr][Oo][Mm][Ii][Ss][Ee]|[Ss][Tt][Rr][Ii][Nn][Gg]|[Ww][Ee][Aa][Kk][Rr][Ee][Ff]))?$"
|
|
},
|
|
{
|
|
"pattern": "^[Ee][Ss]2022(\\.([Aa][Rr][Rr][Aa][Yy]|[Ee][Rr][Rr][Oo][Rr]|[Ii][Nn][Tt][Ll]|[Oo][Bb][Jj][Ee][Cc][Tt]|[Ss][Tt][Rr][Ii][Nn][Gg]))?$"
|
|
},
|
|
{
|
|
"pattern": "^[Ee][Ss][Nn][Ee][Xx][Tt](\\.([Aa][Rr][Rr][Aa][Yy]|[Aa][Ss][Yy][Nn][Cc][Ii][Tt][Ee][Rr][Aa][Bb][Ll][Ee]|[Bb][Ii][Gg][Ii][Nn][Tt]|[Ii][Nn][Tt][Ll]|[Pp][Rr][Oo][Mm][Ii][Ss][Ee]|[Ss][Tt][Rr][Ii][Nn][Gg]|[Ss][Yy][Mm][Bb][Oo][Ll]|[Ww][Ee][Aa][Kk][Rr][Ee][Ff]))?$"
|
|
},
|
|
{
|
|
"pattern": "^[Dd][Oo][Mm](\\.[Ii][Tt][Ee][Rr][Aa][Bb][Ll][Ee])?$"
|
|
},
|
|
{
|
|
"pattern": "^[Ss][Cc][Rr][Ii][Pp][Tt][Hh][Oo][Ss][Tt]$"
|
|
},
|
|
{
|
|
"pattern": "^[Ww][Ee][Bb][Ww][Oo][Rr][Kk][Ee][Rr](\\.[Ii][Mm][Pp][Oo][Rr][Tt][Ss][Cc][Rr][Ii][Pp][Tt][Ss])?$"
|
|
}
|
|
]
|
|
},
|
|
"markdownDescription": "Specify a set of bundled library declaration files that describe the target runtime environment.\n\nSee more: https://www.typescriptlang.org/tsconfig#lib"
|
|
},
|
|
"strictNullChecks": {
|
|
"description": "When type checking, take into account `null` and `undefined`.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "When type checking, take into account `null` and `undefined`.\n\nSee more: https://www.typescriptlang.org/tsconfig#strictNullChecks"
|
|
},
|
|
"maxNodeModuleJsDepth": {
|
|
"description": "Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`.",
|
|
"type": "number",
|
|
"default": 0,
|
|
"markdownDescription": "Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`.\n\nSee more: https://www.typescriptlang.org/tsconfig#maxNodeModuleJsDepth"
|
|
},
|
|
"importHelpers": {
|
|
"description": "Allow importing helper functions from tslib once per project, instead of including them per-file.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Allow importing helper functions from tslib once per project, instead of including them per-file.\n\nSee more: https://www.typescriptlang.org/tsconfig#importHelpers"
|
|
},
|
|
"importsNotUsedAsValues": {
|
|
"description": "Specify emit/checking behavior for imports that are only used for types.",
|
|
"default": "remove",
|
|
"enum": [
|
|
"remove",
|
|
"preserve",
|
|
"error"
|
|
]
|
|
},
|
|
"alwaysStrict": {
|
|
"description": "Ensure 'use strict' is always emitted.",
|
|
"type": "boolean",
|
|
"markdownDescription": "Ensure 'use strict' is always emitted.\n\nSee more: https://www.typescriptlang.org/tsconfig#alwaysStrict"
|
|
},
|
|
"strict": {
|
|
"description": "Enable all strict type checking options.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Enable all strict type checking options.\n\nSee more: https://www.typescriptlang.org/tsconfig#strict"
|
|
},
|
|
"strictBindCallApply": {
|
|
"description": "Check that the arguments for `bind`, `call`, and `apply` methods match the original function.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Check that the arguments for `bind`, `call`, and `apply` methods match the original function.\n\nSee more: https://www.typescriptlang.org/tsconfig#strictBindCallApply"
|
|
},
|
|
"downlevelIteration": {
|
|
"description": "Emit more compliant, but verbose and less performant JavaScript for iteration.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Emit more compliant, but verbose and less performant JavaScript for iteration.\n\nSee more: https://www.typescriptlang.org/tsconfig#downlevelIteration"
|
|
},
|
|
"checkJs": {
|
|
"description": "Enable error reporting in type-checked JavaScript files.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Enable error reporting in type-checked JavaScript files.\n\nSee more: https://www.typescriptlang.org/tsconfig#checkJs"
|
|
},
|
|
"strictFunctionTypes": {
|
|
"description": "When assigning functions, check to ensure parameters and the return values are subtype-compatible.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "When assigning functions, check to ensure parameters and the return values are subtype-compatible.\n\nSee more: https://www.typescriptlang.org/tsconfig#strictFunctionTypes"
|
|
},
|
|
"strictPropertyInitialization": {
|
|
"description": "Check for class properties that are declared but not set in the constructor.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Check for class properties that are declared but not set in the constructor.\n\nSee more: https://www.typescriptlang.org/tsconfig#strictPropertyInitialization"
|
|
},
|
|
"esModuleInterop": {
|
|
"description": "Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility.\n\nSee more: https://www.typescriptlang.org/tsconfig#esModuleInterop"
|
|
},
|
|
"allowUmdGlobalAccess": {
|
|
"description": "Allow accessing UMD globals from modules.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Allow accessing UMD globals from modules.\n\nSee more: https://www.typescriptlang.org/tsconfig#allowUmdGlobalAccess"
|
|
},
|
|
"keyofStringsOnly": {
|
|
"description": "Make keyof only return strings instead of string, numbers or symbols. Legacy option.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Make keyof only return strings instead of string, numbers or symbols. Legacy option.\n\nSee more: https://www.typescriptlang.org/tsconfig#keyofStringsOnly"
|
|
},
|
|
"useDefineForClassFields": {
|
|
"description": "Emit ECMAScript-standard-compliant class fields.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Emit ECMAScript-standard-compliant class fields.\n\nSee more: https://www.typescriptlang.org/tsconfig#useDefineForClassFields"
|
|
},
|
|
"declarationMap": {
|
|
"description": "Create sourcemaps for d.ts files.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Create sourcemaps for d.ts files.\n\nSee more: https://www.typescriptlang.org/tsconfig#declarationMap"
|
|
},
|
|
"resolveJsonModule": {
|
|
"description": "Enable importing .json files",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Enable importing .json files\n\nSee more: https://www.typescriptlang.org/tsconfig#resolveJsonModule"
|
|
},
|
|
"assumeChangesOnlyAffectDirectDependencies": {
|
|
"description": "Have recompiles in '--incremental' and '--watch' assume that changes within a file will only affect files directly depending on it. Requires TypeScript version 3.8 or later.",
|
|
"type": "boolean"
|
|
},
|
|
"extendedDiagnostics": {
|
|
"description": "Output more detailed compiler performance information after building.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"markdownDescription": "Output more detailed compiler performance information after building.\n\nSee more: https://www.typescriptlang.org/tsconfig#extendedDiagnostics"
|
|
},
|
|
"listFilesOnly": {
|
|
"description": "Print names of files that are part of the compilation and then stop processing.",
|
|
"type": "boolean"
|
|
},
|
|
"disableSourceOfProjectReferenceRedirect": {
|
|
"description": "Disable preferring source files instead of declaration files when referencing composite projects",
|
|
"type": "boolean",
|
|
"markdownDescription": "Disable preferring source files instead of declaration files when referencing composite projects\n\nSee more: https://www.typescriptlang.org/tsconfig#disableSourceOfProjectReferenceRedirect"
|
|
},
|
|
"disableSolutionSearching": {
|
|
"description": "Opt a project out of multi-project reference checking when editing.",
|
|
"type": "boolean",
|
|
"markdownDescription": "Opt a project out of multi-project reference checking when editing.\n\nSee more: https://www.typescriptlang.org/tsconfig#disableSolutionSearching"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"typeAcquisitionDefinition": {
|
|
"properties": {
|
|
"typeAcquisition": {
|
|
"type": "object",
|
|
"description": "Auto type (.d.ts) acquisition options for this project. Requires TypeScript version 2.1 or later.",
|
|
"properties": {
|
|
"enable": {
|
|
"description": "Enable auto type acquisition",
|
|
"type": "boolean",
|
|
"default": false
|
|
},
|
|
"include": {
|
|
"description": "Specifies a list of type declarations to be included in auto type acquisition. Ex. [\"jquery\", \"lodash\"]",
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"exclude": {
|
|
"description": "Specifies a list of type declarations to be excluded from auto type acquisition. Ex. [\"jquery\", \"lodash\"]",
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"referencesDefinition": {
|
|
"properties": {
|
|
"references": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"description": "Referenced projects. Requires TypeScript version 3.0 or later.",
|
|
"items": {
|
|
"type": "object",
|
|
"description": "Project reference.",
|
|
"properties": {
|
|
"path": {
|
|
"type": "string",
|
|
"description": "Path to referenced tsconfig or to folder containing tsconfig."
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tsNodeModuleTypes": {
|
|
"type": "object"
|
|
},
|
|
"tsNodeDefinition": {
|
|
"properties": {
|
|
"ts-node": {
|
|
"description": "ts-node options. See also: https://typestrong.org/ts-node/docs/configuration\n\nts-node offers TypeScript execution and REPL for node.js, with source map support.",
|
|
"properties": {
|
|
"compiler": {
|
|
"default": "typescript",
|
|
"description": "Specify a custom TypeScript compiler.",
|
|
"type": "string"
|
|
},
|
|
"compilerHost": {
|
|
"default": false,
|
|
"description": "Use TypeScript's compiler host API instead of the language service API.",
|
|
"type": "boolean"
|
|
},
|
|
"compilerOptions": {
|
|
"additionalProperties": true,
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/compilerOptionsDefinition/properties/compilerOptions"
|
|
}
|
|
],
|
|
"description": "JSON object to merge with TypeScript `compilerOptions`.",
|
|
"properties": {},
|
|
"type": "object"
|
|
},
|
|
"emit": {
|
|
"default": false,
|
|
"description": "Emit output files into `.ts-node` directory.",
|
|
"type": "boolean"
|
|
},
|
|
"esm": {
|
|
"description": "Enable native ESM support.\n\nFor details, see https://typestrong.org/ts-node/docs/imports#native-ecmascript-modules",
|
|
"type": "boolean"
|
|
},
|
|
"experimentalReplAwait": {
|
|
"description": "Allows the usage of top level await in REPL.\n\nUses node's implementation which accomplishes this with an AST syntax transformation.\n\nEnabled by default when tsconfig target is es2018 or above. Set to false to disable.\n\n**Note**: setting to `true` when tsconfig target is too low will throw an Error. Leave as `undefined`\nto get default, automatic behavior.",
|
|
"type": "boolean"
|
|
},
|
|
"experimentalResolver": {
|
|
"description": "Enable experimental features that re-map imports and require calls to support:\n`baseUrl`, `paths`, `rootDirs`, `.js` to `.ts` file extension mappings,\n`outDir` to `rootDir` mappings for composite projects and monorepos.\n\nFor details, see https://github.com/TypeStrong/ts-node/issues/1514",
|
|
"type": "boolean"
|
|
},
|
|
"experimentalSpecifierResolution": {
|
|
"description": "Like node's `--experimental-specifier-resolution`, , but can also be set in your `tsconfig.json` for convenience.\n\nFor details, see https://nodejs.org/dist/latest-v18.x/docs/api/esm.html#customizing-esm-specifier-resolution-algorithm",
|
|
"enum": [
|
|
"explicit",
|
|
"node"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"experimentalTsImportSpecifiers": {
|
|
"description": "Allow using voluntary `.ts` file extension in import specifiers.\n\nTypically, in ESM projects, import specifiers must have an emit extension, `.js`, `.cjs`, or `.mjs`,\nand we automatically map to the corresponding `.ts`, `.cts`, or `.mts` source file. This is the\nrecommended approach.\n\nHowever, if you really want to use `.ts` in import specifiers, and are aware that this may\nbreak tooling, you can enable this flag.",
|
|
"type": "boolean"
|
|
},
|
|
"files": {
|
|
"default": false,
|
|
"description": "Load \"files\" and \"include\" from `tsconfig.json` on startup.\n\nDefault is to override `tsconfig.json` \"files\" and \"include\" to only include the entrypoint script.",
|
|
"type": "boolean"
|
|
},
|
|
"ignore": {
|
|
"default": [
|
|
"(?:^|/)node_modules/"
|
|
],
|
|
"description": "Paths which should not be compiled.\n\nEach string in the array is converted to a regular expression via `new RegExp()` and tested against source paths prior to compilation.\n\nSource paths are normalized to posix-style separators, relative to the directory containing `tsconfig.json` or to cwd if no `tsconfig.json` is loaded.\n\nDefault is to ignore all node_modules subdirectories.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"ignoreDiagnostics": {
|
|
"description": "Ignore TypeScript warnings by diagnostic code.",
|
|
"items": {
|
|
"type": [
|
|
"string",
|
|
"number"
|
|
]
|
|
},
|
|
"type": "array"
|
|
},
|
|
"logError": {
|
|
"default": false,
|
|
"description": "Logs TypeScript errors to stderr instead of throwing exceptions.",
|
|
"type": "boolean"
|
|
},
|
|
"moduleTypes": {
|
|
"$ref": "#/definitions/tsNodeModuleTypes",
|
|
"description": "Override certain paths to be compiled and executed as CommonJS or ECMAScript modules.\nWhen overridden, the tsconfig \"module\" and package.json \"type\" fields are overridden, and\nthe file extension is ignored.\nThis is useful if you cannot use .mts, .cts, .mjs, or .cjs file extensions;\nit achieves the same effect.\n\nEach key is a glob pattern following the same rules as tsconfig's \"include\" array.\nWhen multiple patterns match the same file, the last pattern takes precedence.\n\n`cjs` overrides matches files to compile and execute as CommonJS.\n`esm` overrides matches files to compile and execute as native ECMAScript modules.\n`package` overrides either of the above to default behavior, which obeys package.json \"type\" and\ntsconfig.json \"module\" options."
|
|
},
|
|
"preferTsExts": {
|
|
"default": false,
|
|
"description": "Re-order file extensions so that TypeScript imports are preferred.\n\nFor example, when both `index.js` and `index.ts` exist, enabling this option causes `require('./index')` to resolve to `index.ts` instead of `index.js`",
|
|
"type": "boolean"
|
|
},
|
|
"pretty": {
|
|
"default": false,
|
|
"description": "Use pretty diagnostic formatter.",
|
|
"type": "boolean"
|
|
},
|
|
"require": {
|
|
"description": "Modules to require, like node's `--require` flag.\n\nIf specified in `tsconfig.json`, the modules will be resolved relative to the `tsconfig.json` file.\n\nIf specified programmatically, each input string should be pre-resolved to an absolute path for\nbest results.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"scope": {
|
|
"default": false,
|
|
"description": "Scope compiler to files within `scopeDir`.",
|
|
"type": "boolean"
|
|
},
|
|
"scopeDir": {
|
|
"default": "First of: `tsconfig.json` \"rootDir\" if specified, directory containing `tsconfig.json`, or cwd if no `tsconfig.json` is loaded.",
|
|
"type": "string"
|
|
},
|
|
"skipIgnore": {
|
|
"default": false,
|
|
"description": "Skip ignore check, so that compilation will be attempted for all files with matching extensions.",
|
|
"type": "boolean"
|
|
},
|
|
"swc": {
|
|
"description": "Transpile with swc instead of the TypeScript compiler, and skip typechecking.\n\nEquivalent to setting both `transpileOnly: true` and `transpiler: 'ts-node/transpilers/swc'`\n\nFor complete instructions: https://typestrong.org/ts-node/docs/transpilers",
|
|
"type": "boolean"
|
|
},
|
|
"transpileOnly": {
|
|
"default": false,
|
|
"description": "Use TypeScript's faster `transpileModule`.",
|
|
"type": "boolean"
|
|
},
|
|
"transpiler": {
|
|
"anyOf": [
|
|
{
|
|
"items": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"additionalProperties": true,
|
|
"properties": {},
|
|
"type": "object"
|
|
}
|
|
],
|
|
"maxItems": 2,
|
|
"minItems": 2,
|
|
"type": "array"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"description": "Specify a custom transpiler for use with transpileOnly"
|
|
},
|
|
"typeCheck": {
|
|
"default": true,
|
|
"description": "**DEPRECATED** Specify type-check is enabled (e.g. `transpileOnly == false`).",
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"id": "https://json.schemastore.org/tsconfig",
|
|
"title": "JSON schema for the TypeScript compiler's configuration file",
|
|
"type": "object"
|
|
} |