コンパイラ・オプション

コンパイラ・オプション

オプション 説明
--allowJs

型:boolean
デフォルト:true

JavaScriptファイルのコンパイルを許可。

--allowSyntheticDefaultImports

型:boolean
デフォルト:(module === "system")

default export無しでのdefault importを許可。 コードの出力には影響せず、型チェックでのみ影響します。

--allowUnreachableCode

型:boolean
デフォルト:false

到達不可能なコードのエラーを報告しません。

--allowUnusedLabels

型:boolean
デフォルト:false

使用されていないラベルのエラーを報告しません。

--charset

型:string
デフォルト:"utf8"

入力ファイルの文字コードを指定します。

--declaration
-d

型:boolean
デフォルト:false

対応する.d.tsファイルを生成します。

--declarationDir

型:string

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

--diagnostics

型:boolean
デフォルト:false

診断情報を表示します。

--disableSizeLimit

型:boolean
デフォルト:false

JavaScriptのプロジェクトのサイズ制限を無効にします。

--emitBOM

型:boolean
デフォルト:false

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

--emitDecoratorMetadata[1]

型:boolean
デフォルト:false

ソース内の装飾された宣言のためのdesign-typeを出力します。 詳細は、issue #2577を参照してください。

--experimentalDecorators[1]

型:boolean
デフォルト:false

試験的なEcmaScriptのデコレータのサポートを有効にします。

--forceConsistentCasingInFileNames

型:boolean
デフォルト:false

同じファイルへの一貫性のない参照を禁止します。

--help
-h
ヘルプメッセージを出力します。
--importHelpers

型:boolean
デフォルト:false

tslibのヘルパー(例: __extends__rest等)をインポートするように指定します。

--inlineSourceMap

型:boolean
デフォルト:false

個別のソースマップのファイルを持つ代わりに、一つのソースマップファイルを出力します。

--inlineSources

型:boolean
デフォルト:false

sourcemapsに沿ってソースを単一ファイルにして出力します。 --inlineSourceMapまたは--sourceMapの設定が必要になります。

--init TypeScriptプロジェクトの初期化を行い、tsconfig.jsonファイルを生成します。
--isolatedModules

型:boolean
デフォルト:false

無条件に未解決ファイルのimportを出力します。

--jsx

型:string
デフォルト:"Preserve"

.tsxファイルのJSXをサポートします。 "React""Preserve"のどちらかを指定します。 詳細は、JSXを参照してください。

--jsxFactory

型:string
デフォルト:"React.createElement"

reactのJSXを対象としている際に使用するJSXファクトリー関数(例: React.createElementh)を指定します。

--lib

型:string[]

コンパイルに含めるライブラリのファイルの一覧を指定します。 指定可能なライブラリは下記のとおりです。

  • ES5
  • ES6
  • ES2015
  • ES7
  • ES2016
  • ES2017
  • DOM
  • DOM.Iterable
  • WebWorker
  • ScriptHost
  • ES2015.Core
  • ES2015.Collection
  • ES2015.Generator
  • ES2015.Iterable
  • ES2015.Promise
  • ES2015.Proxy
  • ES2015.Reflect
  • ES2015.Symbol
  • ES2015.Symbol.WellKnown
  • ES2016.Array.Include
  • ES2017.object
  • ES2017.SharedMemory

注意: もし、--libが指定されなかった場合は、下記のようにデフォルトのライブラリが注入されます。

  • --target ES5の場合: DOM,ES5,ScriptHost
  • --target ES6の場合: DOM,ES6,DOM.Iterable,ScriptHost
--listEmittedFiles

型:boolean
デフォルト:false

生成されたファイルの名前をコンパイルの一部として出力します。

--listFiles

型:boolean
デフォルト:false

コンパイルされるファイル名の部分が出力されます。

--locale

型:string
デフォルト:(プラットフォーム固有)

エラーメッセージの表示に使用されるlocaleです。(例: en-us)

--mapRoot

型:string

