tsc CLIオプション

CLIの使用

ローカルでtscを実行すると、最も近いtsconfig.jsonで定義されたプロジェクトがコンパイルされます。または、必要なファイルのglobを渡すことで、一連のTypeScriptファイルをコンパイルできます。コマンドラインで入力ファイルが指定された場合、tsconfig.jsonファイルは無視されます。

sh
# 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

CLIのヘルプに関するローカル情報を提供します。

--init

boolean

TypeScriptプロジェクトを初期化し、tsconfig.jsonファイルを作成します。

--listFilesOnly

boolean

コンパイルの一部であるファイルの名前を出力し、処理を停止します。

--locale

string

TypeScriptからのメッセージの言語を設定します。これは出力には影響しません。

--project

string

構成ファイルへのパス、または「tsconfig.json」を含むフォルダーを指定して、プロジェクトをコンパイルします。

--showConfig

boolean

ビルドする代わりに、最終的な構成を出力します。

--version

boolean

コンパイラのバージョンを出力します。

ビルドオプション

フラグ
--build

boolean

1つ以上のプロジェクトとその依存関係を、古くなっている場合にビルドします。

--clean

boolean

すべてのプロジェクトの出力を削除します。

--dry

boolean

ビルドされる(または「--clean」で指定されている場合は削除される)内容を表示します。

--force

boolean

最新の状態であると思われるプロジェクトを含め、すべてのプロジェクトをビルドします。

--verbose

boolean

詳細ログを有効にします。

監視オプション

フラグ
--excludeDirectories

list

監視プロセスからディレクトリのリストを削除します。

--excludeFiles

list

監視モードの処理からファイルのリストを削除します。

--fallbackPolling

fixedintervalpriorityintervaldynamicpriority、またはfixedchunksize

システムでネイティブファイルウォッチャーが不足した場合に、ウォッチャーが使用するアプローチを指定します。

--synchronousWatchDirectory

boolean

再帰的な監視をネイティブでサポートしないプラットフォームで、コールバックを同期的に呼び出し、ディレクトリウォッチャーの状態を更新します。

--watch

boolean

入力ファイルを監視します。

--watchDirectory

usefseventsfixedpollingintervaldynamicprioritypolling、またはfixedchunksizepolling

再帰的なファイル監視機能がないシステムでディレクトリを監視する方法を指定します。

--watchFile

fixedpollingintervalprioritypollingintervaldynamicprioritypollingfixedchunksizepollingusefsevents、またはusefseventsonparentdirectory

TypeScriptのウォッチモードの動作方法を指定します。

コンパイラフラグ

フラグ デフォルト
--allowArbitraryExtensions

boolean

false

宣言ファイルが存在する場合、任意の拡張子を持つファイルのインポートを有効にします。

--allowImportingTsExtensions

boolean

false

インポートにTypeScriptファイルの拡張子を含めることを許可します。

--allowJs

boolean

false

JavaScriptファイルをプログラムの一部として使用できるようにします。これらのファイルからエラーを取得するには、checkJSオプションを使用してください。

--allowSyntheticDefaultImports

boolean

esModuleInteropが有効である場合、modulesystemである場合、またはmoduleResolutionbundlerである場合はtrue。それ以外の場合はfalse

モジュールにデフォルトエクスポートがない場合に、「import x from y」を許可します。

--allowUmdGlobalAccess

boolean

false

モジュールからUMDグローバルへのアクセスを許可します。

--allowUnreachableCode

boolean

到達不能なコードのエラー報告を無効にします。

--allowUnusedLabels

boolean

未使用のラベルのエラー報告を無効にします。

--alwaysStrict

boolean

strictの場合はtrue。それ以外の場合はfalse

常に「use strict」が出力されるようにします。

--assumeChangesOnlyAffectDirectDependencies

boolean

false

incrementalwatchモードを使用するプロジェクトでの再コンパイルにおいて、ファイル内の変更はそれに直接依存するファイルにのみ影響すると仮定します。

--baseUrl

string

ベア指定子のモジュール名を解決するためのベースディレクトリを指定します。

--charset

string

utf8

サポートされなくなりました。初期バージョンでは、ファイルの読み取り用のテキストエンコーディングを手動で設定していました。

--checkJs

boolean

false

型チェックされたJavaScriptファイルでエラー報告を有効にします。

--composite

boolean

false

TypeScriptプロジェクトをプロジェクト参照で使用できるようにする制約を有効にします。

--customConditions

list

