ビルド言語

Java ターゲット

Java プラグインは以下のターゲットを追加します。

• compileJava は、プロジェクト内のすべての Java モジュールをコンパイルします。

• 追加のリソース処理のための processResources 拡張ポイント。

• クラスは、プロジェクト内のすべてのコンパイルとリソース処理を行います。これは、ターゲットの compileJava、processResources に依存します。

• 単体テストを実行するためのテスト拡張ポイントターゲット。

• check は、プロジェクトの正確性のすべてのテストとチェックを行います。ターゲットテストによって異なります。

MPS モジュールとグループ

MPS プラグインはプロジェクト構造にモジュールを追加することを可能にします。スクリーンショットには、ビルドスクリプトで宣言された言語の例があります。

ビルドスクリプトで指定されているモジュールに関する情報は多数あり、そのほとんどはインスペクタツールウィンドウに表示されます。具体的には、UUID と完全修飾名、記述子ファイルへのフルパス、依存関係、ランタイム (言語の場合)、その他のメタデータなどです。これらの情報はモジュールをパッケージ化するために必要です。そのため、このモジュールに変更があった場合 (たとえば、依存関係が追加された場合) は、ビルドスクリプトも変更する必要があります。もちろん、これを簡単に行うためのツールは多数存在します。スクリプトで mps モジュールを記述および管理する一般的なプロセスは次のとおりです。

1. スクリプトにモジュールを追加します。1 つは、追加するモジュールのタイプ (ソリューション、言語、開発キット) とモジュール記述子ファイルへのパスを指定します。次に、インテンション「ファイルから必要な情報をロード」を使用して、そのファイルを読み取り、残りのモジュール仕様を自動的に入力できます。

   

2. モジュールに加えられた変更を反映しています。モデルチェッカーを使用してモデルをビルドスクリプトでチェックし、モデルがモジュールファイルと一致しているかどうかを確認できます。モデルチェッカーは、スクリプト内のすべての問題を表示し、クイックフィックスを実行ボタンを使用して修正できるようにします。モデルチェッカーの代わりに、同じ「ファイルから必要な情報をロードする」インテンションを使用して、各モジュールを個別に修正することができます。

   

ビルドスクリプトでの MPS モジュール宣言について覚えておくべきもう 1 つのことは、MPS にロードされているモジュールに依存していないということです。すべての情報はディスク上のモジュール記述子ファイルから取得されますが、モジュール自体はビルドスクリプトからは使用できない可能性があります。

ビルドスクリプトを構造化するために、MPS モジュールを mps グループに追加できます。 MPS グループは、名前付きのモジュールセットであり、外部から参照できます。たとえば、モジュールグループを 1 つのユニットとして IDEA プラグインに追加できます。

MPS モジュールの生成とコンパイルは内部でどのように機能するのか

前述のとおり、モジュールに関する多くの情報がビルドスクリプトに抽出され、そこに保存されます。そのため、モジュールの依存関係が変更されるたびに、ユーザーはスクリプトを更新する必要があります。ソリューションの場合、再エクスポートされた依存関係と再エクスポートされていない依存関係の両方がスクリプトに抽出されます。言語の場合、依存関係に加えて、ランタイムソリューションと拡張言語も抽出されます。

ビルドスクリプトを使用したモジュールの「ビルド」は、このモジュールの生成とモジュールソースのコンパイルの 2 つの部分で構成されます。生成は、ソースコードをバージョン管理システムに保存し、モデルとの同期を保つプロジェクトのオプションのステップです。生成では、ビルドスクリプト内のすべてのモジュールを生成する 1 つのターゲットが作成されます。モジュールは「チャンク」（一緒に生成できるモジュールのグループ）に分割され、生成タスクはチャンクを 1 つずつ生成します。例: 言語とその言語で記述されたソリューションは一緒に生成できないため、別々のチャンクに分割されます。生成タスクには、生成するチャンクのリストとは別に、ロードするアイデアプラグインのリストと、生成に必要な他のビルドスクリプトのモジュールのリストが提供されます。このプラグインとモジュールのリストは依存関係から計算されるため、生成を成功させるにはそれらが正確であることが非常に重要です。これは、MPS からモジュールを生成する場合とビルドスクリプトからモジュールを生成する場合の大きな違いです。一方、MPS からモジュールを生成する場合、ジェネレーターにはプロジェクト内のすべてのモジュールがロードされ、使用可能になります。ビルドスクリプトからモジュールを生成する場合、ジェネレーターにはモジュールの依存関係で明示的に指定されたもののみが含まれます。ビルドスクリプトは、モジュールの依存関係が正しいかどうかを検証する手段として使用できます。

