JetBrains MPS プロジェクトへの貢献

ソースからの MPS のビルド

プロジェクト README.md(英語) ファイルの指示に従って、プロジェクトのクローンを作成してビルドしてください。

コマンドラインを使用してソースから MPS をビルドする

または、コマンドラインを使用してソースから MPS をビルドすることもできます。

始める前に、Ant がインストールされていることを確認してください。IntelliJ IDEA Community Edition をダウンロードし、その中の MPS プロジェクトを開きます。これを行うには、「プロジェクトを開く」をクリックし、Git リポジトリがあるフォルダーを選択します。その後、再構築をトリガーします。再構築が完了したら、シェルを開き、ビルドディレクトリに移動して、run.build.sh を実行します。

貢献する

これで、変更を加える準備が整いました。これを行う方法に関するいくつかのガイドラインを次に示します。

• 好きなだけ頻繁にコミットしてください。

• 提供されている自動テストスイートを実行して、コードをテストしてください。これを行うには、IntelliJ IDEA で Run -> Run... を選択します。特に、GlobalTestSuite, ModuleTestSuite, および ProjectTest 実行構成を実行することを強くお勧めします。

• 現在、公開されているコードスタイルのガイドラインはありません。疑わしい場合は、MPS のソースを確認するか、#contributors チャンネル(英語)に投稿してください。

変更をプッシュする

ローカルの変更を JetBrains に転送する方法は次のとおりです。

• git push origin my_branch_name コマンドを実行して、ブランチをプライベート GitHub リポジトリにプッシュします。

• GitHub でプルリクエストを作成します。これを行うには、ブラウザーでリポジトリを開き、プルするブランチが表示されていることを確認して、右上隅にある Pull Request ボタンをクリックします。

• リクエストを処理し、標準の GitHub 機能を通じて進行状況に関する通知を送信します。

フォークを最新の状態に保つ

コードを変更してコミットすると、MPS github リポジトリの独自のフォークに変更が加えられます。プルリクエストを使用すると、MPS 開発者に変更を認識させることができます。変更が元のリポジトリに統合される場合と統合されない場合があります。ただし、その間、元の MPS リポジトリが変更され (コードに取り組んでいる MPS チームの結果として)、フォークが同期しなくなります。

ローカルクローンとリモートフォークを元のリポジトリの変更と同期させるには、元のリポジトリからプルし、競合を解決してから、フォークにプッシュする必要があります。次の手順を実行します:

• ローカルクローンで、元の MPS github リポジトリを指すリモートを追加します。git リモート mpsrepo https://github.com/JetBrains/MPS(英語) を追加

• git pull mpsrepo master を使用して、元のリポジトリから変更をプルします。

• 上記で提案したようにブランチへのコントリビューションを作成する場合は、更新されたマスターを git merge master を使用して (ブランチで) ブランチにマージする必要があります。その際、マージの競合をローカルで解決する必要があります。

• その後、git push origin (origin は git clone によってリモートに割り当てられたデフォルト名) を使用して、マージされた変更を独自のフォークにプッシュできます。

MPS Git リポジトリへのアクセス

上で説明した GitHub プロセスは、メインの MPS リポジトリにアクセスするための推奨される方法です。ただし、git://git.jetbrains.com/mps/mps.git にある MPS リポジトリを、パッチを MPS に送信するためのベースとして使用することもできます。

IntelliJ IDEA からチェックアウトするには、次のリポジトリ URL を使用します。

git://git.jetbrains.org/mps/mps.git

コマンドラインからチェックアウトするには、次のコマンドを使用します。

git clone git://git.jetbrains.org/mps/mps.git

さらに、Git の Web アクセスを使用して MPS ソースを閲覧する(英語)を実行できます。

大きな分裂

MPS は IntelliJ IDEA と MPS 自体の両方で開発されているため、コードベースは Java ソースと MPS モデルで構成されています。IntelliJ IDEA で Java ファイルを開くたびに、ファイルに /*Generated by MPS */ コメントが含まれているかどうかを確認できます。これは、ソースが生成されたことを示しており、実際のソースは、おそらく類似した名前で MPS にあります。Mac のショートカット Cmd+O または Windows の Ctrl + N は、ファイル、クラス、ルートノードを名前で開くために使用され、確かに便利です。幸い、キーの組み合わせは IntelliJ IDEA と MPS で同じです。

構造

MPS のプロジェクトビューは、プロジェクトがどのように構成されているかについての大まかなガイドラインを提供する場合があります。

• core は、重要な言語設計機能を保持しています。

  • アスペクトは、個々の言語定義アスペクトの機能と言語を保持します。

  • スタブには、JDK、Ant、IntelliJ プラットフォーム、MPS Java ソースなどのロードされた外部ライブラリが格納されます。

• languages には、baselanguage、smodel、quotation、xml などのコア言語が含まれています。

• platform には、コンソール、vas サポート、モデルチェック、ビルド言語などの IDE 拡張機能が含まれています。

• samples は、サンプルプロジェクトをグループ化します。

• tests には、MPS のさまざまな側面のテストが含まれています。

• ワークベンチは、IntelliJ プラットフォームとの統合と多くの UI 要素の実装を提供し、実行とデバッグをサポートします。

作業をコミットする

MPS プロジェクトは、生成されたアーティファクトをソースとモデルとともに Git に保存します。コミットする前に、変更されたすべてのモデルが再生成されていることを確認してください。(generation required) ノートは消えている必要があります。そうしないと、TeamCity CI サーバーは、すべてのアーティファクトが正しく生成されていることを確認するため、失敗したビルドでコミットを拒否します。再生成する最良の方法は、モデルまたはモジュールのコンテキストメニューから Rebuild を呼び出すことです。

生産性ガイドのヒントの追加

MPS 自体またはスタンドアロン MPS ベースの IDE のいずれかについて、新しい生産性ガイドのヒントを追加する場合は、次のガイドラインに従ってください。

• ヒントを説明する HTML ファイルを作成し、それを /workbench/resources_en/source/tips に配置します。他のヒントで使用されているスタイルに従ってください。

• 新しい HTML ファイルを /workbench/resources_en/source/tips/tips.xml にリストして、「今日のヒント」ダイアログの一部にします。

• FeatureUsageTracker.getInstance().triggerFeatureUsed("my.key" ); への呼び出しを適切なアクションに追加して、機能が生産性ガイドで使用されていることを示します (my.key は、作成または再利用する生産性ヒントの識別子です)。

• /workbench/resources_en/source/messages/FeatureStatisticsBundle.properties のキーに表示名を追加する

• 生産性ガイドエントリを /workbench/resources/source/ProductivityFeaturesRegistry.xml に登録し、ID を HTML ページにマップします。