インポートを解決する際に、リゾルバー固有のデフォルトに加えて設定する条件。

--declaration

boolean

compositeの場合はtrue。それ以外の場合はfalse

プロジェクト内のTypeScriptファイルとJavaScriptファイルから.d.tsファイルを生成します。

--declarationDir

string

生成された宣言ファイルの出力ディレクトリを指定します。

--declarationMap

boolean

false

d.tsファイルのソースマップを作成します。

--diagnostics

boolean

false

ビルド後にコンパイラのパフォーマンス情報を出力します。

--disableReferencedProjectLoad

boolean

false

TypeScriptによって自動的にロードされるプロジェクトの数を減らします。

--disableSizeLimit

boolean

false

TypeScript言語サーバーのJavaScriptファイルの総ソースコードサイズに対する20MBの上限を削除します。

--disableSolutionSearching

boolean

false

編集時に、マルチプロジェクト参照チェックからプロジェクトを除外します。

--disableSourceOfProjectReferenceRedirect

boolean

false

コンポジットプロジェクトを参照する場合、宣言ファイルではなくソースファイルを優先することを無効にします。

--downlevelIteration

boolean

false

より準拠しているが冗長でパフォーマンスの低いJavaScriptをイテレーションのために出力します。

--emitBOM

boolean

false

出力ファイルの先頭にUTF-8バイトオーダーマーク(BOM)を出力します。

--emitDeclarationOnly

boolean

false

d.tsファイルのみを出力し、JavaScriptファイルは出力しません。

--emitDecoratorMetadata

boolean

false

ソースファイル内のデコレートされた宣言のデザインタイプのメタデータを出力します。

--esModuleInterop

boolean

modulenode16またはnodenextの場合はtrue。それ以外の場合はfalse

CommonJSモジュールのインポートのサポートを容易にするために追加のJavaScriptを出力します。これにより、型互換性のためにallowSyntheticDefaultImportsが有効になります。

--exactOptionalPropertyTypes

boolean

false

オプションのプロパティ型を、undefinedを追加するのではなく、記述されたとおりに解釈します。

--experimentalDecorators

boolean

false

TC39ステージ2ドラフトデコレーターの実験的なサポートを有効にします。

--explainFiles

boolean

false

コンパイル中に読み込まれたファイルとその理由を出力します。

--extendedDiagnostics

boolean

false

ビルド後に、より詳細なコンパイラのパフォーマンス情報を出力します。

--forceConsistentCasingInFileNames

boolean

true

インポートで大文字と小文字が正しく使用されていることを確認します。

--generateCpuProfile

string

profile.cpuprofile

デバッグ用に、コンパイラ実行のv8 CPUプロファイルを出力します。

--importHelpers

boolean

false

ファイルごとに含めるのではなく、プロジェクトごとに1回tslibからヘルパー関数をインポートできるようにします。

--importsNotUsedAsValues

removepreserve、またはerror

remove

型にのみ使用されるインポートの出力/チェック動作を指定します。

--incremental

boolean

compositeの場合はtrue。それ以外の場合はfalse

プロジェクトのインクリメンタルコンパイルを可能にするために.tsbuildinfoファイルを保存します。

--inlineSourceMap

boolean

false

出力されたJavaScript内にソースマップファイルを含めます。

--inlineSources

boolean

false

出力されたJavaScript内のソースマップにソースコードを含めます。

--isolatedModules

boolean

false

各ファイルが他のインポートに依存せずに安全にトランスパイルできるようにします。

--jsx

preservereactreact-nativereact-jsx、またはreact-jsxdev

生成されるJSXコードを指定します。

--jsxFactory

string

React.createElement

React JSX出力(例:'React.createElement'または'h')をターゲットにするときに使用するJSXファクトリ関数を指定します。

--jsxFragmentFactory

string

React.Fragment

React JSX出力(例:'React.Fragment'または'Fragment')をターゲットにするときにフラグメントに使用するJSXフラグメント参照を指定します。

--jsxImportSource

string

react

jsx: react-jsx*を使用する場合にJSXファクトリ関数をインポートするために使用されるモジュール指定子を指定します。

--keyofStringsOnly

boolean

false

keyofが文字列、数値、またはシンボルの代わりに文字列のみを返すようにします。レガシーオプション。

--lib

list

ターゲットランタイム環境を記述するバンドルされたライブラリ宣言ファイルのセットを指定します。

--listEmittedFiles

boolean

false

コンパイル後に、出力されたファイルの名前を出力します。

