exec-maven-plugin を使って Maven から npm を実行する

概要

npm タスクを Maven と連携してみる。
具体例をひとつあげるとJSライブラリを取り込む npm タスクを用意して、mvn compile と同時に動くようにしてみる。

手順

exec-maven-plugin を使って、npm install を実行する。
Maven には多様なライフサイクルが定義されている¹。例示した npm タスクは JS ライブラリを npm 経由で取ってくるタスクなので、compile 前のソースコード変換をする generate-sources ライフサイクルがこれに該当する（厳密には違う感じもするけど）。

以上を pom.xml に書くとこのようになる。

pom.xml

    <build>
        <plugins>
            ...
            <plugin>
                <groupId>org.codehaus.mojo</groupId>
                <artifactId>exec-maven-plugin</artifactId>
                <executions>
                    <execution>
                        <id>exec-npm-install</id>
                        <phase>generate-sources</phase>
                        <configuration>
                            <executable>npm</executable>
                            <arguments>
                                <argument>install</argument>
                            </arguments>
                        </configuration>
                        <goals>
                            <goal>exec</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

これで mvn compile 実行時に npm install も動作するようになった。めでたしめでたし。

おまけ - Jenkins 連携

CI に Jenkins を導入している場合は Jenkins から npm を見えるように以下の作業が必要になる。

1. NodeJS Plugin をインストールする
2. 該当プロジェクトの設定ページの Build Environment セクションの "Provide Node & npm bin/ folder to PATH" にチェックを入れる

まとめ

mvn と npm を連携した。基本的に利用者は npm の存在をほとんど意識しないで済むのが利点といえる。

参照

---

1. Introduction to the Build Lifecycle ↩