モジュールのコンパイルは少し異なります。MPS モジュールごとに java モジュールが生成されるため、最終的に各 MPS モジュールは通常の Ant javac タスク（または Java オプションで選択されている場合は同様の他のタスク）によってコンパイルされます。

そのため、生成してコンパイルするために、モジュールの依存関係が収集され、生成されたビルド xml ファイルに埋め込まれます。使用されている言語と devkits はモジュール記述子ファイルからビルドスクリプトを生成する間に集められます。その他の情報はビルドスクリプトノード内に格納されています。下の図では、「myproject」というプロジェクトのモジュール構造が示されています。このプロジェクトは、「mylibrary」というサードパーティの MPS ライブラリを使用しています。

矢印はモジュール間の依存システムを示しています。紫色の矢印はビルドスクリプトに抽出される依存関係を示し、青い矢印はどの依存関係が抽出されないかを示します。私のプロジェクトからモジュールをコンパイルして生成するために、mylibrary の中の「青い矢印」の知識が必要とされないことは容易に観察されることができます。つまり、私のライブラリの実際のモジュールファイルは、myproject ビルドスクリプトの生成中にも存在しないかもしれません。ジェネレーターが必要とするすべての情報はビルドスクリプトに含まれています。これは非常に便利です。ビルドの生成中にライブラリ全体をダウンロードしてその完全な場所を指定する必要がないため、生成プロセスではプロジェクトの依存関係からすべてのモジュール記述子をロードしないため時間とメモリを節約できます。

ソースとテスト

MPS ソリューションにテストモデル、すなわちステレオタイプ "@tests" のモデルが含まれている場合、それらはデフォルトではコンパイルされないフォルダー "tests_gen" に生成されます。テストをコンパイルするには、ソリューションにテストモデルがあることをビルドスクリプトで指定する必要があります。これはインスペクタで手動で行われます。解決策に利用可能な 3 つのオプションがあります: "with sources"（デフォルト）、"with testing" そして "with sources and tests"。

MPS の設定

mps 設定を使用すると、ビルドスクリプトの MPS 固有のパラメーターを変更できます。「追加の側面」セクションのビルドスクリプトには、mps 設定のインスタンスが 1 つしか存在できません。変更できるパラメーター:

• bootstrap – このフラグを「true」に設定すると、スクリプト内のモジュール間にブートストラップの依存関係が存在することを示します。通常、フラグは false に設定されます。詳細については、ブートストラップ依存関係の問題の除去を参照してください。

• テスト生成 – true に設定されている場合、ビルドスクリプトはモジュールの生成と、生成されたファイルとディスク上のファイルの違いをテストします。除外セクションでファイルを diff から除外できます。

• generation max heap size in mb – 世代および世代テストの最大ヒープサイズ。

テストモジュール生成

生成されたソースファイルをバージョン管理下に置いているプロジェクトでは、ビルドスクリプトを使用して、これらの生成されたファイルが最新であることを確認できます。mps 設定でテスト生成を true に設定すると、生成されたビルドスクリプトのテストターゲットに gentest タスクの呼び出しが表示されます。generate タスクと同様に、gentest は スクリプト内のモジュール、他のビルドスクリプトからの依存関係、および必要な idea プラグインをロードします。gentest タスクは、各モジュールに対して「%MODULE_NAME%.Test.Generating」と「%MODULE_NAME%.Test.Diffing」の 2 つのテストを呼び出します。Test.Generating は、モジュールの生成中にエラーが発生した場合に失敗し、Test.Diffing は、生成されたファイルがディスク上のファイル (バージョン管理からチェックアウトされたもの) と異なる場合に失敗します。テスト結果と統計は、TeamCity ビルドサーバーでサポートされている XML ファイルにフォーマットされます。

