Kotlinコンパイラオプション

Kotlinの各リリースには、サポートされているプラットフォーム向けのJVM、JavaScript、およびネイティブバイナリといった、サポートされているターゲット向けコンパイラが含まれています。

これらのコンパイラは、以下によって使用されます:

IDE: Kotlinプロジェクトで__Compile__ または Run ボタンをクリックした際
Gradle: コンソールまたはIDEで gradle build を呼び出した際
Maven: コンソールまたはIDEで mvn compile または mvn test-compile を呼び出した際

Kotlinコンパイラは、コマンドラインコンパイラの使用チュートリアルで説明されているように、コマンドラインから手動で実行することもできます。

コンパイラオプション

Kotlinコンパイラには、コンパイルプロセスを調整するための多数のオプションがあります。異なるターゲットのコンパイラオプションは、それぞれの説明とともにこのページにリストされています。

コンパイラオプションとその値（コンパイラ引数）を設定する方法はいくつかあります:

IntelliJ IDEAの場合: 設定/Preferences | ビルド、実行、デプロイ | コンパイラ | Kotlinコンパイラ の「Additional command line parameters」テキストボックスにコンパイラ引数を入力します。
Gradleを使用している場合: Kotlinコンパイルタスクの compilerOptions プロパティでコンパイラ引数を指定します。詳細は、Gradleコンパイラオプションを参照してください。
Mavenを使用している場合: Mavenプラグインノードの <configuration> 要素にコンパイラ引数を指定します。詳細は、Mavenを参照してください。
コマンドラインコンパイラを実行する場合: ユーティリティ呼び出しに直接コンパイラ引数を追加するか、argfileに記述します。

例:

bash

$ kotlinc hello.kt -include-runtime -d hello.jar

NOTE

Windowsでは、区切り文字（空白、=、;、,）を含むコンパイラ引数を渡す場合、これらの引数を二重引用符（"）で囲みます。


$ kotlinc.bat hello.kt -include-runtime -d "My Folder\hello.jar"

共通オプション

以下のオプションは、すべてのKotlinコンパイラに共通です。

-version

コンパイラのバージョンを表示します。

-nowarn

コンパイル中にコンパイラが警告を表示するのを抑制します。

-Werror

すべての警告をコンパイルエラーにします。

-Wextra

有効な場合に警告を出力する追加の宣言、式、および型のコンパイラチェックを有効にします。

-verbose

コンパイルプロセスの詳細を含む詳細なログ出力を有効にします。

-script

Kotlinスクリプトファイルを評価します。このオプションを指定して呼び出された場合、コンパイラは、与えられた引数の中から最初のKotlinスクリプト（*.kts）ファイルを実行します。

-help (-h)

使用法情報を表示して終了します。標準オプションのみが表示されます。高度なオプションを表示するには、-Xを使用します。

-X

高度なオプションに関する情報を表示して終了します。これらのオプションは現在不安定です。その名前と動作は予告なく変更される場合があります。

-kotlin-home path

ランタイムライブラリの検出に使用されるKotlinコンパイラへのカスタムパスを指定します。

-P plugin:pluginId:optionName=value

Kotlinコンパイラプラグインにオプションを渡します。コアプラグインとそのオプションは、ドキュメントのCore compiler pluginsセクションにリストされています。

-language-version version

指定されたKotlinバージョンとのソース互換性を提供します。

-api-version version

指定されたKotlinバンドルライブラリの宣言のみを使用できるようにします。

-progressive

コンパイラのプログレッシブモードを有効にします。

プログレッシブモードでは、不安定なコードに対する非推奨化とバグ修正が、段階的な移行サイクルを経る代わりに、すぐに有効になります。プログレッシブモードで書かれたコードは後方互換性がありますが、非プログレッシブモードで書かれたコードはプログレッシブモードでコンパイルエラーを引き起こす可能性があります。

@argfile

指定されたファイルからコンパイラオプションを読み取ります。このようなファイルには、値を持つコンパイラオプションとソースファイルへのパスを含めることができます。オプションとパスは空白で区切る必要があります。例:

-include-runtime -d hello.jar hello.kt

