自己紹介

自分のページにリストされているIntellijプラグインページがページングされたらプラグイン開発辞めようと誓っていて、最近中の人と話したらページング機能ないけど？ｗと生涯現役プラグイン開発者としてやっていくことが決定した人間です。

Intentionだけではなく、Inspectionなども作成しており、Kotlinのコントリビュートもしています。Kotlinの主なコントリビュートもInspection/Intentionなので、ある程度説明出来るレベルだと思います。

想定読者

Intentionを作ってみたい
プラグイン開発に興味がある
Intellijの機能をある程度理解している
kotlinの文法がそれなりに理解できる

Custom Intentionを作ってみる

今回サンプルとして、Intention周りのプラグインをリリースしました。 https://plugins.jetbrains.com/plugin/9271

ソースコード https://github.com/shiraji/databinding-support

これをベースにXMLファイルに対してのIntentionの説明をします。

今回はレイアウトファイルであり、<layout>タグがrootタグではなかった場合、<layout>タグでラップするというIntentionを作成します。

wrap

プラグインの作成方法などは参考リンクにまとめてありますので、そちらを参照して下さい。

Intentionクラス

IntentionActionを継承します。以下のメソッドを実装する必要があります。

`getText(): String`

popupで表示される時の文字列

`getFamilyName(): String`

よくわからねｗ(intellij-community/kotlin repo内でもgetText呼び出してるだけのところが多い。)

`startInWriteAction(): Boolean`

Write Action内で実行するかどうか。

`isAvailable(project: Project, editor: Editor?, file: PsiFile?): Boolean`

そのIntentionを利用可能かどうか判定する

`invoke(project: Project, editor: Editor?, file: PsiFile?)`

Intentionが選択時に実行されるメソッド。

今回は実際に以下のようなイメージになりました。

package com.github.shiraji.databindinglayout.intentions

class ConvertToDatabindingLayoutIntention : IntentionAction {

    override fun getText() = "Convert to databinding layout"
    override fun getFamilyName() = "Convert to databinding layout"
    override fun startInWriteAction() = true

    override fun isAvailable(project: Project, editor: Editor?, file: PsiFile?): Boolean {
        // rootタグがlayoutではなく、androidのレイアウトファイルかどうかを判定。
    }

    override fun invoke(project: Project, editor: Editor?, file: PsiFile?) {
        // 新規<layout>タグを作成し、必要なattributeを追加し、root tagとする。
    }

}

https://github.com/shiraji/databinding-support/blob/1.0.2/src/main/kotlin/com/github/shiraji/databindinglayout/intentions/ConvertToDatabindingLayoutIntention.kt

このrootタグかどうかとか、androidのレイアウトファイルかどうかの判定とか、何をどう書き換えるのかとかがたぶん一番難しい部分だと思います。ただ、ここはそれぞれのIntentionやプラグインで違うのでコード読んで頑張れｗとしか言えません。。。

唯一ある共通点としてはファイルなどの読み込みや解析はPsiを使います。例えば、xmlタグだったらXmlTag、XmlAttributeを使います。PsiElement#replace()でソースコードの置換することが出来ます。

それぞれのElement作成それぞれのファイルタイプ毎にFactoryが用意されています。XmlならXmlElementFactoryで作成しています。Javaの場合だとPsiElementFactoryだし、KotlinならKtPsiFactoryを使います。

plugin.xml

Intentionクラスをplugin.xmlに定義します。

    <intentionAction>
        <className>com.github.shiraji.databindinglayout.intentions.ConvertToDatabindingLayoutIntention</className>
        <category>Android</category>
    </intentionAction>