plugin-packerは、kintoneのプラグイン用のカスタマイズファイルをパッケージングして、プラグインファイルを作成するCLIツールです。

npmパッケージとして提供されているため、Windows／macOS／Linux環境で利用できます。
Webブラウザーからプラグインファイルを作成できる、 Web 版の plugin-packerもあります。

https://github.com/kintone/js-sdk/tree/master/packages/plugin-packer

MIT ライセンス

https://github.com/kintone/js-sdk/blob/master/packages/plugin-packer/README.md

plugin-packerを実行するには、Node.jsとパッケージ管理ツールのnpmが必要です。
Node.jsをインストールすると、npmは自動でインストールされます。

1. Node.js 公式サイト からインストーラーをダウンロードします。
   必要なNode.jsのバージョンは、リポジトリの packages/plugin-packer/package.json にあるenginesプロパティを確認してください。
   たとえば次の記載の場合、Node.jsのバージョン14以上が必要です。

   1 2 3

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

2. ダウンロードしたインストーラーを実行し、画面にしたがってセットアップします。

plugin-packerをインストールします。
ここでは、例としてplugin-packerをグローバルインストールする手順を説明します。

1

npm install -g @kintone/plugin-packer

プラグインにパッケージングする、プラグイン用のカスタマイズファイルを準備します。

このQuickstartでは、 create-plugin の Quickstartで作成したテンプレートを使います。
自分でパッケージングするファイルを用意する場合には、 kintone プラグイン開発手順の「プラグイン作成に必要なファイルの準備」で案内しているファイル構成にしたがって、ファイルを準備してください。

次のコマンドを実行します。

1
2

cd sample_plugin_project
kintone-plugin-packer src

プラグイン用のカスタマイズファイルが、プラグインファイル（plugin.zip）にパッケージングされます。
同時に、秘密鍵ファイル（ランダムな文字列.ppk）が作成されます。

1
2
3
4
5
6
7
8
9

.
├── ランダムな文字列.ppk # 秘密鍵ファイル
├── node_modules
├── package-lock.json
├── package.json
├── plugin.zip # プラグインファイル
├── private.ppk
├── scripts
└── src

あとは、作成したプラグインをkintoneに追加すれば、kintoneアプリで利用できます。
プラグインをkintoneに追加する方法には、次の2つの方法があります。

• 画面から行う方法： プラグインを追加／削除する（システム管理）
• plugin-uploaderを使う方法： プラグインのアップロード：plugin-uploader

同じプラグインファイルを2回目以降にパッケージングするときは、--ppkオプションに秘密鍵ファイルを指定します。
同じプラグインとして認識されるため、kintoneへ追加するときにプラグインを上書きできます。

1

kintone-plugin-packer プラグイン用のカスタマイズファイルのディレクトリ --ppk 秘密鍵ファイル.ppk

Web 版の plugin-packer を使うと、Webブラウザーから、ドラッグアンドドロップでプラグインファイルにパッケージングできます。

1. カスタマイズファイルのディレクトリー（Quickstartの例では「src」）を左側のエリアへドラッグアンドドロップします。

   

2. 2回目のパッケージングの場合は、秘密鍵ファイルも右側のエリアへドラッグアンドドロップします。

   

3. 【作成する】をクリックします。

plugin-packerの変更履歴は、 CHANGELOG を確認してください。

この記事で紹介しているサンプルコードは、2022年5月版kintoneおよび @kintone/plugin-packer v6.0.0で動作を確認しています。