Type object
File match jsconfig.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/jsconfig-json/latest.json
Source https://www.schemastore.org/jsconfig.json

Validate with Lintel

npx @lintel/lintel check
Type: object

All of

7. filesDefinition | excludeDefinition | includeDefinition | referencesDefinition filesDefinition | excludeDefinition | includeDefinition | referencesDefinition

Definitions

//
filesDefinition
files array | null

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.

uniqueItems=true
excludeDefinition
exclude array | null

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.

uniqueItems=true
includeDefinition
include array | null

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.

uniqueItems=true
compileOnSaveDefinition
compileOnSave boolean | null

Enable Compile-on-Save for this project.

extendsDefinition
extends string | string[]

Path to base configuration file to inherit from (requires TypeScript version 2.1 or later), or array of base files, with the rightmost files having the greater priority (requires TypeScript version 5.0 or later).

buildOptionsDefinition
buildOptions
6 nested properties
dry boolean | null

~

Default: false
force boolean | null

Build all projects, including those that appear to be up to date

See more: https://www.typescriptlang.org/tsconfig#force

Default: false
verbose boolean | null

Enable verbose logging

See more: https://www.typescriptlang.org/tsconfig#verbose

Default: false
incremental boolean | null

Save .tsbuildinfo files to allow for incremental compilation of projects.

See more: https://www.typescriptlang.org/tsconfig#incremental

Default: false
assumeChangesOnlyAffectDirectDependencies boolean | null

Have recompiles in projects that use incremental and watch mode assume that changes within a file will only affect files directly depending on it.

See more: https://www.typescriptlang.org/tsconfig#assumeChangesOnlyAffectDirectDependencies

Default: false
traceResolution boolean | null

Log paths used during the moduleResolution process.

See more: https://www.typescriptlang.org/tsconfig#traceResolution

Default: false
watchOptionsDefinition
watchOptions object | null

Settings for the watch mode in TypeScript.

7 nested properties
force string | null

~

watchFile string | null

Specify how the TypeScript watch mode works.

See more: https://www.typescriptlang.org/tsconfig#watchFile

watchDirectory string | null

Specify how directories are watched on systems that lack recursive file-watching functionality.

See more: https://www.typescriptlang.org/tsconfig#watchDirectory

fallbackPolling string | null

Specify what approach the watcher should use if the system runs out of native file watchers.

See more: https://www.typescriptlang.org/tsconfig#fallbackPolling

synchronousWatchDirectory boolean | null

