# CLion 用のプラグインを開発する

> For the complete documentation index, see [llms.txt](https://www.jetbrains.com/ja-jp/help/clion/llms.txt).

> **TL;DR**
> 言語  ：Java または Java ベース（ [プラグイン開発者のための Kotlin](https://plugins.jetbrains.com/docs/intellij/using-kotlin.html) を参照）
>
>
>
> IDE  ：IntelliJ IDEA Community / Ultimate
>
>
>
> ワークフロー  ：Gradle ベース ― 新しいプラグインには推奨、DevKit ― 既存プラグインにはサポート
>
>
>
> 利用可能な API  ：IntelliJ Platform API

CLion の特定の機能性を欠くとき、独自のプラグインを書くことを考えるかもしれません。 この記事は、IntelliJ プラットフォームプラグイン開発の基本を理解し、CLion プラグインを実装する最初のステップを案内することを目的としています。

CLion プラグインはすべて [IntelliJ Platform](https://www.jetbrains.com/ja-jp/opensource/idea/) の拡張機能であり、基本的に個別の Java プロジェクトです。 IntelliJ プラグイン開発には、次の 2 つのワークフローがサポートされています。推奨される方法は [gradle-intellij-plugin](https://github.com/JetBrains/gradle-intellij-plugin) と [Gradle](gradle-support.html) をビルドシステムとして使用する方法（推奨）、もう一つは [DevKit](https://plugins.jetbrains.com/docs/intellij/developing-themes.html) と IntelliJ IDEA 独自のビルドシステムを利用する方法です。

> **Tip:**
> 詳細については、プラットフォーム SDK ドキュメントの [プラグイン開発クイックスタートガイド(英語)](https://plugins.jetbrains.com/docs/intellij/plugins-quick-start.html)を参照してください。

プラグイン開発用の IDE として、IntelliJ IDEA [Community または Ultimate](https://www.jetbrains.com/ja-jp/idea/features/editions_comparison_matrix.html) エディションを使用してください。

IntelliJ IDEA 自体とは別に、ターゲット CLion ディストリビューションが必要になります。 Gradle ベースのアプローチでは、ビルドスクリプトによって自動的にダウンロードできます。 DevKit を使用する場合は、必ず CLion を手動でインストールしてください。

## プラットフォームオープン API

CLion は、安定性と詳細な説明が保証された独自のパブリック API を提供していませんが、 [プラットフォームオープン API(英語)](https://plugins.jetbrains.com/docs/intellij/explore-api.html) のすべての機能を使用できます。 Platform API を探索する効果的な方法は、公式 [リポジトリ(英語)](https://github.com/jetbrains/intellij-community)から IntelliJ IDEA CommunityEdition のソースを取得してインスペクションすることです。

IntelliJ プラットフォームの API はリリース間で変わる可能性があるため、プラグインの機能に影響します。 そのような変更は [IntelliJ プラットフォームとプラグインの非互換な変更(英語)](https://plugins.jetbrains.com/docs/intellij/api-changes-list.html)にリストされています。 CLion の内部 SDK は予告なく変更されることがあります。

CLion プラグインの API 利用についてサポートが必要な場合は、 [コミュニティフォーラム](https://intellij-support.jetbrains.com/hc/en-us/community/topics/200366979-IntelliJ-IDEA-Open-API-and-Plugin-Development)でお気軽にご質問ください。

### 拡張機能

IntelliJ プラットフォームは、プラグインが新しい機能を追加したり、既存の機能をカスタマイズしたりするための [拡張機能と拡張ポイント(英語)](https://plugins.jetbrains.com/docs/intellij/plugin-extensions.html)を提供します。 プラグインは、  `plugin.xml`  ファイルに 1 つまたは複数の拡張  `<extenstions>`  または拡張ポイント  `<extensionPoints>`  を実装することを宣言する必要があります。 利用可能な拡張機能および拡張ポイントの一覧を取得するには、Community Edition ソースの [この](https://github.com/JetBrains/intellij-community/tree/master/platform/platform-resources/src/META-INF)ディレクトリにある  *Extention/*ExtentionPoints  ファイルを参照してください。

一般的な拡張ポイントは次のとおりです。

* [アクション (英語)](https://plugins.jetbrains.com/docs/intellij/action-system.html)- メニューおよびツールバー項目。

* [コードインスペクション (英語)](https://plugins.jetbrains.com/docs/intellij/code-inspections.html) - 静的コード分析

* [インテンション -(英語)](https://plugins.jetbrains.com/docs/intellij/code-intentions.html) エディターで使用可能なコンテキスト固有のアクション。

* [コード補完](https://plugins.jetbrains.com/docs/intellij/code-completion.html)。

### プラグイン依存関係

プラグインは他のプラグインのクラスに依存している可能性があります。 この場合、プラグインはバンドル、サードパーティ、独自のプラグインのいずれかになります。 依存関係の表現の詳細については、 [プラグイン依存関係(英語)](https://plugins.jetbrains.com/docs/intellij/plugin-dependencies.html)を参照してください。

プラグインは、どの製品 (IntelliJ ベースのすべての IDE、CLion のみ、または一部のサブセット) と互換性があるかを指定する必要があります。 これを行うには、  `plugin.xml`  で  `<depends>`  タグを使用してモジュールの依存関係を宣言します ( [IntelliJ 製品とのプラグイン互換性(英語)](https://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/plugin_compatibility.html)を参照)。

一部のモジュールはすべての IntelliJ ベースの製品で使用できますが、次のモジュールは特に CLion で使用できます。

* `com.intellij.modules.cidr.lang` - C/C++ 言語サポート (このモジュールは [Android Studio](https://developer.android.com/studio) でも使用可能)。

* `com.intellij.modules.cidr.debugger` - ネイティブデバッガーのサポート (Android Studio でも)

* `com.intellij.modules.clion` - コア CLion 機能。

## Plugin.xml ファイル

`plugin.xml`  ファイルは、プラグインメタデータ（名前、説明、作成者、変更ログ、実装された機能のリスト）を含む [主要なプラグイン記述子(英語)](https://plugins.jetbrains.com/docs/intellij/plugin-configuration-file.html)です。

name、id、description  および  vendor  の値は、プラグインデータベースにプラグインを正しく登録するために必要です。 上記の通り、  depends  パラメーターはすべて、プラグインが依存するモジュールの ID です。  depends  パラメーターの一覧によって、対応する製品が暗黙的に定義されます。

> **Tip:**
> `plugin.xml`  ファイルの例は [IntelliJ SDK ドキュメントコードサンプル(英語)](https://github.com/JetBrains/intellij-sdk-code-samples)リポジトリにあります。

## CLion プラグイン入門

> **Tip:**
> いくつかの「CLion 専用」プラグインのソースを見てください: [コンパイラーエクスプローラー(英語)](https://github.com/ogrebenyuk/compilerexplorer)、 [Conan プラグイン(英語)](https://github.com/conan-io/conan-clion-plugin)、 [CMake クイックドキュメント(英語)](https://github.com/EddieRingle/clion-cmakedocs)。

さらに、Gradle ベースのアプローチを、すべての新しいプラグインプロジェクトに推奨されるアプローチとして取り上げます。 DevKit ワークフローは、既存のプラグインでも引き続きサポートされていますが、 [DevKIt を使う(英語)](https://plugins.jetbrains.com/docs/intellij/developing-themes.html)で説明されています。

まず、IntelliJ IDEA Community または Ultimate を [インストール](https://www.jetbrains.com/ja-jp/help/idea/install-and-set-up-product.html)します。 開始する前に、2 つのバンドルされたプラグイン   Gradle   と   DevKit   の両方が IntelliJ IDEA インスタンスで有効になっていることを確認してください（  `設定 | プラグイン | インストール済み`  に移動し、名前でプラグインを検索してください）。

Procedure: Gradle ベースのワークフロー

IDE メインメニューに   挨拶   を追加し、CLion 用にカスタマイズするプラグインの例を見てみましょう。

1. 追加のライブラリおよびフレームワーク   のリストで   IntelliJ Platform プラグイン​.   を選択して、新しい   Gradle   プロジェクトを作成します。

![clion プラグイン用の新しい gradle プロジェクト](https://resources.jetbrains.com/help/img/idea/2026.3/cl_plugindev_newprj.png)

2. [新しい Gradle プロジェクト](https://www.jetbrains.com/ja-jp/help/idea/gradle.html#project_create_gradle)の作成手順を進めてください。   デフォルトの gradle ラッパーを使用する   オプションを選択することを推奨します。その方法で、IntelliJ IDEA が Gradle タスクの実行に必要なすべてを自動的に設定します：

![clion プラグイン用 gradle ラッパー](https://resources.jetbrains.com/help/img/idea/2026.3/cl_plugindev_gradlewrapper.png)

3. テンプレートプラグインプロジェクトの準備ができたら、  `表示 | ツールウィンドウ | Gradle`  から   Gradle   ツールウィンドウを呼び出し、    runIde    タスクに注目してください。 このタスクは、プラグインのターゲット IDE を起動します（デフォルトでは、IntelliJ IDEA に構成されています）。

![テンプレートプラグインプロジェクト](https://resources.jetbrains.com/help/img/idea/2026.3/cl_plugindev_template.png)

gradle-intellij-plugin   によって提供されるタスクの完全な [リスト(英語)](https://github.com/JetBrains/gradle-intellij-plugin/blob/master/README.md#tasks)を参照してください。

4. それでは、デフォルトのプロジェクトを変更しましょう。

* HelloAction という新しい Java クラスを追加します。 ```JAVA import com.intellij.openapi.actionSystem.*; import com.intellij.openapi.project.Project; import com.intellij.openapi.ui.Messages; public class HelloAction extends AnAction { public HelloAction() { super("Hello"); } public void actionPerformed(AnActionEvent event) { Project project = event.getProject(); Messages.showMessageDialog(project, "Hello world!", "Greeting", Messages.getInformationIcon()); } } ```

* 次のダミーコードを `plugin.xml` に入れます。 ```XML <idea-plugin> <id>org.helloplugin</id> <name>Hello Action Project</name> <version>0.0.1</version> <vendor email="dummy" url="dummy">dummy</vendor> <depends>com.intellij.modules.lang</depends> <extensions defaultExtensionNs="com.intellij"> </extensions> <actions> <group id="MyPlugin.SampleMenu" text="Greeting" description="Greeting menu"> <add-to-group group-id="MainMenu" anchor="last"/> <action id="Myplugin.Textboxes" class="HelloAction" text="Hello" description="Says hello"/> </group> </actions> </idea-plugin> ```

* `build.gradle` スクリプトの `intellij` エントリを変更します (詳細については、 [DSL の設定(英語)](https://github.com/JetBrains/gradle-intellij-plugin/blob/master/README.md#setup-dsl)を参照してください)。 ```CONSOLE intellij { version 'LATEST-EAP-SNAPSHOT' type 'CL' } ``` CLion は、2019.2 EAP と共に Maven 互換の [アーティファクトリポジトリ(英語)](https://plugins.jetbrains.com/docs/intellij/intellij-artifacts.html)に公開されました。 現在、 `LATEST-EAP-SNAPSHOT` または `191-EAP-SNAPSHOT` のいずれかをバージョン指定子として使用できます。

5. これで   runIde   タスクを実行でき、CLion メインメニューの   挨拶   を見ることができます。

![プラグインとしての新しいメニュー項目](https://resources.jetbrains.com/help/img/idea/2026.3/cl_plugindev_sampleresult.png)

## さらなるステップ

上記の例は非常に基本的なものであり、CLion の詳細がなく、一般的な IntelliJ 機能のみを使用しています。 さらに詳しく知りたい場合は、SDK ドキュメントの [プラグイン構造](https://plugins.jetbrains.com/docs/intellij/plugin-structure.html) セクションや [CLion プラグイン開発](https://plugins.jetbrains.com/docs/intellij/clion.html)、 [IntelliJ SDK ドキュメント FAQ](https://github.com/halirutan/intellij-sdk-docs/wiki/FAQ)、そして [コミュニティフォーラム](https://intellij-support.jetbrains.com/hc/en-us/community/topics/200366979-IntelliJ-IDEA-Open-API-and-Plugin-Development)を参照してください。

カスタム言語サポート用のプラグインの開発に興味がある場合は、Platform SDK ドキュメントの [専用セクション(英語)](https://plugins.jetbrains.com/docs/intellij/custom-language-support.html)を参照し、 [Antlr のプラグイン開発ノート(英語)](https://github.com/antlr/antlr4-intellij-adaptor/blob/master/doc/plugin-dev-notes.md)を確認してください。 [PSI ビューアー(英語)](https://plugins.jetbrains.com/plugin/227-psiviewer)プラグインは、プログラム構造インターフェース [PSI(英語)](https://plugins.jetbrains.com/docs/intellij/basics/architectural_overview/psi.html) に慣れるために役立ちます。

プラグインの [テスト(英語)](https://plugins.jetbrains.com/docs/intellij/testing-plugins.html)に関するガイダンスドキュメントも参照してください。 プラグインの公開のトピックについては、 [Gradle によるプラグインの公開(英語)](https://plugins.jetbrains.com/docs/intellij/publishing-plugin.html)および [DSL の公開(英語)](https://github.com/JetBrains/gradle-intellij-plugin/blob/master/README.md#publishing-dsl)で説明されています。

## See also

### 外部リンク

[CLion Plugin Development (Platform SDK documentation)](https://jetbrains.org/intellij/sdk/docs/products/clion.html) [IntelliJ SDK docs FAQs](https://github.com/halirutan/intellij-sdk-docs/wiki/FAQ) [Community forum](https://intellij-support.jetbrains.com/hc/en-us/community/topics/200366979-IntelliJ-IDEA-Open-API-and-Plugin-Development)

