うさぎ組

ソフトウェア開発、チームによる製品開発、アジャイル、ソフトウェアテスト

IDEAにGroovyの静的解析ツールのCodeNarcをインストールする方法

Groovyの静的解析ツールにCodeNarcというツールがあります。
http://codenarc.sourceforge.net/


JavaでいうとPMDなんかがちかいのでしょうか?FindBugsくらいしか使ったことないのでよくわかりませんが。
CodeNarc自体はAntで実行したりJUnitで実行でき、
ルールについても標準のものいがいに自分でGroovyのコードで追加できる?ようです。


で、正直なところ僕はAntとかあれなんでプラグインないかなーって思っていたのですが、
つい最近IDEA用のプラグインがリリースされたようです。
NetBeansユーザーの僕にはIDEAなにそれおいしいの状態だったのですが、インストールできたのでメモで残しておきます。


まず、JDK、IDEA、Groovyをインストールしてください。
JDK -- http://java.sun.com/javase/ja/6/download.html
Groovy -- http://groovy.codehaus.org/Download
IDEA -- http://www.jetbrains.com/idea/download/index.html


WindowsであればJDKやGroovyはインストーラーがいいと思います。簡単です。
インストーラーで行なわない場合はそれぞれ、
JAVA_HOME、GROOVY_HOME、PATHの環境変数を設定しましょう。(詳しくは割愛)
IDEAは有償版でなければJavaのWeb開発はできませんが、Groovyの開発はできるのでCommunity版で問題ありません。
もちろん有償版を買ってもらって、僕にIDEAの素晴しさを説いてもらうのは大歓迎です。(お
インストール自体はウィザードにしたがってそれとなくやってもらえればいいと思います。


つぎにCodeNarcのプラグインのインストールになります。
こちらからダウンロードしてください。
http://plugins.jetbrains.com/plugin/?idea&id=5925
で、解凍するとおそらく
/codenarc-idea/lib
といったディレクトリになっていると思います。
このcodenarc-ideaディレクトリをIDEAがインストールされているディレクトリ配下のpluginディレクトリ配下にコピーします。
Windowsなんかだとたぶんつぎのようなパスです。
C:\Program Files (x86)\JetBrains\IntelliJ IDEA Community Edition 10.0.1\plugins
でコピーするので結果としては
C:\Program Files (x86)\JetBrains\IntelliJ IDEA Community Edition 10.0.1\plugins\codenarc-idea\lib
みたいになると思います。


あとはIDEAを起動しましょう。
IDEAを起動中にこの作業を行ってもプラグインはIDEA起動時に読みこまれるようなのでIDEAの再起動が必要です。


起動が完了したら、メニューバーから
[File]-[Settings]と選択するとダイアログが表示されます。
ダイアログの左側の一覧からInspectionsを選択しましょう。
おそらく静的に解析を行いたい項目がずらーっと表示されると思います(この量だけでもNetBeansより上なんじゃないだろうか。)
で、その一覧にCodeNarcが表示されているはずです。
CodeNarcのチェックボックスをオンにするとCodeNarcの静的解析が有効になります。
ここでCodeNarcが一覧に表示されていない場合はプラグインの読み込みエラーが発生していると思います。





Inspectionsは有効にすると即座にコードに反映されます。
問題のある行はエディタの右側に黄色で表示され、該当行はうすいオレンジ色で反転されます。
反転されている場所にカーソルを合わせるとライトのマークが左に表示されるのでクリックすると適用されているルールや変更適用などの項目などがそれぞれ表示されます。






これでGroovyに特化した内容についても静的に解析されるようになったので開発効率があがるはず!
Let's Groovy!!




※最初、githubからダウンロードしたものをまるごとplugin配下にコピーして失敗するなど悩むこと数時間とかやって死にかけたとかどうとか。