plugin-packerを使ってプラグインファイルをパッケージングしよう！

Index

はじめに

kintoneのプラグイン開発をもっと簡単にできるようにしたプラグイン開発支援ツール群を公開しました。

今回はその中のplugin-packerについて説明します。

※その他のツールについてはこちら。

plugin-packerとは

プラグインのディレクトリに対してパッケージングしてプラグイン用のzipファイルを生成することができるCLIツールです。

npmに対応しているため、Windows/macOS/Linuxどの環境でも簡単に実行することができます。

ソースコードはGitHubに公開しています。

※ 従来のpackage.shを用いた方法は推奨されていません。こちらのコマンドラインツールを用いたパッケージングをおすすめします。

※ こちらのツールの利用に必要な Node.js のバージョンは、リポジトリの package.json にある engines プロパティをご参照ください。
例：次の記載の場合、Node.js のバージョンは 10 以上が必要です。

"engines": {
 "node": ">=10"
 },

インストール方法

plugin-packerをインストールします。

※ ここでは、npmによるグローバルインストールを例にあげます。

こちらのコマンドを実行することで、plugin-packerをインストールすることができます。

基本の使い方

まず作成したプラグインのプログラムを以下の図のように配置します。
ファイルの中身/配置についてはこちらの記事をご覧ください 。

そして下記のコマンドを実行すると、自動でパッケージングが開始されます。

※ 下記サンプルでは「plugin_dir」を「src」という名前にして実行しています。

実行サンプル

コマンドを実行すると、plugin.zipと秘密鍵ファイルが生成されます。
このplugin.zipをkintoneへアップロードすることでプラグインとして利用することができます。

オプション機能

2回目以降のパッケージング

2回目以降のパッケージングは、--ppkオプションを用いて秘密鍵ファイルも指定してください。

zipファイルの出力先ディレクトリ、ファイル名の指定

--out を用いて<プラグインを出力したいディレクトリ/zipファイルの名前＞を入れると
プラグインzipファイルの出力場所、ファイル名が変更できます。

※ --outオプションを指定しない場合は、デフォルトでプラグインファイル(src)のあるディレクトリにplugin.zipという名前で生成されます。

ファイル監視

--watch を用いると、ディレクトリの変更を監視して都度zipファイルを生成させることができます。

※ 監視を中止する場合は、「ctrl + c」でコマンドをキャンセルしてください。

Web版

おわりに

従来のpackage.shでパッケージングをする場合、WindowsではCygwinなどシェルを動かす環境の準備が必要でしたが、
このplugin-packerを利用すればコマンドプロンプトやPowerShell上で簡単にパッケージングすることができます。

また、plugin-uploaderと組み合わせることでkintoneプラグイン開発がより簡単にできます！

注意事項

ソースコードの変更および再配布、商用利用等はライセンスに従ってご利用可能です。