Synchronously call callbacks and update the state of directory watchers on platforms that don`t support recursive watching natively.

See more: https://www.typescriptlang.org/tsconfig#synchronousWatchDirectory

excludeFiles array | null

Remove a list of files from the watch mode's processing.

See more: https://www.typescriptlang.org/tsconfig#excludeFiles

uniqueItems=true
excludeDirectories array | null

Remove a list of directories from the watch process.

See more: https://www.typescriptlang.org/tsconfig#excludeDirectories

uniqueItems=true
compilerOptionsDefinition
compilerOptions object | null

Instructs the TypeScript compiler how to compile .ts files.

118 nested properties
allowArbitraryExtensions boolean | null

Enable importing files with any extension, provided a declaration file is present.

See more: https://www.typescriptlang.org/tsconfig#allowArbitraryExtensions

allowImportingTsExtensions boolean | null

Allow imports to include TypeScript file extensions. Requires --moduleResolution bundler and either --noEmit or --emitDeclarationOnly to be set.

See more: https://www.typescriptlang.org/tsconfig#allowImportingTsExtensions

charset string | null

No longer supported. In early versions, manually set the text encoding for reading files.

See more: https://www.typescriptlang.org/tsconfig#charset

composite boolean | null

Enable constraints that allow a TypeScript project to be used with project references.

See more: https://www.typescriptlang.org/tsconfig#composite

Default: true
customConditions array | null

Conditions to set in addition to the resolver-specific defaults when resolving imports.

See more: https://www.typescriptlang.org/tsconfig#customConditions

uniqueItems=true
declaration boolean | null

Generate .d.ts files from TypeScript and JavaScript files in your project.

See more: https://www.typescriptlang.org/tsconfig#declaration

Default: false
declarationDir string | null

Specify the output directory for generated declaration files.

See more: https://www.typescriptlang.org/tsconfig#declarationDir

diagnostics boolean | null

Output compiler performance information after building.

See more: https://www.typescriptlang.org/tsconfig#diagnostics

disableReferencedProjectLoad boolean | null

Reduce the number of projects loaded automatically by TypeScript.

See more: https://www.typescriptlang.org/tsconfig#disableReferencedProjectLoad

noPropertyAccessFromIndexSignature boolean | null

Enforces using indexed accessors for keys declared using an indexed type.

See more: https://www.typescriptlang.org/tsconfig#noPropertyAccessFromIndexSignature

erasableSyntaxOnly boolean | null

Do not allow runtime constructs that are not part of ECMAScript.

See more: https://www.typescriptlang.org/tsconfig#erasableSyntaxOnly

Default: false
emitBOM boolean | null

Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files.

See more: https://www.typescriptlang.org/tsconfig#emitBOM

Default: false
emitDeclarationOnly boolean | null

Only output d.ts files and not JavaScript files.

See more: https://www.typescriptlang.org/tsconfig#emitDeclarationOnly

Default: false
exactOptionalPropertyTypes boolean | null

Interpret optional property types as written, rather than adding undefined.

See more: https://www.typescriptlang.org/tsconfig#exactOptionalPropertyTypes

Default: false
incremental boolean | null

Enable incremental compilation. Requires TypeScript version 3.4 or later.

tsBuildInfoFile string | null

Specify the path to .tsbuildinfo incremental compilation file.

See more: https://www.typescriptlang.org/tsconfig#tsBuildInfoFile

Default: ".tsbuildinfo"
inlineSourceMap boolean | null

Include sourcemap files inside the emitted JavaScript.

See more: https://www.typescriptlang.org/tsconfig#inlineSourceMap

Default: false
inlineSources boolean | null

Include source code in the sourcemaps inside the emitted JavaScript.

See more: https://www.typescriptlang.org/tsconfig#inlineSources

Default: false
jsx enum

Specify what JSX code is generated.

See more: https://www.typescriptlang.org/tsconfig#jsx

Values: "preserve" "react" "react-jsx" "react-jsxdev" "react-native"
reactNamespace string | null

Specify the object invoked for createElement. This only applies when targeting react JSX emit.

See more: https://www.typescriptlang.org/tsconfig#reactNamespace

Default: "React"
jsxFactory string | null

Specify the JSX factory function used when targeting React JSX emit, e.g. React.createElement or h.

See more: https://www.typescriptlang.org/tsconfig#jsxFactory

Default: "React.createElement"
jsxFragmentFactory string | null

Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. React.Fragment or Fragment.

See more: https://www.typescriptlang.org/tsconfig#jsxFragmentFactory

Default: "React.Fragment"
jsxImportSource string | null

Specify module specifier used to import the JSX factory functions when using jsx: react-jsx*.

See more: https://www.typescriptlang.org/tsconfig#jsxImportSource

Default: "react"
listFiles boolean | null

Print all of the files read during the compilation.

See more: https://www.typescriptlang.org/tsconfig#listFiles

Default: false
mapRoot string | null

Specify the location where debugger should locate map files instead of generated locations.

See more: https://www.typescriptlang.org/tsconfig#mapRoot

module string | null

Specify what module code is generated.

See more: https://www.typescriptlang.org/tsconfig#module

Any of: enum enum, variant
moduleResolution string | null

Specify how TypeScript looks up a file from a given module specifier.

See more: https://www.typescriptlang.org/tsconfig#moduleResolution

Any of: enum enum, variant
moduleSuffixes array | null

List of file name suffixes to search when resolving a module.

See more: https://www.typescriptlang.org/tsconfig#moduleSuffixes

uniqueItems=true
newLine string | null

Set the newline character for emitting files.

See more: https://www.typescriptlang.org/tsconfig#newLine

Any of: enum enum, variant
noEmit boolean | null

Disable emitting files from a compilation.

See more: https://www.typescriptlang.org/tsconfig#noEmit

Default: false
noEmitHelpers boolean | null

Disable generating custom helper functions like __extends in compiled output.

See more: https://www.typescriptlang.org/tsconfig#noEmitHelpers

Default: false
noEmitOnError boolean | null

Disable emitting files if any type checking errors are reported.

See more: https://www.typescriptlang.org/tsconfig#noEmitOnError

Default: false
noImplicitAny boolean | null

Enable error reporting for expressions and declarations with an implied any type.

See more: https://www.typescriptlang.org/tsconfig#noImplicitAny

noImplicitThis boolean | null

Enable error reporting when this is given the type any.

See more: https://www.typescriptlang.org/tsconfig#noImplicitThis

noUnusedLocals boolean | null

Enable error reporting when local variables aren't read.

See more: https://www.typescriptlang.org/tsconfig#noUnusedLocals

Default: false
noUnusedParameters boolean | null

Raise an error when a function parameter isn't read.

See more: https://www.typescriptlang.org/tsconfig#noUnusedParameters

Default: false
noLib boolean | null

Disable including any library files, including the default lib.d.ts.

See more: https://www.typescriptlang.org/tsconfig#noLib

Default: false
noResolve boolean | null

Disallow imports, requires or <reference>s from expanding the number of files TypeScript should add to a project.

See more: https://www.typescriptlang.org/tsconfig#noResolve

Default: false
noStrictGenericChecks boolean | null

Disable strict checking of generic signatures in function types.

See more: https://www.typescriptlang.org/tsconfig#noStrictGenericChecks

Default: false
out string | null

Deprecated setting. Use outFile instead.

See more: https://www.typescriptlang.org/tsconfig#out

skipDefaultLibCheck boolean | null

Skip type checking .d.ts files that are included with TypeScript.

See more: https://www.typescriptlang.org/tsconfig#skipDefaultLibCheck

Default: false
skipLibCheck boolean | null

Skip type checking all .d.ts files.

See more: https://www.typescriptlang.org/tsconfig#skipLibCheck

Default: false
outFile string | null

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.

See more: https://www.typescriptlang.org/tsconfig#outFile

outDir string | null

Specify an output folder for all emitted files.

See more: https://www.typescriptlang.org/tsconfig#outDir

preserveConstEnums boolean | null

Disable erasing const enum declarations in generated code.

See more: https://www.typescriptlang.org/tsconfig#preserveConstEnums

Default: false
preserveSymlinks boolean | null

Disable resolving symlinks to their realpath. This correlates to the same flag in node.

See more: https://www.typescriptlang.org/tsconfig#preserveSymlinks

Default: false
preserveValueImports boolean | null

Preserve unused imported values in the JavaScript output that would otherwise be removed.

See more: https://www.typescriptlang.org/tsconfig#preserveValueImports

Default: false
preserveWatchOutput boolean | null

Disable wiping the console in watch mode.

See more: https://www.typescriptlang.org/tsconfig#preserveWatchOutput

pretty boolean | null

Enable color and formatting in TypeScript's output to make compiler errors easier to read.

See more: https://www.typescriptlang.org/tsconfig#pretty

Default: true
removeComments boolean | null

Disable emitting comments.

See more: https://www.typescriptlang.org/tsconfig#removeComments

Default: false
rewriteRelativeImportExtensions boolean | null

Rewrite .ts, .tsx, .mts, and .cts file extensions in relative import paths to their JavaScript equivalent in output files.

See more: https://www.typescriptlang.org/tsconfig#rewriteRelativeImportExtensions

Default: false
rootDir string | null

Specify the root folder within your source files.

See more: https://www.typescriptlang.org/tsconfig#rootDir

isolatedModules boolean | null

Ensure that each file can be safely transpiled without relying on other imports.

See more: https://www.typescriptlang.org/tsconfig#isolatedModules

Default: false
sourceMap boolean | null

Create source map files for emitted JavaScript files.

See more: https://www.typescriptlang.org/tsconfig#sourceMap

Default: false
sourceRoot string | null

Specify the root path for debuggers to find the reference source code.

See more: https://www.typescriptlang.org/tsconfig#sourceRoot

suppressExcessPropertyErrors boolean | null

Disable reporting of excess property errors during the creation of object literals.

See more: https://www.typescriptlang.org/tsconfig#suppressExcessPropertyErrors

Default: false
suppressImplicitAnyIndexErrors boolean | null

Suppress noImplicitAny errors when indexing objects that lack index signatures.

See more: https://www.typescriptlang.org/tsconfig#suppressImplicitAnyIndexErrors

Default: false
stripInternal boolean | null

Disable emitting declarations that have @internal in their JSDoc comments.

See more: https://www.typescriptlang.org/tsconfig#stripInternal

target string | null

Set the JavaScript language version for emitted JavaScript and include compatible library declarations.

See more: https://www.typescriptlang.org/tsconfig#target

Default: "es3"
Any of: enum enum, variant
useUnknownInCatchVariables boolean | null

Default catch clause variables as unknown instead of any.

See more: https://www.typescriptlang.org/tsconfig#useUnknownInCatchVariables

Default: false
watch boolean | null

Watch input files.

fallbackPolling enum

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.

Values: "fixedPollingInterval" "priorityPollingInterval" "dynamicPriorityPolling" "fixedInterval" "priorityInterval" "dynamicPriority" "fixedChunkSize"
watchDirectory enum

Specify the strategy for watching directories under systems that lack recursive file-watching functionality. Requires TypeScript version 3.8 or later.

Default: "useFsEvents"
Values: "useFsEvents" "fixedPollingInterval" "dynamicPriorityPolling" "fixedChunkSizePolling"
watchFile enum

Specify the strategy for watching individual files. Requires TypeScript version 3.8 or later.

Default: "useFsEvents"
Values: "fixedPollingInterval" "priorityPollingInterval" "dynamicPriorityPolling" "useFsEvents" "useFsEventsOnParentDirectory" "fixedChunkSizePolling"
experimentalDecorators boolean | null

Enable experimental support for legacy experimental decorators.

See more: https://www.typescriptlang.org/tsconfig#experimentalDecorators

emitDecoratorMetadata boolean | null

Emit design-type metadata for decorated declarations in source files.

See more: https://www.typescriptlang.org/tsconfig#emitDecoratorMetadata

allowUnusedLabels boolean | null

Disable error reporting for unused labels.

See more: https://www.typescriptlang.org/tsconfig#allowUnusedLabels

noImplicitReturns boolean | null

Enable error reporting for codepaths that do not explicitly return in a function.

See more: https://www.typescriptlang.org/tsconfig#noImplicitReturns

Default: false
noUncheckedIndexedAccess boolean | null

Add undefined to a type when accessed using an index.

See more: https://www.typescriptlang.org/tsconfig#noUncheckedIndexedAccess

noFallthroughCasesInSwitch boolean | null

Enable error reporting for fallthrough cases in switch statements.

See more: https://www.typescriptlang.org/tsconfig#noFallthroughCasesInSwitch

Default: false
noImplicitOverride boolean | null

Ensure overriding members in derived classes are marked with an override modifier.

See more: https://www.typescriptlang.org/tsconfig#noImplicitOverride

Default: false
allowUnreachableCode boolean | null

Disable error reporting for unreachable code.

See more: https://www.typescriptlang.org/tsconfig#allowUnreachableCode

forceConsistentCasingInFileNames boolean | null

Ensure that casing is correct in imports.

See more: https://www.typescriptlang.org/tsconfig#forceConsistentCasingInFileNames

Default: false
generateCpuProfile string | null

Emit a v8 CPU profile of the compiler run for debugging.

See more: https://www.typescriptlang.org/tsconfig#generateCpuProfile

Default: "profile.cpuprofile"
baseUrl string | null

Specify the base directory to resolve non-relative module names.

See more: https://www.typescriptlang.org/tsconfig#baseUrl

paths Record<string, array | null>

Specify a set of entries that re-map imports to additional lookup locations.

See more: https://www.typescriptlang.org/tsconfig#paths

plugins array | null

Specify a list of language service plugins to include.

See more: https://www.typescriptlang.org/tsconfig#plugins

rootDirs array | null

Allow multiple folders to be treated as one when resolving modules.

See more: https://www.typescriptlang.org/tsconfig#rootDirs

uniqueItems=true
typeRoots array | null

Specify multiple folders that act like ./node_modules/@types.

See more: https://www.typescriptlang.org/tsconfig#typeRoots

uniqueItems=true
types array | null

Specify type package names to be included without being referenced in a source file.

See more: https://www.typescriptlang.org/tsconfig#types

uniqueItems=true
traceResolution boolean | null

Log paths used during the moduleResolution process.

See more: https://www.typescriptlang.org/tsconfig#traceResolution

Default: false
allowJs boolean | null

Allow JavaScript files to be a part of your program. Use the checkJs option to get errors from these files.

See more: https://www.typescriptlang.org/tsconfig#allowJs

Default: false
noErrorTruncation boolean | null

Disable truncating types in error messages.

See more: https://www.typescriptlang.org/tsconfig#noErrorTruncation

Default: false
allowSyntheticDefaultImports boolean | null

Allow import x from y when a module doesn't have a default export.

See more: https://www.typescriptlang.org/tsconfig#allowSyntheticDefaultImports

noImplicitUseStrict boolean | null

Disable adding use strict directives in emitted JavaScript files.

See more: https://www.typescriptlang.org/tsconfig#noImplicitUseStrict

Default: false
listEmittedFiles boolean | null

Print the names of emitted files after a compilation.

See more: https://www.typescriptlang.org/tsconfig#listEmittedFiles

Default: false
disableSizeLimit boolean | null

Remove the 20mb cap on total source code size for JavaScript files in the TypeScript language server.

See more: https://www.typescriptlang.org/tsconfig#disableSizeLimit

Default: false
lib array | null

Specify a set of bundled library declaration files that describe the target runtime environment.

See more: https://www.typescriptlang.org/tsconfig#lib

uniqueItems=true
libReplacement boolean | null

Enable lib replacement.

See more: https://www.typescriptlang.org/tsconfig#libReplacement

Default: true
strictNullChecks boolean | null

When type checking, take into account null and undefined.

See more: https://www.typescriptlang.org/tsconfig#strictNullChecks

Default: false
maxNodeModuleJsDepth number | null

Specify the maximum folder depth used for checking JavaScript files from node_modules. Only applicable with allowJs.

See more: https://www.typescriptlang.org/tsconfig#maxNodeModuleJsDepth

Default: 0
importHelpers boolean | null

Allow importing helper functions from tslib once per project, instead of including them per-file.

See more: https://www.typescriptlang.org/tsconfig#importHelpers

Default: false
importsNotUsedAsValues enum

Specify emit/checking behavior for imports that are only used for types.

See more: https://www.typescriptlang.org/tsconfig#importsNotUsedAsValues

Default: "remove"
Values: "remove" "preserve" "error"
alwaysStrict boolean | null

Ensure use strict is always emitted.

See more: https://www.typescriptlang.org/tsconfig#alwaysStrict

strict boolean | null

Enable all strict type-checking options.

See more: https://www.typescriptlang.org/tsconfig#strict

Default: false
strictBindCallApply boolean | null

Check that the arguments for bind, call, and apply methods match the original function.

See more: https://www.typescriptlang.org/tsconfig#strictBindCallApply

Default: false
downlevelIteration boolean | null

Emit more compliant, but verbose and less performant JavaScript for iteration.

See more: https://www.typescriptlang.org/tsconfig#downlevelIteration

Default: false
checkJs boolean | null

Enable error reporting in type-checked JavaScript files.

See more: https://www.typescriptlang.org/tsconfig#checkJs

Default: false
strictFunctionTypes boolean | null

When assigning functions, check to ensure parameters and the return values are subtype-compatible.

See more: https://www.typescriptlang.org/tsconfig#strictFunctionTypes

Default: false
strictPropertyInitialization boolean | null

Check for class properties that are declared but not set in the constructor.

See more: https://www.typescriptlang.org/tsconfig#strictPropertyInitialization

Default: false
esModuleInterop boolean | null

Emit additional JavaScript to ease support for importing CommonJS modules. This enables allowSyntheticDefaultImports for type compatibility.

See more: https://www.typescriptlang.org/tsconfig#esModuleInterop

Default: false
allowUmdGlobalAccess boolean | null

Allow accessing UMD globals from modules.

See more: https://www.typescriptlang.org/tsconfig#allowUmdGlobalAccess

Default: false
keyofStringsOnly boolean | null

Make keyof only return strings instead of string, numbers or symbols. Legacy option.

See more: https://www.typescriptlang.org/tsconfig#keyofStringsOnly

Default: false
useDefineForClassFields boolean | null

Emit ECMAScript-standard-compliant class fields.

See more: https://www.typescriptlang.org/tsconfig#useDefineForClassFields

Default: false
declarationMap boolean | null

Create sourcemaps for d.ts files.

See more: https://www.typescriptlang.org/tsconfig#declarationMap

Default: false
resolveJsonModule boolean | null

Enable importing .json files.

See more: https://www.typescriptlang.org/tsconfig#resolveJsonModule

Default: false
resolvePackageJsonExports boolean | null

Use the package.json 'exports' field when resolving package imports.

See more: https://www.typescriptlang.org/tsconfig#resolvePackageJsonExports

Default: false
resolvePackageJsonImports boolean | null

Use the package.json 'imports' field when resolving imports.

See more: https://www.typescriptlang.org/tsconfig#resolvePackageJsonImports

Default: false
assumeChangesOnlyAffectDirectDependencies boolean | null

Have recompiles in projects that use incremental and watch mode assume that changes within a file will only affect files directly depending on it.

See more: https://www.typescriptlang.org/tsconfig#assumeChangesOnlyAffectDirectDependencies

extendedDiagnostics boolean | null

Output more detailed compiler performance information after building.

See more: https://www.typescriptlang.org/tsconfig#extendedDiagnostics

Default: false
listFilesOnly boolean | null

Print names of files that are part of the compilation and then stop processing.

disableSourceOfProjectReferenceRedirect boolean | null

Disable preferring source files instead of declaration files when referencing composite projects.

See more: https://www.typescriptlang.org/tsconfig#disableSourceOfProjectReferenceRedirect

disableSolutionSearching boolean | null

Opt a project out of multi-project reference checking when editing.

See more: https://www.typescriptlang.org/tsconfig#disableSolutionSearching

verbatimModuleSyntax boolean | null

Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the module setting.

See more: https://www.typescriptlang.org/tsconfig#verbatimModuleSyntax

noCheck boolean | null

Disable full type checking (only critical parse and emit errors will be reported).

See more: https://www.typescriptlang.org/tsconfig#noCheck

Default: false
isolatedDeclarations boolean | null

Require sufficient annotation on exports so other tools can trivially generate declaration files.

See more: https://www.typescriptlang.org/tsconfig#isolatedDeclarations

Default: false
noUncheckedSideEffectImports boolean | null

Check side effect imports.

See more: https://www.typescriptlang.org/tsconfig#noUncheckedSideEffectImports

Default: false
strictBuiltinIteratorReturn boolean | null

Built-in iterators are instantiated with a TReturn type of undefined instead of any.

See more: https://www.typescriptlang.org/tsconfig#strictBuiltinIteratorReturn

Default: false
typeAcquisitionDefinition
typeAcquisition object | null

Auto type (.d.ts) acquisition options for this project. Requires TypeScript version 2.1 or later.

3 nested properties
enable boolean | null

Enable auto type acquisition

Default: false
include array | null

Specifies a list of type declarations to be included in auto type acquisition. Ex. ["jquery", "lodash"]

uniqueItems=true
exclude array | null

Specifies a list of type declarations to be excluded from auto type acquisition. Ex. ["jquery", "lodash"]

uniqueItems=true
referencesDefinition
references object[]

Referenced projects. Requires TypeScript version 3.0 or later.

uniqueItems=true