--listFiles

boolean

false

コンパイル中に読み込まれたすべてのファイルを出力します。

--mapRoot

string

デバッガーが生成された場所の代わりにマップファイルを検索する場所を指定します。

--maxNodeModuleJsDepth

number

0

node_modulesからJavaScriptファイルをチェックするために使用される最大フォルダー深度を指定します。allowJsでのみ適用可能です。

--module

nonecommonjsamdumdsystemes6/es2015es2020es2022esnextnode16、またはnodenext

targetES3またはES5の場合はCommonJS。それ以外の場合はES6/ES2015

生成されるモジュールコードを指定します。

--moduleDetection

legacyauto、またはforce

「auto」:インポート、エクスポート、import.meta、jsx(jsx:react-jsxを使用)、またはesm形式(module:node16 +を使用)を含むファイルをモジュールとして扱います。

ファイルがスクリプトであるかモジュールであるかを検出するために使用されるメソッドを指定します。

--moduleResolution

classicnode10/nodenode16nodenext、またはbundler

moduleAMDUMDSystem、またはES6/ES2015の場合はClassicmodulenode16またはnodenextの場合は一致。それ以外の場合はNode

TypeScriptが指定されたモジュール指定子からファイルを検索する方法を指定します。

--moduleSuffixes

list

モジュールを解決する際に検索するファイル名サフィックスのリスト。

--newLine

crlfまたはlf

プラットフォーム固有。

ファイル出力の改行文字を設定します。

--noEmit

boolean

false

コンパイルからのファイル出力を無効にします。

--noEmitHelpers

boolean

false

コンパイルされた出力で__extendsのようなカスタムヘルパー関数の生成を無効にします。

--noEmitOnError

boolean

false

タイプチェックエラーが報告された場合、ファイルの出力を無効にします。

--noErrorTruncation

boolean

false

エラーメッセージでの型の切り捨てを無効にします。

--noFallthroughCasesInSwitch

boolean

false

switchステートメントでのフォールスルーケースのエラー報告を有効にします。

--noImplicitAny

boolean

strictの場合はtrue。それ以外の場合はfalse

暗黙的なany型を持つ式と宣言のエラー報告を有効にします。

--noImplicitOverride

boolean

false

派生クラスのオーバーライドメンバーがoverride修飾子でマークされていることを確認します。

--noImplicitReturns

boolean

false

関数内で明示的に返されないコードパスのエラー報告を有効にします。

--noImplicitThis

boolean

strictの場合はtrue。それ以外の場合はfalse

thisany型が与えられた場合のエラー報告を有効にします。

--noImplicitUseStrict

boolean

false

出力されたJavaScriptファイルに「use strict」ディレクティブを追加することを無効にします。

--noLib

boolean

false

デフォルトのlib.d.tsを含む、ライブラリファイルを含めることを無効にします。

--noPropertyAccessFromIndexSignature

boolean

false

インデックス付きタイプを使用して宣言されたキーに対してインデックス付きアクセサーの使用を強制します。

--noResolve

boolean

false

TypeScriptがプロジェクトに追加するファイルの数を増やすためのimportrequire、または<reference>を許可しません。

--noStrictGenericChecks

boolean

false

関数型のジェネリックシグネチャの厳密なチェックを無効にします。

--noUncheckedIndexedAccess

boolean

false

インデックスを使用してアクセスする場合、型にundefinedを追加します。

--noUnusedLocals

boolean

false

ローカル変数が読み取られない場合のエラー報告を有効にします。

--noUnusedParameters

boolean

false

関数のパラメーターが読み取られない場合にエラーを発生させます。

--out

string

非推奨の設定。outFileを代わりに使用してください。

--outDir

string

すべての出力ファイルの出力フォルダーを指定します。

--outFile

string

すべての出力を1つのJavaScriptファイルにバンドルするファイルを指定します。declarationがtrueの場合、すべての.d.ts出力をバンドルするファイルも指定します。

--paths

object

インポートを追加の検索場所に再マップするエントリのセットを指定します。

--plugins

list

含める言語サービスプラグインのリストを指定します。

--preserveConstEnums

boolean

isolatedModulesの場合はtrue。それ以外の場合はfalse

生成されたコードでconst enum宣言を消去することを無効にします。

--preserveSymlinks

boolean

false

シンボリックリンクをそのrealpathに解決することを無効にします。これは、nodeの同じフラグに対応します。

--preserveValueImports

boolean

false