空白を含む値を渡すには、それらをシングル（'）またはダブル（"）引用符で囲みます。値に引用符が含まれている場合は、バックスラッシュ（\）でエスケープします。

-include-runtime -d 'My folder'

例えば、コンパイラオプションとソースファイルを分けるために、複数の引数ファイルを渡すこともできます。

bash

$ kotlinc @compiler.options @classes

ファイルが現在のディレクトリとは異なる場所に存在する場合、相対パスを使用します。

bash

$ kotlinc @options/compiler.options hello.kt

-opt-in annotation

指定された完全修飾名を持つ要件アノテーション付きで、opt-inが必要なAPIの使用を有効にします。

-Xsuppress-warning

特定の警告をプロジェクト全体でグローバルに抑制します。例:

bash

kotlinc -Xsuppress-warning=NOTHING_TO_INLINE -Xsuppress-warning=NO_TAIL_CALLS_FOUND main.kt

Kotlin/JVM コンパイラオプション

JS用Kotlinコンパイラは、KotlinソースファイルをJavaクラスファイルにコンパイルします。 KotlinからJVMへのコンパイル用コマンドラインツールは kotlinc と kotlinc-jvm です。これらはKotlinスクリプトファイルの実行にも使用できます。

共通オプションに加えて、Kotlin/JVMコンパイラは以下のオプションを持っています。

-classpath path (-cp path)

指定されたパス内でクラスファイルを検索します。クラスパスの要素はシステムパスセパレーター（Windowsでは**;、macOS/Linuxでは😗*）で区切ります。クラスパスには、ファイルパス、ディレクトリパス、ZIPファイル、またはJARファイルを含めることができます。

-d path

生成されたクラスファイルを指定された場所に配置します。場所はディレクトリ、ZIPファイル、またはJARファイルにできます。

-include-runtime

Kotlinランタイムを結果のJARファイルに含めます。結果のアーカイブをあらゆるJava対応環境で実行可能にします。

-jdk-home path

デフォルトの JAVA_HOME と異なる場合、クラスパスに含めるカスタムJDKホームディレクトリを使用します。

-Xjdk-release=version

生成されるJVMバイトコードのターゲットバージョンを指定します。クラスパス内のJDKのAPIを指定されたJavaバージョンに制限します。 -jvm-target versionを自動的に設定します。指定可能な値は 1.8、9、10、...、21 です。

NOTE

このオプションは、各JDKディストリビューションで有効であることは保証されていません。

-jvm-target version

生成されるJVMバイトコードのターゲットバージョンを指定します。指定可能な値は 1.8、9、10、...、21 です。デフォルト値は1.8です。

-java-parameters

メソッドパラメータに関するJava 1.8リフレクションのメタデータを生成します。

-module-name name (JVM)

生成される.kotlin_moduleファイルにカスタム名を指定します。

-no-jdk

Javaランタイムをクラスパスに自動的に含めません。

-no-reflect

Kotlinリフレクション（kotlin-reflect.jar）をクラスパスに自動的に含めません。

-no-stdlib (JVM)

Kotlin/JVM stdlib（kotlin-stdlib.jar）とKotlinリフレクション（kotlin-reflect.jar）をクラスパスに自動的に含めません。

-script-templates classnames[,]

スクリプト定義テンプレートクラス。完全修飾クラス名を使用し、コンマ（,）で区切ります。

Kotlin/JS コンパイラオプション

JS用Kotlinコンパイラは、KotlinソースファイルをJavaScriptコードにコンパイルします。 KotlinからJSへのコンパイル用コマンドラインツールは kotlinc-js です。

共通オプションに加えて、Kotlin/JSコンパイラは以下のオプションを持っています。

-target

指定されたECMAバージョンのJSファイルを生成します。

-libraries path

.meta.jsおよび.kjsmファイルを持つKotlinライブラリへのパスで、システムパスセパレーターで区切られます。

-main {call|noCall}

実行時にmain関数を呼び出すかどうかを定義します。

-meta-info

メタデータを含む.meta.jsおよび.kjsmファイルを生成します。JSライブラリを作成する際にこのオプションを使用します。