生成される場所の代わりに、デバッガがmapファイルを探すべき場所を指定します。 実行時に、.mapファイルが.jsファイルとは異なる場所に配置される場合に、このフラグを使用します。 この場所の指定はsourceMapに埋め込まれ、デバッガにmapファイルが配置されている場所を知らせます。

--maxNodeModuleJsDepth

型:number
デフォルト:0

node_modulesを探して、JavaScriptファイルを読み込むための依存の最大深度を指定します。 --allowJsを指定された時にだけ適用されます。

--module
-m

型:string
デフォルト:(target === "ES6" ? "ES6" : "CommonJS")

モジュールの方式を'none''commonjs''amd''system''umd''es6''es2015'指定します。

  • 'amd''system'だけが、--outFileと混同して使用することが可能です。
  • ES5を対象とする場合は、'es6''es2015'の値は使用出来ません。
--moduleResolution

型:string
デフォルト:"Classic"

モジュールをどのように解決するのかを決定します。 Node.js/io.jsスタイルの解決を行う'node'、または'classic'(デフォルト)を指定します。 詳細は、モジュール解決のドキュメントを参照してください。

--newLine

型:string
デフォルト:(プラットフォーム固有)

ファイルの出力時に使用する改行コードを指定します。 'srlf'(windows)、'lf'(unix)

--noEmit

型:boolean
デフォルト:false

出力を行いません。

--noEmitHelpers

型:boolean
デフォルト:false

コンパイル出力に__extendsのようなカスタムヘルパー関数を生成しません。

--noEmitOnError

型:boolean
デフォルト:false

何かしらのエラーが報告された場合、出力を行いません。

--noFallthroughCasesInSwitch

型:boolean
デフォルト:false

switch文でのフォールスルー(break忘れ)に対してエラーを報告します。

--noImplicitAny

型:boolean
デフォルト:false

式と宣言に暗黙的な'any'があると、エラーを発生させます。

--noImplicitReturns

型:boolean
デフォルト:false

関数内のコードが値を返さない場合に、エラーを報告します。

--noImplicitThis

型:boolean
デフォルト:false

this式が暗黙的なany型の場合にエラーにします。

--noImplicitUseStrict

型:boolean
デフォルト:false

モジュールの出力に、"use strict"を付けません。

--noLib

型:boolean
デフォルト:false

デフォルトのライブラリファイル(lib.d.ts)を含めません。

--noResolve

型:boolean
デフォルト:false

3連スラッシュの参照、またはimport対象のモジュールをコンパイルされたファイルのリストに追加しません。

--noUnusedLocals

型:boolean
デフォルト:false

使用されていないローカル(変数)があると、エラーを報告します。

--noUnusedParameters

型:boolean
デフォルト:false

使用されていないパラメーターがあると、エラーを報告します。

--out

型:string
デフォルト:null

このオプションは非推奨です。代わりに、--outFileを使用してください。

--outDir

型:string
デフォルト:null

指定したディレクトリへ、生成されるものを出力します。

--outFile

型:string
デフォルト:null

出力されるファイルを1つのファイルに連結します。 連結の順序は、コマンドラインでコンパイラに渡されるファイルのリストと、3連スラッシュの参照とインポートによって決定されます。 出力ファイルの順序の詳細については、ドキュメントを参照してください。

paths[2]

型:Object

モジュール名のパス・マッピングの一覧を、baseUrlを基準にした場所に関連付けます。 詳細については、モジュール解決のドキュメントを参照してください。

--preserveConstEnums

型:boolean
デフォルト:false

生成されたコードのconst enum宣言を消さないようにします。 詳細はconst enumsのドキュメントを参照してください。

--pretty[1]

型:boolean
デフォルト:false

色とコンテキストを使用して、エラーとメッセージを装飾します。

--project
-p

型:string

指定された適切な設定ファイルでプロジェクトをコンパイルします。 引数には、適切なJSON設定ファイルのパス、またはtsconfig.jsonファイルを含むディレクトリのパスを指定します。