それ以外の場合は削除されるJavaScript出力で、未使用のインポートされた値を保持します。

--preserveWatchOutput

boolean

false

ウォッチモードでコンソールをワイプすることを無効にします。

--pretty

boolean

true

TypeScript の出力で色と書式設定を有効にすると、コンパイラ エラーが読みやすくなります。

--reactNamespace

string

React

createElement に指定されたオブジェクトを指定します。これは、react JSX 出力をターゲットにしている場合にのみ適用されます。

--removeComments

boolean

false

コメントの出力を無効にします。

--resolveJsonModule

boolean

false

.json ファイルのインポートを有効にします。

--resolvePackageJsonExports

boolean

moduleResolutionnode16nodenext、または bundler の場合は true、それ以外の場合は false です。

パッケージのインポートを解決する際に package.json の 'exports' フィールドを使用します。

--resolvePackageJsonImports

boolean

moduleResolutionnode16nodenext、または bundler の場合は true、それ以外の場合は false です。

インポートを解決する際に package.json の 'imports' フィールドを使用します。

--rootDir

string

入力ファイルのリストから計算されます。

ソース ファイル内のルート フォルダーを指定します。

--rootDirs

list

入力ファイルのリストから計算されます。

モジュールを解決する際に、複数のフォルダーを 1 つとして扱うことを許可します。

--skipDefaultLibCheck

boolean

false

TypeScript に含まれている .d.ts ファイルの型チェックをスキップします。

--skipLibCheck

boolean

false

すべての .d.ts ファイルの型チェックをスキップします。

--sourceMap

boolean

false

出力された JavaScript ファイルのソース マップ ファイルを作成します。

--sourceRoot

string

デバッガーが参照元コードを見つけるためのルート パスを指定します。

--strict

boolean

false

すべての厳密な型チェック オプションを有効にします。

--strictBindCallApply

boolean

strictの場合はtrue。それ以外の場合はfalse

bindcall、および apply メソッドの引数が元の関数と一致することを確認します。

--strictFunctionTypes

boolean

strictの場合はtrue。それ以外の場合はfalse

関数を割り当てる際に、パラメーターと戻り値がサブタイプ互換であることを確認します。

--strictNullChecks

boolean

strictの場合はtrue。それ以外の場合はfalse

型チェック時に、null および undefined を考慮します。

--strictPropertyInitialization

boolean

strictの場合はtrue。それ以外の場合はfalse

クラス プロパティが宣言されているが、コンストラクターで設定されていないことを確認します。

--stripInternal

boolean

false

JSDoc コメントに @internal が含まれている宣言の出力を無効にします。

--suppressExcessPropertyErrors

boolean

false

オブジェクト リテラルの作成時に、余分なプロパティ エラーの報告を無効にします。

--suppressImplicitAnyIndexErrors

boolean

false

インデックス シグネチャがないオブジェクトをインデックス化する際に、noImplicitAny エラーを抑制します。

--target

es3es5es6/es2015es2016es2017es2018es2019es2020es2021es2022、または esnext

ES3

出力される JavaScript の言語バージョンを設定し、互換性のあるライブラリ宣言を含めます。

--traceResolution

boolean

false

moduleResolution プロセス中に使用されるパスをログに記録します。

--tsBuildInfoFile

string

.tsbuildinfo

.tsbuildinfo のインクリメンタル ビルド情報を保存するファイル。

--typeRoots

list

./node_modules/@types のように動作する複数のフォルダーを指定します。

--types

list

ソース ファイルで参照されずに含まれる型パッケージ名を指定します。

--useDefineForClassFields

boolean

targetES2022 以上(ESNext を含む)の場合は true、それ以外の場合は false です。

ECMAScript 標準準拠のクラス フィールドを出力します。

--useUnknownInCatchVariables

boolean

strictの場合はtrue。それ以外の場合はfalse

既定のキャッチ句変数を any の代わりに unknown とします。

--verbatimModuleSyntax

boolean

false

型のみとしてマークされていないインポートまたはエクスポートを変換または省略せず、'module' 設定に基づいて出力ファイルの形式で書き込まれるようにします。

TypeScript ドキュメントはオープン ソース プロジェクトです。これらのページを改善するために、プル リクエストを送信してご協力ください ❤

このページのコントリビューター
MHMohamed Hegazy (96)
OTOrta Therox (54)
DRDaniel Rosenwasser (19)
ADAxel D (14)
AGAnton Gilgur (7)
60+

最終更新日: 2024年3月21日