IntelliJ IDEA Live Template を使おう

IntelliJ IDEA Live Template を使って便利になろう。
ライブテンプレートという機能の紹介です。

ライブテンプレート、どんな機能かというと、
キーワード入力すると候補が出て、Tab、またはEnterを押すとテンプレートに設定しておいたフレーズが展開されるやつです。

しかも、展開されるフレーズにはある程度の変数を設定できる。

例えば、編集中のクラス名やメソッド名が自動でフレーズ内に入るように設定可能。

設定の仕方

1. Preference > Live Template
   
   +ボタンを押してまずはグループを作成しよう。
   作成されたグループを選択し、さらに+ボタンでライブテンプレートを作成する。
   

2. 各項目を記入する。

   Abbreviation: テンプレートの呼び出し名
   Description: 候補選択時などに表示される説明
   Template text: 展開されるテンプレート

3. 使用する範囲（ファイルタイプ）を定義する。
   下の方に”No applicable contexts yet. Define” と表示されているので、 “Define”をクリックする。
   特定のファイルタイプでのみ使用した場合は、個別選択すれば良い。
   Everywhereにしておけば簡単だ。
   

4. Apply > OK で反映が完了する
   ソースコード内で、Abbreviationに設定したキーワードを入力するとテンプレート候補が表示されてTabもしくは、Enterで展開されるようになるぞ。

$Tips:$
Template textには、$hoge$ のように、$で囲む事で変数として扱う事が可能。
“Edit Variables” で値の設定ができ、
編集中のクラス名や、メソッド名を自動で入力させる事ができる。

共有する方法

折角作成したライブテンプレート、
プロジェクト内で他の人にも使ってもらえるほうが良いので、
自分の作った設定を共有する方法にも触れておく。

XMLファイルで共有

Mac OS X:
~/Library/Preferences/IntelliJIdea2016.3/settingsRepository/repository/templates

Library 配下に存在するXMLファイルが、作成したテンプレートグループ名で存在する。
共有した他の人にこのファイルを渡して、
同じディレクトリに配置する事で、共有が可能となる。
xmlファイルを配置したあとは、IntelliJ IDEAの再起動が必要。

若干、下のリンクに記載のPATHとは異なっていたが、
settingsRepositoryというディレクトリが見つかれば大丈夫だ。

IntelliJ IDEA 2016.3 Help (Sharing Live Templates)
https://www.jetbrains.com/help/idea/2016.3/sharing-live-templates.html

setting.jarで共有

File > Export Settings
Live Template にチェックを入れて、.jarファイルを出力。
出力されたsetting.jarファイルをインポートしてもらえばOK