詳細については、tsconfig.jsonを参照してください。

--reactNamespace

型:string
デフォルト:"React"

"react"のJSXを対象とする際に、 createElementおよび__spreadに対して呼び出されるオブジェクトを指定します。

--removeComments

型:boolean
デフォルト:false

copy-rightヘッダーのコメントを除く、/*!で始まる全てのコメントを削除します。

--rootDir

型:string
デフォルト:(入力ファイルの一覧から算出される通常のルートディレクトリ)

入力ファイルのルートディレクトリを指定します。 --outDirを使用して出力ディレクトリ構造を制御する場合にのみ使用してください。

rootDirs2

型:string[]

実行時のプロジェクト構造を表す、結合されるコンテンツのルートとなるフォルダの一覧を指定します。 詳細については、モジュール解決のドキュメントを参照してください。

--skipDefaultLibCheck

型:boolean
デフォルト:false

デフォルトのライブラリの宣言ファイルの型のチェックをスキップします。

--skipLibCheck

型:boolean
デフォルト:false

全ての宣言ファイル(*.d.ts)の型チェックをスキップします。

--sourceMap

型:boolean
デフォルト:false

対応する.mapファイルを生成します。

--sourceRoot

型:string

デバッガがTypeScriptファイルを検索するべき場所(本来の場所とは別の)を指定します。 ソースの実行時に、ソースが設計時とは異なる場所に配置される場合にこのフラグを使用します。

この場所の指定は、デバッガにソースファイルの場所を指示するためにソースマップ内に埋め込まれます。

--strictNullChecks

型:boolean
デフォルト:false

厳格なnull検査モードでは、nullおよびundefinedの値は各型に割り当てることができず、 それら自身の型とanyだけが割り当て可能になります。 (1つ例外があり、undefinedvoidに割り当て可能です。)

--stripInternal[1]

型:boolean
デフォルト:false

/** @internal */のJSDocアノテーションを持つコードに対して、宣言を出力しなくなります。

--suppressExcessPropertyErrors

型:boolean
デフォルト:false

オブジェクト・リテラルへの過剰なプロパティチェックを抑制します。

--suppressImplicitAnyIndexErrors

型:boolean
デフォルト:false

インデックス・シグネチャが欠損したインデックスされたオブジェクトへの--noImplicitAnyのエラーを抑制します。 詳細については、issue #1232を参照してください。

--target
-t

型:string
デフォルト:"ES3"

対象とするECMAScriptのバージョンを指定します。

  • "ES3"(デフォルト)
  • "ES5"
  • "ES6"/"ES2015"
  • "ES2016"
  • "ES2017"
  • "ESNext"

注意: "ESNext"は最新のES提案の機能がサポートされたものを対象とします。

--traceResolution

型:boolean
デフォルト:false

モジュール解決のログメッセージを報告します。

--types

型:string[]

含める型定義の名前の一覧を指定します。 詳細については、@types、--typeRoots、--typesを参照してください。

--typeRoots

型:string[]

型定義を含むフォルダの一覧を指定します。 詳細については、@types、--typeRoots、--typesを参照してください。

--version
-h
コンパイラのバージョンを出力します。
--watch
-w
監視モードでコンパイラを実行します。 入力(input)ファイルを監視し、変更時に再コンパイルをトリガします。
  • [1] これらのオプションは試験的なものです。
  • [2] これらのオプションはtsconfig.jsonでのみ許可され、コマンドラインを通して変更することはできません。

 Back to top

© https://github.com/Microsoft/TypeScript-Handbook

このページは、ページトップのリンク先のTypeScript-Handbook内のページを翻訳した内容を基に構成されています。 下記の項目を確認し、必要に応じて公式のドキュメントをご確認ください。 もし、誤訳などの間違いを見つけましたら、 @tomofまで教えていただければ幸いです。

  • ドキュメントの情報が古い可能性があります。
  • "訳注:"などの断わりを入れた上で、日本人向けの情報やより分かり易くするための追記を行っている事があります。