IDEA プラグイン

アイデアプラグインの構築では、MPS モジュールを含む IntelliJ IDEA または MPS のプラグインを定義します。スクリーンショットでは、そのようなプラグインの例を見ることができます。

プラグイン宣言の最初のセクションには、プラグインの名前と説明、フォルダー名、プラグインベンダー、その他のメタデータなど、プラグインを説明するさまざまな情報が含まれます。ここで重要な文字列は、キーワード idea plugin の後に続く plugin id です。これは、他のすべてのプラグインの中で、そのプラグインを一意に識別するものです。plugin.xml ファイルの構築方法には 3 つのオプションがあります。ビルドスクリプトの idea plugin セクションに含まれる情報のみを使用するか、提供された plugin.xml ファイルの内容で情報を補強するか、カスタム plugin.xml ファイルのみを使用するかのいずれかです。

アイデアプラグインの中の次のセクションは実際のプラグインコンテンツです - プラグインに含まれるモジュールまたはモジュールグループのセットです。

最後のセクションは他のプラグインへのプラグインの依存関係について書かれています。ルールは、"pluginB" にある "moduleB" に依存する "pluginA" にある "moduleA" がある場合、"pluginB" に対する "pluginA" の依存関係があるはずです。そのような問題を識別して報告する型システムチェックが存在します。

プラグインのレイアウトは最後に指定されています。プラグインをパッケージ化する方法は 2 つ考えられます。

• 自動パッケージ化 - 提供されているすべての言語とソリューションは、プラグインのルートディレクトリの「languages」フォルダーに配置されます。

• 手動パッケージ - 開発者はプラグイン全体のレイアウトを手動で定義する必要があります

MPS のターゲット

MPS プラグインは以下のターゲットを提供します。

• generate- プロジェクト構造に含まれる mps モジュールを生成します。

• cleanSources- 生成されたコードをクリーンアップします（ブートストラップ依存関係のないモジュールのみ）。記事ブートストラップ依存関係の問題の除去で、ブートストラップの依存関係の詳細を参照してください。

• describe-mps-tasks - generate や copyModels などの mps タスクを宣言するユーティリティターゲット。

• makeDependents- このスクリプトの依存関係（存在する場合）を一時的に閉じるための生成ターゲットを呼び出してから、アセンブルを呼び出してまとめます。各スクリプトは、すべての依存関係が構築された後にのみ実行されることが保証されています。

テストモジュール構成

テストを含むソリューション / モジュールグループは、テストモジュール構成にグループ化されます。これは、同じ環境で一緒に実行されるテストを含むソリューションのグループです。必要なすべての依存関係 (つまり、モジュールとプラグイン) がその環境にロードされます。スクリーンショットでは、execution という名前のテストモジュール構成が表示されています。この構成には、jetbrains.mps.execution.impl.tests ソリューションと debugger-tests モジュールグループが含まれています。

テストモジュール構成にソリューションを含めるための前提条件があります。解決策は、テストを含むものとして指定する必要があります（インスペクタで「テスト付き」または「ソースとテスト付き」を選択することによって）。モジュールグループには、テストを含むモジュールを少なくとも 1 つ含める必要があります。

テスト結果と統計は、xml ファイル（TeamCity でサポートされています）にフォーマットされています。

テストモジュールの実行構成構築は、MPS ant テスト実行中にロードされるべきである追加のアイデアプラグインを指定する可能性をサポートします。MPS ant テストの実行に必要なプラグインは、自動的に計算できないことがあります。テストが利用可能な特定のプラグインを必要とし、その情報が MPS ビルド言語エンジンによってテストを含むモジュールから推論できないというシナリオがあります。そのような場合、必要なプラグインは手動で指定できます。

他にもいくつかのオプションが利用可能です。

• 失敗の停止 - 最初のテストが失敗したときにテストの実行を停止します。

• compress args - JAVA_TOOL_OPTIONS 環境変数を使用して Windows 上のコマンドラインのサイズ制限を回避するには、true に設定します。

• jvm 引数 - 追加の jvm 引数を指定します。