IntelliJ プラットフォーム SDK プラグイン開発ガイド

ページを編集 (英語)

Gradleの使用開始

GradleはIntelliJプラットフォームプラグインを作成するための推奨ソリューションです。IntelliJ IDEA UltimateおよびCommunityエディションには、Gradleベースの開発をサポートするために必要なプラグインがバンドルされています。これらのIntelliJ IDEAプラグインはGradleプラグイン DevKitで、デフォルトで有効になっています。これらのプラグインがインストールされ有効になっていることを確認するには、プラグインの管理に関するヘルプセクションを参照してください。

新規プロジェクトウィザードを使用したGradleベースのIntelliJプラットフォームプラグインの作成

IntelliJ IDEAは新規プロジェクト・ウィザードを使用して新しいGradleベースのIntelliJプラットフォームプラグインプロジェクトの作成をサポートします。ウィザードは、いくつかのテンプレート入力に基づいて必要なすべてのプロジェクトファイルを作成します。

新しいGradleプロジェクトを作成する前に、IntelliJ IDEAで一般的なGradleプロジェクトを作成するためのチュートリアルであるIntelliJ IDEAヘルプトピック新しいGradleプロジェクトの作成をよく理解してください。このページでは、GradleベースのIntelliJプラットフォームプラグインプロジェクトを作成するためのプロセスのステップについて説明します。

新規プロジェクト・ウィザードを起動してください。それは4つの画面でGradleプロジェクト作成プロセスを通してあなたを導きます。

新規プロジェクト構成画面

最初の画面では、プロジェクトの種類が設定されています。

  • 左側の製品カテゴリペインからGradleを選択します。
  • Java 8 JDKに基づいてプロジェクトSDKを指定します。このSDKは、Gradleの実行に使用されるデフォルトのJRE、およびプラグインJavaソースのコンパイルに使用されるJDKバージョンになります。プロジェクトSDKに基づいて、IntelliJ IDEA Gradleプラグインは、IntelliJプラットフォームベースのIDEの対応するバージョンを自動的にダウンロードします。
  • 追加ライブラリおよびフレームワーク」パネルで、「 JavaおよびIntelliJプラットフォームプラグイン」を選択します。これらの設定は、このチュートリアルの残りの部分で使用されます。
  • オプション:
    • プラグインにKotlin言語のサポートを含めるには、Kotlin / JVMボックスをチェックします(下の緑色の丸で囲まれています)。このオプションは、Java言語の有無にかかわらず選択できます。
    • build.gradle ファイルをGroovyではなくKotlinビルドスクリプトとして作成するには、Kotlin DSLビルドスクリプトボックスをチェックします。(以下のマゼンタで囲まれています。)

次に 次へ をクリックします。

Select the Gradle facet in the Project Creation Wizard

プロジェクト命名画面

ウィザードの2番目の画面では、Mavenの命名(英語)の表記法を使用してグループID、成果物ID、およびプラグインのバージョンを指定します。

  • グループIDは通常Javaパッケージ名であり、プロジェクトの build.gradle ファイルのGradleプロパティの project.group 値に使用されます。この例では、「com.your.company」と入力します。
  • 成果物IDは、プロジェクトJARファイルのデフォルト名です(バージョンなし)。プロジェクトの settings.gradle ファイルのGradleプロパティの rootProject.name 値にも使用されます。この例では、「my_gradle_plugin」と入力します。
  • build.gradle ファイルのGradleプロパティの project.version 値にバージョンが使用されます。この例では、「1.0」を入力してください。

Nextをクリックして続けます。

Gradle設定画面

3番目の画面では、Gradle固有の設定を要求されます。設定 | ビルド、実行、デプロイ | ビルド・ツール | Gradleでプロジェクトを作成したら、これらの設定はすべて変更できます。デフォルト設定を選択して、「次へ」をクリックして続行します。

プロジェクト名と場所の画面

最後のウィザード画面は、プロジェクトの名前と場所を設定するためのものです。プロジェクト名アーティファクト IDであらかじめ入力されています。

詳細設定の下のProject formatの選択はやや不必要です。プロジェクトの作成およびビルド時に .idea ディレクトリまたは .ipr ファイルが生成されますが、プロジェクトのさまざまな側面を制御するのはGradleおよびIntelliJ IDEA Gradleプラグインです。

完了をクリックします。

ウィザード生成Gradle IntelliJプラットフォームプラグインのコンポーネント

my_gradle_pluginでは、新規プロジェクトウィザードは以下に示すディレクトリコンテンツを作成します。

  • デフォルトのIntelliJプラットフォーム build.gradle ファイル。内容は以下でさらに議論されます。
  • Gradleラッパーファイル、特に gradle-wrapper.properties ファイル。プラグインの構築に使用されるGradleのバージョンを指定します。必要なら、IntelliJ IDEA Gradleプラグインはこのファイルで指定されたバージョンのGradleをダウンロードします。
  • rootProject.nameの定義を含む settings.gradle ファイル。
  • デフォルトの main ソースセット(英語)META-INF ディレクトリには、プラグイン設定ファイルが含まれています。