-module-kind

コンパイラによって生成されるJSモジュールの種類:

umd - Universal Module Definitionモジュール
commonjs - CommonJSモジュール
amd - Asynchronous Module Definitionモジュール
plain - プレーンJSモジュール

JSモジュールのさまざまな種類とそれらの違いについて詳しくは、この記事を参照してください。

-no-stdlib (JS)

デフォルトのKotlin/JS stdlibをコンパイル依存関係に自動的に含めません。

-output filepath

コンパイル結果の出力先ファイルを設定します。値は、その名前を含む.jsファイルへのパスである必要があります。

-output-postfix filepath

指定されたファイルの内容を出力ファイルの末尾に追加します。

-output-prefix filepath

指定されたファイルの内容を出力ファイルの先頭に追加します。

-source-map

ソースマップを生成します。

-source-map-base-dirs path

指定されたパスをベースディレクトリとして使用します。ベースディレクトリは、ソースマップ内の相対パスを計算するために使用されます。

-source-map-embed-sources {always|never|inlining}

ソースファイルをソースマップに埋め込みます。

-source-map-names-policy {simple-names|fully-qualified-names|no}

Kotlinコードで宣言した変数名と関数名をソースマップに追加します。

設定	説明	出力例
`simple-names`	変数名とシンプルな関数名が追加されます。（デフォルト）	`main`
`fully-qualified-names`	変数名と完全修飾関数名が追加されます。	`com.example.kjs.playground.main`
`no`	変数名も関数名も追加されません。	N/A

-source-map-prefix

ソースマップ内のパスに指定されたプレフィックスを追加します。

Kotlin/Native コンパイラオプション

Kotlin/Nativeコンパイラは、Kotlinソースファイルをサポートされているプラットフォーム向けのネイティブバイナリにコンパイルします。 Kotlin/Nativeコンパイル用のコマンドラインツールは kotlinc-native です。

共通オプションに加えて、Kotlin/Nativeコンパイラは以下のオプションを持っています。

-enable-assertions (-ea)

生成されたコードでランタイムアサーションを有効にします。

-g

デバッグ情報の出力を有効にします。このオプションは最適化レベルを低下させ、-optオプションと組み合わせて使用しないでください。

-generate-test-runner (-tr)

プロジェクトから単体テストを実行するためのアプリケーションを生成します。

-generate-no-exit-test-runner (-trn)

明示的なプロセス終了なしで単体テストを実行するためのアプリケーションを生成します。

-include-binary path (-ib path)

生成されたklibファイル内に外部バイナリをパックします。

-library path (-l path)

ライブラリとリンクします。Kotlin/Nativeプロジェクトでのライブラリの使用について学ぶには、Kotlin/Nativeライブラリを参照してください。

-library-version version (-lv version)

ライブラリバージョンを設定します。

-list-targets

利用可能なハードウェアターゲットを一覧表示します。

-manifest path

マニフェスト追記ファイルを提供します。

-module-name name (Native)

コンパイルモジュールの名前を指定します。このオプションは、Objective-Cにエクスポートされる宣言の名前プレフィックスを指定するためにも使用できます: KotlinフレームワークのObjective-Cプレフィックス/名前をカスタム指定するにはどうすればよいですか？

-native-library path (-nl path)

ネイティブビットコードライブラリを含めます。

-no-default-libs

ユーザーコードのリンクを、コンパイラに同梱されているプリビルドのプラットフォームライブラリと無効にします。

-nomain

mainエントリーポイントが外部ライブラリによって提供されると仮定します。

-nopack

ライブラリをklibファイルにパックしません。

-linker-option

バイナリビルド中にリンカに引数を渡します。これは、ネイティブライブラリへのリンクに使用できます。

-linker-options args

バイナリビルド中にリンカに複数の引数を渡します。引数は空白で区切ります。

-nostdlib

stdlibとリンクしません。

-opt

コンパイル最適化を有効にし、より良いランタイムパフォーマンスを持つバイナリを生成します。最適化レベルを低下させる-gオプションと組み合わせて使用することはお勧めしません。

-output name (-o name)

