jsconfig.json
JavaScript project configuration file
| 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
All of
Definitions
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.
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.
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.
Enable Compile-on-Save for this project.
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).
6 nested properties
~
Build all projects, including those that appear to be up to date
See more: https://www.typescriptlang.org/tsconfig#force
Enable verbose logging
See more: https://www.typescriptlang.org/tsconfig#verbose
Save .tsbuildinfo files to allow for incremental compilation of projects.
See more: https://www.typescriptlang.org/tsconfig#incremental
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
Log paths used during the moduleResolution process.
See more: https://www.typescriptlang.org/tsconfig#traceResolution
Settings for the watch mode in TypeScript.
7 nested properties
~
Specify how the TypeScript watch mode works.
See more: https://www.typescriptlang.org/tsconfig#watchFile
Specify how directories are watched on systems that lack recursive file-watching functionality.
See more: https://www.typescriptlang.org/tsconfig#watchDirectory
Specify what approach the watcher should use if the system runs out of native file watchers.
See more: https://www.typescriptlang.org/tsconfig#fallbackPolling
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
Remove a list of files from the watch mode's processing.
See more: https://www.typescriptlang.org/tsconfig#excludeFiles
Remove a list of directories from the watch process.
See more: https://www.typescriptlang.org/tsconfig#excludeDirectories
Instructs the TypeScript compiler how to compile .ts files.
118 nested properties
Enable importing files with any extension, provided a declaration file is present.
See more: https://www.typescriptlang.org/tsconfig#allowArbitraryExtensions
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
No longer supported. In early versions, manually set the text encoding for reading files.
See more: https://www.typescriptlang.org/tsconfig#charset
Enable constraints that allow a TypeScript project to be used with project references.
See more: https://www.typescriptlang.org/tsconfig#composite
Conditions to set in addition to the resolver-specific defaults when resolving imports.
See more: https://www.typescriptlang.org/tsconfig#customConditions
Generate .d.ts files from TypeScript and JavaScript files in your project.
See more: https://www.typescriptlang.org/tsconfig#declaration
Specify the output directory for generated declaration files.
See more: https://www.typescriptlang.org/tsconfig#declarationDir
Output compiler performance information after building.
See more: https://www.typescriptlang.org/tsconfig#diagnostics
Reduce the number of projects loaded automatically by TypeScript.
See more: https://www.typescriptlang.org/tsconfig#disableReferencedProjectLoad
Enforces using indexed accessors for keys declared using an indexed type.
See more: https://www.typescriptlang.org/tsconfig#noPropertyAccessFromIndexSignature
Do not allow runtime constructs that are not part of ECMAScript.
See more: https://www.typescriptlang.org/tsconfig#erasableSyntaxOnly
Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files.
See more: https://www.typescriptlang.org/tsconfig#emitBOM
Only output d.ts files and not JavaScript files.
See more: https://www.typescriptlang.org/tsconfig#emitDeclarationOnly
Interpret optional property types as written, rather than adding undefined.
See more: https://www.typescriptlang.org/tsconfig#exactOptionalPropertyTypes
Enable incremental compilation. Requires TypeScript version 3.4 or later.
Specify the path to .tsbuildinfo incremental compilation file.
See more: https://www.typescriptlang.org/tsconfig#tsBuildInfoFile
Include sourcemap files inside the emitted JavaScript.
See more: https://www.typescriptlang.org/tsconfig#inlineSourceMap
Include source code in the sourcemaps inside the emitted JavaScript.
See more: https://www.typescriptlang.org/tsconfig#inlineSources
Specify what JSX code is generated.
See more: https://www.typescriptlang.org/tsconfig#jsx
Specify the object invoked for createElement. This only applies when targeting react JSX emit.
See more: https://www.typescriptlang.org/tsconfig#reactNamespace
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
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
Specify module specifier used to import the JSX factory functions when using jsx: react-jsx*.
See more: https://www.typescriptlang.org/tsconfig#jsxImportSource
Print all of the files read during the compilation.
See more: https://www.typescriptlang.org/tsconfig#listFiles
Specify the location where debugger should locate map files instead of generated locations.
See more: https://www.typescriptlang.org/tsconfig#mapRoot
Specify what module code is generated.
See more: https://www.typescriptlang.org/tsconfig#module
Specify how TypeScript looks up a file from a given module specifier.
See more: https://www.typescriptlang.org/tsconfig#moduleResolution
List of file name suffixes to search when resolving a module.
See more: https://www.typescriptlang.org/tsconfig#moduleSuffixes
Set the newline character for emitting files.
See more: https://www.typescriptlang.org/tsconfig#newLine
Disable emitting files from a compilation.
See more: https://www.typescriptlang.org/tsconfig#noEmit
Disable generating custom helper functions like __extends in compiled output.
See more: https://www.typescriptlang.org/tsconfig#noEmitHelpers
Disable emitting files if any type checking errors are reported.
See more: https://www.typescriptlang.org/tsconfig#noEmitOnError
Enable error reporting for expressions and declarations with an implied any type.
See more: https://www.typescriptlang.org/tsconfig#noImplicitAny
Enable error reporting when this is given the type any.
See more: https://www.typescriptlang.org/tsconfig#noImplicitThis
Enable error reporting when local variables aren't read.
See more: https://www.typescriptlang.org/tsconfig#noUnusedLocals
Raise an error when a function parameter isn't read.
See more: https://www.typescriptlang.org/tsconfig#noUnusedParameters
Disable including any library files, including the default lib.d.ts.
See more: https://www.typescriptlang.org/tsconfig#noLib
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
Disable strict checking of generic signatures in function types.
See more: https://www.typescriptlang.org/tsconfig#noStrictGenericChecks
Deprecated setting. Use outFile instead.
See more: https://www.typescriptlang.org/tsconfig#out
Skip type checking .d.ts files that are included with TypeScript.
See more: https://www.typescriptlang.org/tsconfig#skipDefaultLibCheck
Skip type checking all .d.ts files.
See more: https://www.typescriptlang.org/tsconfig#skipLibCheck
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
Specify an output folder for all emitted files.
See more: https://www.typescriptlang.org/tsconfig#outDir
Disable erasing const enum declarations in generated code.
See more: https://www.typescriptlang.org/tsconfig#preserveConstEnums
Disable resolving symlinks to their realpath. This correlates to the same flag in node.
See more: https://www.typescriptlang.org/tsconfig#preserveSymlinks
Preserve unused imported values in the JavaScript output that would otherwise be removed.
See more: https://www.typescriptlang.org/tsconfig#preserveValueImports
Disable wiping the console in watch mode.
See more: https://www.typescriptlang.org/tsconfig#preserveWatchOutput
Enable color and formatting in TypeScript's output to make compiler errors easier to read.
See more: https://www.typescriptlang.org/tsconfig#pretty
Disable emitting comments.
See more: https://www.typescriptlang.org/tsconfig#removeComments
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
Specify the root folder within your source files.
See more: https://www.typescriptlang.org/tsconfig#rootDir
Ensure that each file can be safely transpiled without relying on other imports.
See more: https://www.typescriptlang.org/tsconfig#isolatedModules
Create source map files for emitted JavaScript files.
See more: https://www.typescriptlang.org/tsconfig#sourceMap
Specify the root path for debuggers to find the reference source code.
See more: https://www.typescriptlang.org/tsconfig#sourceRoot
Disable reporting of excess property errors during the creation of object literals.
See more: https://www.typescriptlang.org/tsconfig#suppressExcessPropertyErrors
Suppress noImplicitAny errors when indexing objects that lack index signatures.
See more: https://www.typescriptlang.org/tsconfig#suppressImplicitAnyIndexErrors
Disable emitting declarations that have @internal in their JSDoc comments.
See more: https://www.typescriptlang.org/tsconfig#stripInternal
Set the JavaScript language version for emitted JavaScript and include compatible library declarations.
See more: https://www.typescriptlang.org/tsconfig#target
Default catch clause variables as unknown instead of any.
See more: https://www.typescriptlang.org/tsconfig#useUnknownInCatchVariables
Watch input files.
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.
Specify the strategy for watching directories under systems that lack recursive file-watching functionality. Requires TypeScript version 3.8 or later.
Specify the strategy for watching individual files. Requires TypeScript version 3.8 or later.
Enable experimental support for legacy experimental decorators.
See more: https://www.typescriptlang.org/tsconfig#experimentalDecorators
Emit design-type metadata for decorated declarations in source files.
See more: https://www.typescriptlang.org/tsconfig#emitDecoratorMetadata
Disable error reporting for unused labels.
See more: https://www.typescriptlang.org/tsconfig#allowUnusedLabels
Enable error reporting for codepaths that do not explicitly return in a function.
See more: https://www.typescriptlang.org/tsconfig#noImplicitReturns
Add undefined to a type when accessed using an index.
See more: https://www.typescriptlang.org/tsconfig#noUncheckedIndexedAccess
Enable error reporting for fallthrough cases in switch statements.
See more: https://www.typescriptlang.org/tsconfig#noFallthroughCasesInSwitch
Ensure overriding members in derived classes are marked with an override modifier.
See more: https://www.typescriptlang.org/tsconfig#noImplicitOverride
Disable error reporting for unreachable code.
See more: https://www.typescriptlang.org/tsconfig#allowUnreachableCode
Ensure that casing is correct in imports.
See more: https://www.typescriptlang.org/tsconfig#forceConsistentCasingInFileNames
Emit a v8 CPU profile of the compiler run for debugging.
See more: https://www.typescriptlang.org/tsconfig#generateCpuProfile
Specify the base directory to resolve non-relative module names.
See more: https://www.typescriptlang.org/tsconfig#baseUrl
Specify a set of entries that re-map imports to additional lookup locations.
See more: https://www.typescriptlang.org/tsconfig#paths
Specify a list of language service plugins to include.
See more: https://www.typescriptlang.org/tsconfig#plugins
Allow multiple folders to be treated as one when resolving modules.
See more: https://www.typescriptlang.org/tsconfig#rootDirs
Specify multiple folders that act like ./node_modules/@types.
See more: https://www.typescriptlang.org/tsconfig#typeRoots
Specify type package names to be included without being referenced in a source file.
See more: https://www.typescriptlang.org/tsconfig#types
Log paths used during the moduleResolution process.
See more: https://www.typescriptlang.org/tsconfig#traceResolution
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
Disable truncating types in error messages.
See more: https://www.typescriptlang.org/tsconfig#noErrorTruncation
Allow import x from y when a module doesn't have a default export.
See more: https://www.typescriptlang.org/tsconfig#allowSyntheticDefaultImports
Disable adding use strict directives in emitted JavaScript files.
See more: https://www.typescriptlang.org/tsconfig#noImplicitUseStrict
Print the names of emitted files after a compilation.
See more: https://www.typescriptlang.org/tsconfig#listEmittedFiles
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
Specify a set of bundled library declaration files that describe the target runtime environment.
See more: https://www.typescriptlang.org/tsconfig#lib
Enable lib replacement.
See more: https://www.typescriptlang.org/tsconfig#libReplacement
When type checking, take into account null and undefined.
See more: https://www.typescriptlang.org/tsconfig#strictNullChecks
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
Allow importing helper functions from tslib once per project, instead of including them per-file.
See more: https://www.typescriptlang.org/tsconfig#importHelpers
Specify emit/checking behavior for imports that are only used for types.
See more: https://www.typescriptlang.org/tsconfig#importsNotUsedAsValues
Ensure use strict is always emitted.
See more: https://www.typescriptlang.org/tsconfig#alwaysStrict
Enable all strict type-checking options.
See more: https://www.typescriptlang.org/tsconfig#strict
Check that the arguments for bind, call, and apply methods match the original function.
See more: https://www.typescriptlang.org/tsconfig#strictBindCallApply
Emit more compliant, but verbose and less performant JavaScript for iteration.
See more: https://www.typescriptlang.org/tsconfig#downlevelIteration
Enable error reporting in type-checked JavaScript files.
See more: https://www.typescriptlang.org/tsconfig#checkJs
When assigning functions, check to ensure parameters and the return values are subtype-compatible.
See more: https://www.typescriptlang.org/tsconfig#strictFunctionTypes
Check for class properties that are declared but not set in the constructor.
See more: https://www.typescriptlang.org/tsconfig#strictPropertyInitialization
Emit additional JavaScript to ease support for importing CommonJS modules. This enables allowSyntheticDefaultImports for type compatibility.
See more: https://www.typescriptlang.org/tsconfig#esModuleInterop
Allow accessing UMD globals from modules.
See more: https://www.typescriptlang.org/tsconfig#allowUmdGlobalAccess
Make keyof only return strings instead of string, numbers or symbols. Legacy option.
See more: https://www.typescriptlang.org/tsconfig#keyofStringsOnly
Emit ECMAScript-standard-compliant class fields.
See more: https://www.typescriptlang.org/tsconfig#useDefineForClassFields
Create sourcemaps for d.ts files.
See more: https://www.typescriptlang.org/tsconfig#declarationMap
Enable importing .json files.
See more: https://www.typescriptlang.org/tsconfig#resolveJsonModule
Use the package.json 'exports' field when resolving package imports.
See more: https://www.typescriptlang.org/tsconfig#resolvePackageJsonExports
Use the package.json 'imports' field when resolving imports.
See more: https://www.typescriptlang.org/tsconfig#resolvePackageJsonImports
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
Output more detailed compiler performance information after building.
See more: https://www.typescriptlang.org/tsconfig#extendedDiagnostics
Print names of files that are part of the compilation and then stop processing.
Disable preferring source files instead of declaration files when referencing composite projects.
See more: https://www.typescriptlang.org/tsconfig#disableSourceOfProjectReferenceRedirect
Opt a project out of multi-project reference checking when editing.
See more: https://www.typescriptlang.org/tsconfig#disableSolutionSearching
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
Disable full type checking (only critical parse and emit errors will be reported).
See more: https://www.typescriptlang.org/tsconfig#noCheck
Require sufficient annotation on exports so other tools can trivially generate declaration files.
See more: https://www.typescriptlang.org/tsconfig#isolatedDeclarations
Check side effect imports.
See more: https://www.typescriptlang.org/tsconfig#noUncheckedSideEffectImports
Built-in iterators are instantiated with a TReturn type of undefined instead of any.
See more: https://www.typescriptlang.org/tsconfig#strictBuiltinIteratorReturn
Auto type (.d.ts) acquisition options for this project. Requires TypeScript version 2.1 or later.
3 nested properties
Enable auto type acquisition
Specifies a list of type declarations to be included in auto type acquisition. Ex. ["jquery", "lodash"]
Specifies a list of type declarations to be excluded from auto type acquisition. Ex. ["jquery", "lodash"]
Referenced projects. Requires TypeScript version 3.0 or later.