my_gradle_plugin ├── build.gradle ├── gradle │   └── wrapper │   ├── gradle-wrapper.jar │   └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── settings.gradle └── src ├── main │   ├── java │   └── resources │   └── META-INF │   └── plugin.xml └── test ├── java └── resources

新規プロジェクトウィザードは、以下に示す my_gradle_plugin プロジェクト build.gradle ファイルを生成します。

  • ファイル内に明示的な buildscript{} はありません。IntelliJ IDEA Gradleプラグインは動的に buildscript{}を作成します。
  • Gradleへの2つのプラグインが明示的に宣言されています。
  • ウィザードプロジェクト命名画面からのグループIDproject.group 値です。
  • ウィザードプロジェクト命名画面からのバージョンproject.version 値です。
  • sourceCompatibility 行は、Java 8 JDKを使用してJavaソースをコンパイルすることを強制するために挿入されています。
  • ファイル内の唯一のコメントは、IntelliJ IDEA GradleプラグインのREADME.md(英語)へのリンクです。これは、プラグインによって定義されたDSLの参照です。
  • Setup DSL属性 intellij.version の値は、プラグインを構築するために使用されるIntelliJプラットフォームのバージョンを指定します。デフォルトは、新規プロジェクト・ウィザードを実行するために使用されたIntelliJ IDEAのバージョンです。
  • Patching DSL属性 patchPluginXml.changeNotes の値は、プレースホルダーテキストに設定されています。
plugins { id 'java' id 'org.jetbrains.intellij' version '0.4.15' } group 'com.your.company' version '1.0' sourceCompatibility = 1.8 repositories { mavenCentral() } dependencies { testCompile group: 'junit', name: 'junit', version: '4.12' } // See https://github.com/JetBrains/gradle-intellij-plugin/ intellij { version '2019.1' } patchPluginXml { changeNotes """ Add change notes here.<br> <em>most HTML tags may be used</em>""" }

プラグインGradleプロパティとプラグイン設定ファイルの要素

Gradleプロパティ rootProject.name および project.group は、一般に、それぞれの plugin.xml 要素 <name> および <id>と一致しません。IntelliJプラットフォームに関連する理由はありません。異なる機能を提供するためです。 <name> 要素は多くの場合コンテンツ・ルートに似ていますが、rootProject.nameよりも説明的です。 <id> は、すべてのプラグインに対する一意の識別子であり、通常はMaven groupIdartifactIdの連結です。デフォルトのGradle project.group プロパティは groupIdのみです。

既存のDevKitベースのIntelliJプラットフォームプラグインへのGradleサポートの追加

DevKitベースのプラグインプロジェクトをGradleベースのプラグインプロジェクトに変換するには、新規プロジェクト・ウィザードを使用して、既存のDevKitベースのプロジェクトの周囲にGradleベースのプロジェクトを作成します。

  • 必要に応じて、DevKitベースのIntelliJプラットフォームプラグインプロジェクトを含むディレクトリを完全にリカバリできることを確認してください。
  • DevKitベースのプロジェクトのすべてのアーティファクトを削除します。
    • .idea ディレクトリ
    • IMLファイル
    • out ディレクトリ
  • プロジェクトディレクトリ内の既存のソースファイルをGradle ソースセット(英語)形式で配置します。
  • 最初から新しいGradleプロジェクトを作成するのと同じように、新規プロジェクトウィザードを使用します。
  • プロジェクト命名画面で値を次のように設定します。
    • 初期ソースセット内の既存のパッケージへのGroupID。
    • ArtifactIDから既存のプラグインの名前。
    • 既存のプラグインと同じバージョンにします。
  • プロジェクト名と場所の画面で値を次のように設定します。
    • 既存のプラグインの名前にプロジェクト名。(ArtifactIDから事前に入力されている必要があります。)
    • プロジェクトの場所を既存のプラグインのディレクトリに設定します。
  • 完了をクリックして新しいGradleベースのプラグインを作成します。
  • 必要に応じてGradle ソースセットを使用したさらにモジュールを追加する

シンプルなGradleベースのIntelliJプラットフォームプラグインを実行する

Gradleプロジェクトは、IDEのGradleツールウィンドウから実行されます。

プロジェクトへのコードの追加

my_gradle_project を実行する前に、簡単な機能を提供するコードを追加できます。メニューアクションを追加するための段階的な手順については、アクションを作成するチュートリアルを参照してください。

プラグインを実行する

Gradleツールウィンドウを開き、runIde タスクを検索します。

Gradle Tool Window

runIdeタスクをダブルクリックして実行します。Gradleタスクの操作の詳細については、IntelliJ IDEAのヘルプを参照してください。

最後に、my_gradle_plugin がIDE開発インスタンスで起動すると、ツールメニューに新しいメニューが表示されます。

最終更新日: