Spec-Zone.ru › TypeScript 5.1

tsc CLI Options

Использование командной строки

Запуск tsc локально скомпилирует ближайший проект, определённый tsconfig.json, или вы можете скомпилировать набор файлов TypeScript, передав шаблон файлов, которые вы хотите. При указании входных файлов в командной строке, файлы tsconfig.json игнорируются.

# Run a compile based on a backwards look through the fs for a tsconfig.json
tsc

# Emit JS for just the index.ts with the compiler defaults
tsc index.ts

# Emit JS for any .ts files in the folder src, with the default settings
tsc src/*.ts

# Emit files referenced in with the compiler settings from tsconfig.production.json
tsc --project tsconfig.production.json

# Emit d.ts files for a js file with showing compiler options which are booleans
tsc index.js --declaration --emitDeclarationOnly

# Emit a single .js file from two files via compiler options which take string arguments
tsc app.ts util.ts --target esnext --outfile index.js

Параметры компилятора

Если вам нужна дополнительная информация о параметрах компилятора в tsconfig, ознакомьтесь со ссылкой на TSConfig

Команды CLI

Флаг Тип
--all

boolean

Показать все параметры компилятора.

--generateTrace

string

Генерирует трассировку событий и список типов.

--help

boolean

Предоставляет локальную информацию о справке по командной строке.

--init

boolean

Инициализирует проект TypeScript и создаёт файл tsconfig.json.

--listFilesOnly

boolean

Выводит имена файлов, которые являются частью компиляции, а затем останавливает обработку.

--locale

string

Устанавливает язык сообщений от TypeScript. Это не влияет на выходные данные.

--project

string

Компилирует проект, указав путь к его конфигурационному файлу или папке с 'tsconfig.json'.

--showConfig

boolean

Выводит окончательную конфигурацию вместо сборки.

--version

boolean

Выводит версию компилятора.

Параметры сборки

Флаг Тип
--build

boolean

Сборка одного или нескольких проектов и их зависимостей, если они устарели.

--clean

boolean

Удаление выходных данных всех проектов.

--dry

boolean

Показать, что будет построено (или удалено, если указано с '--clean').

--force

boolean

Сборка всех проектов, включая те, которые, по-видимому, актуальны.

--verbose

boolean

Включение подробного протоколирования.

Параметры наблюдения

Флаг Тип
--excludeDirectories

list

Удаление списка каталогов из процесса наблюдения.

--excludeFiles

list

Удаление списка файлов из обработки режима наблюдения.

--fallbackPolling

priorityinterval

Укажите подход, который должен использовать наблюдатель, если система исчерпала количество встроенных наблюдателей файлов.

--synchronousWatchDirectory

boolean

Синхронный вызов обратных вызовов и обновление состояния наблюдателей каталогов на платформах, которые не поддерживают рекурсивное наблюдение в родном виде.

--watch

boolean

Наблюдать за входными файлами.

--watchDirectory

fixedpollinginterval

Укажите, как каталоги отслеживаются на системах, которые не имеют функциональности рекурсивного отслеживания файлов.

--watchFile

prioritypollinginterval

Укажите, как работает режим наблюдения TypeScript.

Флаги компилятора

Флаг Тип Значение по умолчанию
--allowArbitraryExtensions

boolean

false

Включить импорт файлов с любым расширением, при условии наличия файла объявления.

--allowImportingTsExtensions

boolean

false

Разрешить импорт файлов с расширениями TypeScript.

--allowJs

boolean

false

Разрешить JavaScript-файлы в вашей программе. Используйте опцию checkJS для получения ошибок из этих файлов.

--allowSyntheticDefaultImports

boolean

true если esModuleInterop включен, module равен system, или moduleResolution равен bundler, false в противном случае.

Разрешить 'import x from y', когда модуль не имеет экспорта по умолчанию.

--allowUmdGlobalAccess

boolean

false

Разрешить доступ к глобальным переменным UMD из модулей.

--allowUnreachableCode

boolean

Отключить выявление ошибок для недостижимого кода.

--allowUnusedLabels

boolean

Отключить выявление ошибок для неиспользуемых меток.

--alwaysStrict

boolean

true если strict, false в противном случае.

Гарантировать, что 'use strict' всегда генерируется.

--assumeChangesOnlyAffectDirectDependencies

boolean

false

При перекомпиляции в проектах, использующих incremental и режим watch, предполагать, что изменения в файле повлияют только на файлы, которые напрямую зависят от него.

--baseUrl

string

Указать базовый каталог для разрешения имён модулей, не являющихся относительными.

--charset

string

utf8

Больше не поддерживается. В ранних версиях вручную устанавливал кодировку текста для чтения файлов.

--checkJs

boolean

false

Включить вывод ошибок в файлах JavaScript с проверкой типов.

--composite

boolean

false

Включить ограничения, позволяющие использовать проект TypeScript с проектами-ссылками.

--customConditions

list

Условные значения, добавляемые к значениям по умолчанию, задаваемым обработчикам разрешения при разрешении импорта.

--declaration

boolean

true если composite, false в противном случае.

Генерировать файлы .d.ts из файлов TypeScript и JavaScript в вашем проекте.

--declarationDir

string

Указать каталог вывода сгенерированных файлов объявлений.

--declarationMap

boolean

false

Создавать sourcemap для файлов d.ts.

--diagnostics

boolean

false

Вывод информации о производительности компилятора после сборки.

--disableReferencedProjectLoad

boolean

false

Уменьшить количество проектов, загружаемых автоматически TypeScript.

--disableSizeLimit

boolean

false

Убрать ограничение в 20 МБ на общий размер исходного кода JavaScript-файлов в сервере TypeScript.

--disableSolutionSearching

boolean

false

Исключить проект из проверки ссылок на многопроектные ссылки при редактировании.

--disableSourceOfProjectReferenceRedirect

boolean

false

Отключить предпочтение исходных файлов вместо файлов объявлений при обращении к составным проектам.

--downlevelIteration

boolean

false

Генерировать более совместимый, но подробный и менее производительный JavaScript для итерации.

--emitBOM

boolean

false

Генерировать метку порядка байтов (BOM) UTF-8 в начале выходных файлов.

--emitDeclarationOnly

boolean

false

Выводить только файлы d.ts, а не файлы JavaScript.

--emitDecoratorMetadata

boolean

false

Генерировать метаданные типа проектирования для декорированных объявлений в исходных файлах.

--esModuleInterop

boolean

true если module равен node16 или nodenext, false в противном случае.

Генерировать дополнительный JavaScript для облегчения поддержки импорта модулей CommonJS. Это включает allowSyntheticDefaultImports для совместимости типов.

--exactOptionalPropertyTypes

boolean

false

Интерпретировать необязательные типы свойств как написанные, а не добавляя undefined.

--experimentalDecorators

boolean

false

Включить экспериментальную поддержку черновиков декораторов TC39 стадии 2.

--explainFiles

boolean

false

Выводить файлы, прочитанные во время компиляции, включая причину их включения.

--extendedDiagnostics

boolean

false

Выводить более подробную информацию о производительности компилятора после сборки.

--forceConsistentCasingInFileNames

boolean

true

Обеспечить правильность регистра в импортах.

--generateCpuProfile

string

profile.cpuprofile

Генерировать профиль процессора v8 выполнения компилятора для отладки.

--importHelpers

boolean

false

Разрешить импорт вспомогательных функций из tslib один раз на проект, вместо того, чтобы включать их в каждый файл.

--importsNotUsedAsValues

remove, preserve, или error

remove

Указать поведение вывода/проверки для импортов, которые используются только для типов.

--incremental

boolean

true если composite, false в противном случае.

Сохранять файлы .tsbuildinfo для возможности инкрементальной компиляции проектов.

--inlineSourceMap

boolean

false

Включать файлы sourcemap в сгенерированный JavaScript.

--inlineSources

boolean

false

Включать исходный код в sourcemaps, включенные в сгенерированный JavaScript.

--isolatedModules

boolean

false

Обеспечить, чтобы каждый файл мог быть безопасно транспилирован без ссылок на другие импорты.

--jsx

preserve, react, react-native, react-jsx, или react-jsxdev

Указать, какой код JSX генерировать.

--jsxFactory

string

React.createElement

Указать функцию-фабрику JSX, используемую при целевом выводе React JSX, например, 'React.createElement' или 'h'.

--jsxFragmentFactory

string

React.Fragment

Указать ссылку JSX на фрагмент, используемую для фрагментов при целевом выводе React JSX, например, 'React.Fragment' или 'Fragment'.

--jsxImportSource

string

react

Указать спецификатор модуля, используемый для импорта функций-фабрик JSX при использовании jsx: react-jsx*.

--keyofStringsOnly

boolean

false

Заставить keyof возвращать только строки вместо строк, чисел или символов. Старый параметр.

--lib

list

Указать набор объявленных файлов библиотек, описывающих целевую среду выполнения.

--listEmittedFiles

boolean

false

Выводить имена созданных файлов после компиляции.

--listFiles

boolean

false

Выводить все файлы, прочитанные во время компиляции.

--mapRoot

string

Указать расположение, где отладчик должен найти файлы map вместо сгенерированных расположений.

--maxNodeModuleJsDepth

number

0

Указать максимальную глубину папки, используемую для проверки файлов JavaScript из node_modules. Применимо только с allowJs.

--module

none, commonjs, amd, umd, system, es6/es2015, es2020, es2022, esnext, node16, или nodenext

CommonJS если target равно ES3 или ES5, ES6/ES2015 в противном случае.

Указать, какой код модуля сгенерировать.

--moduleDetection

legacy, auto, или force

"auto": Рассматривать файлы с импортами, экспортами, import.meta, jsx (с jsx: react-jsx) или форматом esm (с module: node16+) как модули.

Управление методом обнаружения файла JS как модуля.

--moduleResolution

classic, node10/node, node16, nodenext, или bundler

Classic если module равно AMD, UMD, System или ES6/ES2015, Совпадает, если module равно node16 или nodenext, Node в противном случае.

Указать, как TypeScript ищет файл по заданному спецификатору модуля.

--moduleSuffixes

list

Список суффиксов имен файлов для поиска при разрешении модуля.

--newLine

crlf или lf

Зависит от платформы.

Установить символ новой строки для вывода файлов.

--noEmit

boolean

false

Отключить вывод файлов из компиляции.

--noEmitHelpers

boolean

false

Отключить создание пользовательских функций-помощников, таких как __extends в сгенерированном выводе.

--noEmitOnError

boolean

false

Отключить вывод файлов, если обнаружены ошибки проверки типов.

--noErrorTruncation

boolean

false

Отключить обрезку типов в сообщениях об ошибках.

--noFallthroughCasesInSwitch

boolean

false

Включить отчет об ошибках для случаев fallthrough в операторах switch.

--noImplicitAny

boolean

true если strict, false в противном случае.

Включить сообщения об ошибках для выражений и объявлений с неявным типом any.

--noImplicitOverride

boolean

false

Убедиться, что переопределяемые члены в производных классах помечены модификатором override.

--noImplicitReturns

boolean

false

Включить сообщения об ошибках для кодовых путей, в которых в функции явным образом не возвращается значение.

--noImplicitThis

boolean

true если strict, false в противном случае.

Включить сообщения об ошибках, когда this имеет тип any.

--noImplicitUseStrict

boolean

false

Отключить добавление директив 'use strict' в создаваемые JavaScript-файлы.

--noLib

boolean

false

Отключить включение файлов библиотек, включая стандартный lib.d.ts.

--noPropertyAccessFromIndexSignature

boolean

false

Вынуждает использовать индексированные аксессоры для ключей, объявленных с использованием индексированного типа.

--noResolve

boolean

false

Запрещает importы, requireы или <reference>ы от увеличения количества файлов, которые TypeScript должен добавить в проект.

--noStrictGenericChecks

boolean

false

Отключить строгую проверку обобщённых подписей в типах функций.

--noUncheckedIndexedAccess

boolean

false

Добавить undefined к типу при обращении к нему по индексу.

--noUnusedLocals

boolean

false

Включить сообщение об ошибке, когда локальные переменные не используются.

--noUnusedParameters

boolean

false

Вызвать ошибку, когда параметр функции не используется.

--out

string

Устаревшее значение. Используйте outFile вместо него.

--outDir

string

Указать папку вывода для всех создаваемых файлов.

--outFile

string

Указать файл, в который объединяются все результаты в один файл JavaScript. Если declaration имеет значение true, также указывает файл для объединения всех результатов .d.ts.

--paths

object

Указать набор записей, которые переопределяют импорты для дополнительных мест поиска.

--plugins

list

Указать список плагинов службы языка для включения.

--preserveConstEnums

boolean

true если isolatedModules, false в противном случае.

Отключить удаление объявлений const enum в сгенерированном коде.

--preserveSymlinks

boolean

false

Отключить разрешение символических ссылок на их реальные пути. Это соответствует такому же флагу в node.

--preserveValueImports

boolean

false

Сохранить неиспользуемые импортированные значения в выходных данных JavaScript, которые в противном случае были бы удалены.

--preserveWatchOutput

boolean

false

Отключить очистку консоли в режиме наблюдения.

--pretty

boolean

true

Включить цвет и форматирование в выходных данных TypeScript, чтобы сообщения об ошибках компилятора было проще читать.

--reactNamespace

string

React

Указать объект, вызываемый для createElement. Это применимо только при использовании целевого react JSX emit.

--removeComments

boolean

false

Отключить вывод комментариев.

--resolveJsonModule

boolean

false

Включить импорт файлов .json.

--resolvePackageJsonExports

boolean

true когда 'moduleResolution' — 'node16', 'nodenext' или 'bundler'; в противном случае false.

Использовать поле 'exports' в package.json для разрешения импортов пакетов.

--resolvePackageJsonImports

boolean

true когда 'moduleResolution' — 'node16', 'nodenext' или 'bundler'; в противном случае false.

Использовать поле 'imports' в package.json для разрешения импортов.

--rootDir

string

Вычисляется из списка входных файлов.

Указать корневую папку в ваших исходных файлах.

--rootDirs

list

Вычисляется из списка входных файлов.

Разрешить обработку нескольких папок как одной при разрешении модулей.

--skipDefaultLibCheck

boolean

false

Пропустить проверку типов файлов .d.ts, которые включены с TypeScript.

--skipLibCheck

boolean

false

Пропустить проверку типов всех файлов .d.ts.

--sourceMap

boolean

false

Создать файлы source map для сгенерированных файлов JavaScript.

--sourceRoot

string

Указать корневой путь для отладчиков, чтобы найти исходный код.

--strict

boolean

false

Включить все строго настроенные параметры проверки типов.

--strictBindCallApply

boolean

true если strict, false в противном случае.

Проверить, что аргументы для методов bind, call, и apply соответствуют исходной функции.

--strictFunctionTypes

boolean

true если strict, false в противном случае.

При назначении функций проверять, чтобы параметры и возвращаемые значения были совместимы как подтипы.

--strictNullChecks

boolean

true если strict, false в противном случае.

При проверке типов учитывать null и undefined.

--strictPropertyInitialization

boolean

true если strict, false в противном случае.

Проверка свойств класса, которые объявлены, но не установлены в конструкторе.

--stripInternal

boolean

false

Отключить вывод объявлений, у которых @internal есть в их комментариях JSDoc.

--suppressExcessPropertyErrors

boolean

false

Отключить сообщения об ошибках избыточных свойств при создании объектов.

--suppressImplicitAnyIndexErrors

boolean

false

Подавить ошибки noImplicitAny при индексировании объектов, у которых нет сигнатур индексов.

--target

es5, es6/es2015, es2016, es2017, es2018, es2019, es2020, es2021, es2022, или esnext

ES3

Установить версию языка JavaScript для сгенерированного JavaScript и включить совместимые библиотечные объявления.

--traceResolution

boolean

false

Вести логи путей, используемых во время процесса moduleResolution.

END_OF_DOCUMENT_MARKER
--tsBuildInfoFile

string

.tsbuildinfo

Файл для хранения информации о .tsbuildinfo инкрементальном построении.

--typeRoots

list

Укажите несколько папок, которые будут действовать как ./node_modules/@types.

--types

list

Укажите имена пакетов типов, которые нужно включить, не ссылаясь на них в файле исходного кода.

--useDefineForClassFields

boolean

true если target равен ES2022 или выше, включая ESNext, false в противном случае.

Генерировать поля классов, совместимые со стандартом ECMAScript.

--useUnknownInCatchVariables

boolean

true если strict, false в противном случае.

Переменные блока catch по умолчанию как unknown вместо any.

--verbatimModuleSyntax

boolean

false

Не преобразовывать и не исключать импорты или экспорты, не помеченные как предназначенные только для типа, гарантируя, что они будут записаны в формате выходного файла на основе параметра «module».

Связанное

  • Каждая опция подробно описана в TSConfig Reference.
  • Узнайте, как использовать файлы tsconfig.json.
  • Узнайте, как работать в проекте MSBuild.

© 2012-2023 Microsoft
Licensed under the Apache License, Version 2.0.
https://www.typescriptlang.org/docs/handbook/compiler-options.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API