出力ファイルの名前を設定します。

-entry name (-e name)

修飾されたエントリーポイント名を指定します。

-produce output (-p output)

出力ファイルの種類を指定します:

program
static
dynamic
framework
library
bitcode

-repo path (-r path)

ライブラリ検索パス。詳細については、ライブラリ検索シーケンスを参照してください。

-target target

ハードウェアターゲットを設定します。利用可能なターゲットのリストを確認するには、-list-targetsオプションを使用します。

Spring Boot を使用して RESTful Web サービスとデータベースを作成する

Kotlinコンパイラオプション ​

コンパイラオプション ​

共通オプション ​

-version ​

-nowarn ​

-Werror ​

-Wextra ​

-verbose ​

-script ​

-help (-h) ​

-X ​

-kotlin-home path ​

-P plugin:pluginId:optionName=value ​

-language-version version ​

-api-version version ​

-progressive ​

@argfile ​

-opt-in annotation ​

-Xsuppress-warning ​

Kotlin/JVM コンパイラオプション ​

-classpath path (-cp path) ​

-d path ​

-include-runtime ​

-jdk-home path ​

-Xjdk-release=version ​

-jvm-target version ​

-java-parameters ​

-module-name name (JVM) ​

-no-jdk ​

-no-reflect ​

-no-stdlib (JVM) ​

-script-templates classnames[,] ​

Kotlin/JS コンパイラオプション ​

-target ​

-libraries path ​

-main {call|noCall} ​

-meta-info ​

-module-kind ​

-no-stdlib (JS) ​

-output filepath ​

-output-postfix filepath ​

-output-prefix filepath ​

-source-map ​

-source-map-base-dirs path ​

-source-map-embed-sources {always|never|inlining} ​

-source-map-names-policy {simple-names|fully-qualified-names|no} ​

-source-map-prefix ​

Kotlin/Native コンパイラオプション ​

-enable-assertions (-ea) ​

-g ​

-generate-test-runner (-tr) ​

-generate-no-exit-test-runner (-trn) ​

-include-binary path (-ib path) ​

-library path (-l path) ​

-library-version version (-lv version) ​

-list-targets ​

-manifest path ​

-module-name name (Native) ​

-native-library path (-nl path) ​

-no-default-libs ​

-nomain ​

-nopack ​

-linker-option ​

-linker-options args ​

-nostdlib ​

-opt ​

-output name (-o name) ​

-entry name (-e name) ​

-produce output (-p output) ​

-repo path (-r path) ​

-target target ​

Kotlinコンパイラオプション

コンパイラオプション

共通オプション

-version

-nowarn

-Werror

-Wextra

-verbose

-script

-help (-h)

-X

-kotlin-home path

-P plugin:pluginId:optionName=value

-language-version version

-api-version version

-progressive

@argfile

-opt-in annotation

-Xsuppress-warning

Kotlin/JVM コンパイラオプション

-classpath path (-cp path)

-d path

-include-runtime

-jdk-home path

-Xjdk-release=version

-jvm-target version

-java-parameters

-module-name name (JVM)

-no-jdk

-no-reflect

-no-stdlib (JVM)

-script-templates classnames[,]

Kotlin/JS コンパイラオプション

-target

-libraries path

-main {call|noCall}

-meta-info

-module-kind

-no-stdlib (JS)

-output filepath

-output-postfix filepath

-output-prefix filepath

-source-map

-source-map-base-dirs path

-source-map-embed-sources {always|never|inlining}

-source-map-names-policy {simple-names|fully-qualified-names|no}

-source-map-prefix

Kotlin/Native コンパイラオプション

-enable-assertions (-ea)

-g

-generate-test-runner (-tr)

-generate-no-exit-test-runner (-trn)

-include-binary path (-ib path)

-library path (-l path)

-library-version version (-lv version)

-list-targets

-manifest path

-module-name name (Native)

-native-library path (-nl path)

-no-default-libs

-nomain

-nopack

-linker-option

-linker-options args

-nostdlib

-opt

-output name (-o name)

-entry name (-e name)

-produce output (-p output)

-repo path (-r path)

-target target