CLIの使用
ローカルでtsc
を実行すると、最も近いtsconfig.json
で定義されたプロジェクトがコンパイルされます。または、必要なファイルのglobを渡すことで、一連のTypeScriptファイルをコンパイルできます。コマンドラインで入力ファイルが指定された場合、tsconfig.json
ファイルは無視されます。
sh
# Run a compile based on a backwards look through the fs for a tsconfig.jsontsc# Emit JS for just the index.ts with the compiler defaultstsc index.ts# Emit JS for any .ts files in the folder src, with the default settingstsc src/*.ts# Emit files referenced in with the compiler settings from tsconfig.production.jsontsc --project tsconfig.production.json# Emit d.ts files for a js file with showing compiler options which are booleanstsc index.js --declaration --emitDeclarationOnly# Emit a single .js file from two files via compiler options which take string argumentstsc app.ts util.ts --target esnext --outfile index.js
コンパイラオプション
tsconfigのコンパイラオプションの詳細については、TSConfigリファレンスを確認してください。
CLIコマンド
フラグ | 型 | |
---|---|---|
--all |
|
|
すべてのコンパイラオプションを表示します。 | ||
--generateTrace |
|
|
イベントトレースと型のリストを生成します。 | ||
--help |
|
|
CLIのヘルプに関するローカル情報を提供します。 | ||
--init |
|
|
TypeScriptプロジェクトを初期化し、tsconfig.jsonファイルを作成します。 | ||
--listFilesOnly |
|
|
コンパイルの一部であるファイルの名前を出力し、処理を停止します。 | ||
--locale |
|
|
TypeScriptからのメッセージの言語を設定します。これは出力には影響しません。 | ||
--project |
|
|
構成ファイルへのパス、または「tsconfig.json」を含むフォルダーを指定して、プロジェクトをコンパイルします。 | ||
--showConfig |
|
|
ビルドする代わりに、最終的な構成を出力します。 | ||
--version |
|
|
コンパイラのバージョンを出力します。 |
ビルドオプション
フラグ | 型 | |
---|---|---|
--build |
|
|
1つ以上のプロジェクトとその依存関係を、古くなっている場合にビルドします。 | ||
--clean |
|
|
すべてのプロジェクトの出力を削除します。 | ||
--dry |
|
|
ビルドされる(または「--clean」で指定されている場合は削除される)内容を表示します。 | ||
--force |
|
|
最新の状態であると思われるプロジェクトを含め、すべてのプロジェクトをビルドします。 | ||
--verbose |
|
|
詳細ログを有効にします。 |
監視オプション
フラグ | 型 | |
---|---|---|
--excludeDirectories |
|
|
監視プロセスからディレクトリのリストを削除します。 | ||
--excludeFiles |
|
|
監視モードの処理からファイルのリストを削除します。 | ||
--fallbackPolling |
|
|
システムでネイティブファイルウォッチャーが不足した場合に、ウォッチャーが使用するアプローチを指定します。 | ||
--synchronousWatchDirectory |
|
|
再帰的な監視をネイティブでサポートしないプラットフォームで、コールバックを同期的に呼び出し、ディレクトリウォッチャーの状態を更新します。 | ||
--watch |
|
|
入力ファイルを監視します。 | ||
--watchDirectory |
|
|
再帰的なファイル監視機能がないシステムでディレクトリを監視する方法を指定します。 | ||
--watchFile |
|
|
TypeScriptのウォッチモードの動作方法を指定します。 |
コンパイラフラグ
フラグ | 型 | デフォルト |
---|---|---|
--allowArbitraryExtensions |
|
|
宣言ファイルが存在する場合、任意の拡張子を持つファイルのインポートを有効にします。 | ||
--allowImportingTsExtensions |
|
|
インポートにTypeScriptファイルの拡張子を含めることを許可します。 | ||
--allowJs |
|
|
JavaScriptファイルをプログラムの一部として使用できるようにします。これらのファイルからエラーを取得するには、 | ||
--allowSyntheticDefaultImports |
|
|
モジュールにデフォルトエクスポートがない場合に、「import x from y」を許可します。 | ||
--allowUmdGlobalAccess |
|
|
モジュールからUMDグローバルへのアクセスを許可します。 | ||
--allowUnreachableCode |
|
|
到達不能なコードのエラー報告を無効にします。 | ||
--allowUnusedLabels |
|
|
未使用のラベルのエラー報告を無効にします。 | ||
--alwaysStrict |
|
|
常に「use strict」が出力されるようにします。 | ||
--assumeChangesOnlyAffectDirectDependencies |
|
|
| ||
--baseUrl |
|
|
ベア指定子のモジュール名を解決するためのベースディレクトリを指定します。 | ||
--charset |
|
|
サポートされなくなりました。初期バージョンでは、ファイルの読み取り用のテキストエンコーディングを手動で設定していました。 | ||
--checkJs |
|
|
型チェックされたJavaScriptファイルでエラー報告を有効にします。 | ||
--composite |
|
|
TypeScriptプロジェクトをプロジェクト参照で使用できるようにする制約を有効にします。 | ||
--customConditions |
|
|
インポートを解決する際に、リゾルバー固有のデフォルトに加えて設定する条件。 | ||
--declaration |
|
|
プロジェクト内のTypeScriptファイルとJavaScriptファイルから.d.tsファイルを生成します。 | ||
--declarationDir |
|
|
生成された宣言ファイルの出力ディレクトリを指定します。 | ||
--declarationMap |
|
|
d.tsファイルのソースマップを作成します。 | ||
--diagnostics |
|
|
ビルド後にコンパイラのパフォーマンス情報を出力します。 | ||
--disableReferencedProjectLoad |
|
|
TypeScriptによって自動的にロードされるプロジェクトの数を減らします。 | ||
--disableSizeLimit |
|
|
TypeScript言語サーバーのJavaScriptファイルの総ソースコードサイズに対する20MBの上限を削除します。 | ||
--disableSolutionSearching |
|
|
編集時に、マルチプロジェクト参照チェックからプロジェクトを除外します。 | ||
--disableSourceOfProjectReferenceRedirect |
|
|
コンポジットプロジェクトを参照する場合、宣言ファイルではなくソースファイルを優先することを無効にします。 | ||
--downlevelIteration |
|
|
より準拠しているが冗長でパフォーマンスの低いJavaScriptをイテレーションのために出力します。 | ||
--emitBOM |
|
|
出力ファイルの先頭にUTF-8バイトオーダーマーク(BOM)を出力します。 | ||
--emitDeclarationOnly |
|
|
d.tsファイルのみを出力し、JavaScriptファイルは出力しません。 | ||
--emitDecoratorMetadata |
|
|
ソースファイル内のデコレートされた宣言のデザインタイプのメタデータを出力します。 | ||
--esModuleInterop |
|
|
CommonJSモジュールのインポートのサポートを容易にするために追加のJavaScriptを出力します。これにより、型互換性のために | ||
--exactOptionalPropertyTypes |
|
|
オプションのプロパティ型を、 | ||
--experimentalDecorators |
|
|
TC39ステージ2ドラフトデコレーターの実験的なサポートを有効にします。 | ||
--explainFiles |
|
|
コンパイル中に読み込まれたファイルとその理由を出力します。 | ||
--extendedDiagnostics |
|
|
ビルド後に、より詳細なコンパイラのパフォーマンス情報を出力します。 | ||
--forceConsistentCasingInFileNames |
|
|
インポートで大文字と小文字が正しく使用されていることを確認します。 | ||
--generateCpuProfile |
|
|
デバッグ用に、コンパイラ実行のv8 CPUプロファイルを出力します。 | ||
--importHelpers |
|
|
ファイルごとに含めるのではなく、プロジェクトごとに1回tslibからヘルパー関数をインポートできるようにします。 | ||
--importsNotUsedAsValues |
|
|
型にのみ使用されるインポートの出力/チェック動作を指定します。 | ||
--incremental |
|
|
プロジェクトのインクリメンタルコンパイルを可能にするために.tsbuildinfoファイルを保存します。 | ||
--inlineSourceMap |
|
|
出力されたJavaScript内にソースマップファイルを含めます。 | ||
--inlineSources |
|
|
出力されたJavaScript内のソースマップにソースコードを含めます。 | ||
--isolatedModules |
|
|
各ファイルが他のインポートに依存せずに安全にトランスパイルできるようにします。 | ||
--jsx |
|
|
生成されるJSXコードを指定します。 | ||
--jsxFactory |
|
|
React JSX出力(例:'React.createElement'または'h')をターゲットにするときに使用するJSXファクトリ関数を指定します。 | ||
--jsxFragmentFactory |
|
|
React JSX出力(例:'React.Fragment'または'Fragment')をターゲットにするときにフラグメントに使用するJSXフラグメント参照を指定します。 | ||
--jsxImportSource |
|
|
| ||
--keyofStringsOnly |
|
|
keyofが文字列、数値、またはシンボルの代わりに文字列のみを返すようにします。レガシーオプション。 | ||
--lib |
|
|
ターゲットランタイム環境を記述するバンドルされたライブラリ宣言ファイルのセットを指定します。 | ||
--listEmittedFiles |
|
|
コンパイル後に、出力されたファイルの名前を出力します。 | ||
--listFiles |
|
|
コンパイル中に読み込まれたすべてのファイルを出力します。 | ||
--mapRoot |
|
|
デバッガーが生成された場所の代わりにマップファイルを検索する場所を指定します。 | ||
--maxNodeModuleJsDepth |
|
|
| ||
--module |
|
|
生成されるモジュールコードを指定します。 | ||
--moduleDetection |
|
「auto」:インポート、エクスポート、import.meta、jsx(jsx:react-jsxを使用)、またはesm形式(module:node16 +を使用)を含むファイルをモジュールとして扱います。 |
ファイルがスクリプトであるかモジュールであるかを検出するために使用されるメソッドを指定します。 | ||
--moduleResolution |
|
|
TypeScriptが指定されたモジュール指定子からファイルを検索する方法を指定します。 | ||
--moduleSuffixes |
|
|
モジュールを解決する際に検索するファイル名サフィックスのリスト。 | ||
--newLine |
|
プラットフォーム固有。 |
ファイル出力の改行文字を設定します。 | ||
--noEmit |
|
|
コンパイルからのファイル出力を無効にします。 | ||
--noEmitHelpers |
|
|
コンパイルされた出力で | ||
--noEmitOnError |
|
|
タイプチェックエラーが報告された場合、ファイルの出力を無効にします。 | ||
--noErrorTruncation |
|
|
エラーメッセージでの型の切り捨てを無効にします。 | ||
--noFallthroughCasesInSwitch |
|
|
switchステートメントでのフォールスルーケースのエラー報告を有効にします。 | ||
--noImplicitAny |
|
|
暗黙的な | ||
--noImplicitOverride |
|
|
派生クラスのオーバーライドメンバーがoverride修飾子でマークされていることを確認します。 | ||
--noImplicitReturns |
|
|
関数内で明示的に返されないコードパスのエラー報告を有効にします。 | ||
--noImplicitThis |
|
|
| ||
--noImplicitUseStrict |
|
|
出力されたJavaScriptファイルに「use strict」ディレクティブを追加することを無効にします。 | ||
--noLib |
|
|
デフォルトのlib.d.tsを含む、ライブラリファイルを含めることを無効にします。 | ||
--noPropertyAccessFromIndexSignature |
|
|
インデックス付きタイプを使用して宣言されたキーに対してインデックス付きアクセサーの使用を強制します。 | ||
--noResolve |
|
|
TypeScriptがプロジェクトに追加するファイルの数を増やすための | ||
--noStrictGenericChecks |
|
|
関数型のジェネリックシグネチャの厳密なチェックを無効にします。 | ||
--noUncheckedIndexedAccess |
|
|
インデックスを使用してアクセスする場合、型に | ||
--noUnusedLocals |
|
|
ローカル変数が読み取られない場合のエラー報告を有効にします。 | ||
--noUnusedParameters |
|
|
関数のパラメーターが読み取られない場合にエラーを発生させます。 | ||
--out |
|
|
非推奨の設定。 | ||
--outDir |
|
|
すべての出力ファイルの出力フォルダーを指定します。 | ||
--outFile |
|
|
すべての出力を1つのJavaScriptファイルにバンドルするファイルを指定します。 | ||
--paths |
|
|
インポートを追加の検索場所に再マップするエントリのセットを指定します。 | ||
--plugins |
|
|
含める言語サービスプラグインのリストを指定します。 | ||
--preserveConstEnums |
|
|
生成されたコードで | ||
--preserveSymlinks |
|
|
シンボリックリンクをそのrealpathに解決することを無効にします。これは、nodeの同じフラグに対応します。 | ||
--preserveValueImports |
|
|
それ以外の場合は削除されるJavaScript出力で、未使用のインポートされた値を保持します。 | ||
--preserveWatchOutput |
|
|
ウォッチモードでコンソールをワイプすることを無効にします。 | ||
--pretty |
|
|
TypeScript の出力で色と書式設定を有効にすると、コンパイラ エラーが読みやすくなります。 | ||
--reactNamespace |
|
|
| ||
--removeComments |
|
|
コメントの出力を無効にします。 | ||
--resolveJsonModule |
|
|
.json ファイルのインポートを有効にします。 | ||
--resolvePackageJsonExports |
|
|
パッケージのインポートを解決する際に package.json の 'exports' フィールドを使用します。 | ||
--resolvePackageJsonImports |
|
|
インポートを解決する際に package.json の 'imports' フィールドを使用します。 | ||
--rootDir |
|
入力ファイルのリストから計算されます。 |
ソース ファイル内のルート フォルダーを指定します。 | ||
--rootDirs |
|
入力ファイルのリストから計算されます。 |
モジュールを解決する際に、複数のフォルダーを 1 つとして扱うことを許可します。 | ||
--skipDefaultLibCheck |
|
|
TypeScript に含まれている .d.ts ファイルの型チェックをスキップします。 | ||
--skipLibCheck |
|
|
すべての .d.ts ファイルの型チェックをスキップします。 | ||
--sourceMap |
|
|
出力された JavaScript ファイルのソース マップ ファイルを作成します。 | ||
--sourceRoot |
|
|
デバッガーが参照元コードを見つけるためのルート パスを指定します。 | ||
--strict |
|
|
すべての厳密な型チェック オプションを有効にします。 | ||
--strictBindCallApply |
|
|
| ||
--strictFunctionTypes |
|
|
関数を割り当てる際に、パラメーターと戻り値がサブタイプ互換であることを確認します。 | ||
--strictNullChecks |
|
|
型チェック時に、 | ||
--strictPropertyInitialization |
|
|
クラス プロパティが宣言されているが、コンストラクターで設定されていないことを確認します。 | ||
--stripInternal |
|
|
JSDoc コメントに | ||
--suppressExcessPropertyErrors |
|
|
オブジェクト リテラルの作成時に、余分なプロパティ エラーの報告を無効にします。 | ||
--suppressImplicitAnyIndexErrors |
|
|
インデックス シグネチャがないオブジェクトをインデックス化する際に、 | ||
--target |
|
|
出力される JavaScript の言語バージョンを設定し、互換性のあるライブラリ宣言を含めます。 | ||
--traceResolution |
|
|
| ||
--tsBuildInfoFile |
|
|
| ||
--typeRoots |
|
|
| ||
--types |
|
|
ソース ファイルで参照されずに含まれる型パッケージ名を指定します。 | ||
--useDefineForClassFields |
|
|
ECMAScript 標準準拠のクラス フィールドを出力します。 | ||
--useUnknownInCatchVariables |
|
|
既定のキャッチ句変数を | ||
--verbatimModuleSyntax |
|
|
型のみとしてマークされていないインポートまたはエクスポートを変換または省略せず、'module' 設定に基づいて出力ファイルの形式で書き込まれるようにします。 |
関連
- すべてのオプションは、TSConfig リファレンスで完全に説明されています。
tsconfig.json
ファイルの使用方法を学びましょう。- MSBuild プロジェクトでの作業方法を学びましょう。