All apps/TypeScript compiler (tsc)

TypeScript compiler (tsc)

tsc

The TypeScript compiler, which type-checks and compiles TypeScript to JavaScript.

Runs as tsc|macOS, Linux, Windows|www.typescriptlang.org

Autocomplete

Fig spec, with what the manifest adds · 118 options
Published once and never changed; check the digest before caching
sha256
afb787c2c56521cf742dd10f6d4fb28b0389374e43ed67e52501de3f1dd4e02e
Size
22954 bytes
OptionsOn tsc itself
--all
Show all compiler options
--generateTrace
Generates an event trace and a list of types
--help
Gives local information for help on the CLI
--init
Initializes a TypeScript project and creates a tsconfig.json file
--listFilesOnly
Print names of files that are part of the compilation and then stop processing
--locale
Set the language of the messaging from TypeScript. This does not affect emit
--project
Compile the project given the path to its configuration file, or to a folder with a tsconfig.json <path>
--showConfig
Print the final configuration instead of building
--version
Print the compiler's version
--build
Build one or more projects and their dependencies, if out of date
--clean
Delete the outputs of all projects
--dry
Show what would be built (or deleted, if specified with '--clean')
--force
Build all projects, including those that appear to be up to date
--verbose
Enable verbose logging
--excludeDirectories
Remove a list of directories from the watch process <dir>
--excludeFiles
Remove a list of files from the watch mode's processing <files>
--fallbackPolling
Specify what approach the watcher should use if the system runs out of native file watchers <approach>
--synchronousWatchDirectory
Synchronously call callbacks and update the state of directory watchers on platforms that don`t support recursive watching natively
--watch
Watch input files
--watchDirectory
Specify how directories are watched on systems that lack recursive file-watching functionality <approach>
--watchFile
Specify how the TypeScript watch mode works <approach>
--allowJs
Allow JavaScript files to be a part of your program. Use the checkJS option to get errors from these files
--allowSyntheticDefaultImports
Allow 'import x from y' when a module doesn't have a default export
--allowUmdGlobalAccess
Allow accessing UMD globals from modules
--allowUnreachableCode
Disable error reporting for unreachable code
--allowUnusedLabels
Disable error reporting for unused label
--alwaysStrict
Ensure 'use strict' is always emitted
--assumeChangesOnlyAffectDirectDependencies
Have recompiles in projects that use incremental and watch mode assume that changes within a file will only affect files directly depending on it
--baseUrl
Specify the base directory to resolve non-relative module names <directory>
--checkJs
Enable error reporting in type-checked JavaScript files
--composite
Enable constraints that allow a TypeScript project to be used with project references
--declaration
Generate .d.ts files from TypeScript and JavaScript files in your project
--declarationDir
Specify the output directory for generated declaration files <string>
--declarationMap
Create sourcemaps for d.ts files
--diagnostics
Output compiler performance information after building
--disableReferencedProjectLoad
Reduce the number of projects loaded automatically by TypeScript
--disableSizeLimit
Remove the 20mb cap on total source code size for JavaScript files in the TypeScript language server
--disableSolutionSearching
Opt a project out of multi-project reference checking when editing
--disableSourceOfProjectReferenceRedirect
Disable preferring source files instead of declaration files when referencing composite projects
--downlevelIteration
Emit more compliant, but verbose and less performant JavaScript for iteration
--emitBOM
Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files
--emitDeclarationOnly
Only output d.ts files and not JavaScript files
--emitDecoratorMetadata
Emit design-type metadata for decorated declarations in source files
--esModuleInterop
Emit additional JavaScript to ease support for importing CommonJS modules. This enables allowSyntheticDefaultImports for type compatibility
--exactOptionalPropertyTypes
Differentiate between undefined and not present when type checking
--experimentalDecorators
Enable experimental support for TC39 stage 2 draft decorators
--explainFiles
Print files read during the compilation including why it was included
--extendedDiagnostics
Output more detailed compiler performance information after building
--forceConsistentCasingInFileNames
Ensure that casing is correct in imports
--generateCpuProfile
Emit a v8 CPU profile of the compiler run for debugging
--importHelpers
Allow importing helper functions from tslib once per project, instead of including them per-file
--importsNotUsedAsValues
Specify emit/checking behavior for imports that are only used for types <type>
--incremental
Save .tsbuildinfo files to allow for incremental compilation of projects
--inlineSourceMap
Include sourcemap files inside the emitted JavaScript
--inlineSources
Include source code in the sourcemaps inside the emitted JavaScript
--isolatedModules
Ensure that each file can be safely transpiled without relying on other imports
--jsx
Specify what JSX code is generated <type>
--jsxFactory
Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' <JSX factory function>
--jsxFragmentFactory
Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment' <JSX fragment>
--jsxImportSource
Specify module specifier used to import the JSX factory functions when using jsx: react-jsx* <string>
--keyofStringsOnly
Make keyof only return strings instead of string, numbers or symbols. Legacy option
--lib
Specify a set of bundled library declaration files that describe the target runtime environment <list>
--listEmittedFiles
Print the names of emitted files after a compilation
--listFiles
Print all of the files read during the compilation
--mapRoot
Specify the location where debugger should locate map files instead of generated locations <string>
--maxNodeModuleJsDepth
Specify the maximum folder depth used for checking JavaScript files from node_modules. Only applicable with allowJs <number>
--module
Specify what module code is generated <module>
--moduleResolution
Specify how TypeScript looks up a file from a given module specifier <module>
--newLine
Set the newline character for emitting files <character>
--noEmit
Disable emitting file from a compilation
--noEmitHelpers
Disable generating custom helper functions like __extends in compiled output
--noEmitOnError
Disable emitting files if any type checking errors are reported
--noErrorTruncation
Disable truncating types in error messages
--noFallthroughCasesInSwitch
Enable error reporting for fallthrough cases in switch statements
--noImplicitAny
Enable error reporting for expressions and declarations with an implied any type
--noImplicitOverride
Ensure overriding members in derived classes are marked with an override modifier
--noImplicitReturns
Enable error reporting for codepaths that do not explicitly return in a function
--noImplicitThis
Enable error reporting when this is given the type any
--noImplicitUseStrict
Disable adding 'use strict' directives in emitted JavaScript files
--noLib
Disable including any library files, including the default lib.d.ts
--noPropertyAccessFromIndexSignature
Enforces using indexed accessors for keys declared using an indexed type
--noResolve
Disallow imports, requires or <reference>s from expanding the number of files TypeScript should add to a project
--noStrictGenericChecks
Disable strict checking of generic signatures in function types
--noUncheckedIndexedAccess
Add undefined to a type when accessed using an index
--noUnusedLocals
Enable error reporting when a local variables aren't read
--noUnusedParameters
Raise an error when a function parameter isn't read
--outDir
Specify an output folder for all emitted files <string>
--outFile
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 <string>
--paths
Specify a set of entries that re-map imports to additional lookup locations <object>
--plugins
Specify a list of language service plugins to include <plugins>
--preserveConstEnums
Disable erasing const enum declarations in generated code
--preserveSymlinks
Disable resolving symlinks to their realpath. This correlates to the same flag in node
--preserveWatchOutput
Disable wiping the console in watch mode
--pretty
Enable color and formatting in output to make compiler errors easier to read
--reactNamespace
Specify the object invoked for createElement. This only applies when targeting react JSX emit <object>
--removeComments
Disable emitting comments
--resolveJsonModule
Enable importing .json files
--rootDir
Specify the root folder within your source files <string>
--rootDirs
Allow multiple folders to be treated as one when resolving modules <string>
--skipDefaultLibCheck
Skip type checking .d.ts files that are included with TypeScript
--skipLibCheck
Skip type checking all .d.ts files
--sourceMap
Create source map files for emitted JavaScript files
--sourceRoot
Specify the root path for debuggers to find the reference source code <string>
--strict
Enable all strict type checking options
--strictBindCallApply
Check that the arguments for bind, call, and apply methods match the original function
--strictFunctionTypes
When assigning functions, check to ensure parameters and the return values are subtype-compatible
--strictNullChecks
When type checking, take into account null and undefined
--strictPropertyInitialization
Check for class properties that are declared but not set in the constructor
--stripInternal
Disable emitting declarations that have @internal in their JSDoc comments
--suppressExcessPropertyErrors
Disable reporting of excess property errors during the creation of object literals
--suppressImplicitAnyIndexErrors
Suppress noImplicitAny errors when indexing objects that lack index signatures
--target
Set the JavaScript language version for emitted JavaScript and include compatible library declarations <value>
--traceResolution
Log paths used during the moduleResolution process
--tsBuildInfoFile
Specify the folder for .tsbuildinfo incremental compilation files <string>
--typeRoots
Specify multiple folders that act like ./node_modules/@types <folders>
--types
Specify type package names to be included without being referenced in a source file <package names>
--useDefineForClassFields
Emit ECMAScript-standard-compliant class fields
--useUnknownInCatchVariables
Default catch clause variables as unknown instead of any
ArgumentsPositional, in order
<tsc script>
· filepaths