plugin-packer
plugin-packer とは
plugin-packer は、kintone のプラグイン用のカスタマイズファイルをパッケージングして、プラグインファイルを作成する CLI ツールです。
npm パッケージとして提供されているため、Windows/macOS/Linux 環境で利用できます。
Web ブラウザーからプラグインファイルを作成できる、
Web 版の plugin-packer もあります。
GitHub
https://github.com/kintone/js-sdk/tree/master/packages/plugin-packer
ライセンス
ドキュメント
https://github.com/kintone/js-sdk/blob/master/packages/plugin-packer/README.md
下準備
plugin-packer を実行するには、Node.js とパッケージ管理ツールの npm が必要です。
Node.js をインストールすると、npm は自動でインストールされます。
-
Node.js 公式サイト
からインストーラーをダウンロードします。
必要な Node.js のバージョンは、リポジトリの packages/plugin-packer/package.jsonにある engines プロパティを確認してください。
たとえば次の記載の場合、Node.js のバージョン 14 以上が必要です。1 2 3
"engines": { "node": ">=14" },
-
ダウンロードしたインストーラーを実行し、画面にしたがってセットアップします。
Quickstart
Step1:必要なパッケージのインストール
plugin-packer をインストールします。
ここでは、例として plugin-packer をグローバルインストールする手順を説明します。
|
|
Step2:プラグインにパッケージングするファイルの準備
プラグインにパッケージングする、プラグイン用のカスタマイズファイルを準備します。
この Quickstart では、
create-plugin の Quickstart で作成したテンプレートを使います。
自分でパッケージングするファイルを用意する場合には、
kintone プラグイン開発手順 の「プラグイン作成に必要なファイルの準備」で案内しているファイル構成にしたがって、ファイルを準備してください。
Step3:プラグインファイルの作成
次のコマンドを実行します。
|
|
プラグイン用のカスタマイズファイルが、プラグインファイル(plugin.zip
)にパッケージングされます。
同時に、秘密鍵ファイル(ランダムな文字列.ppk
)が作成されます。
|
|
あとは、作成したプラグインを kintone に追加すれば、kintone アプリで利用できます。
プラグインを kintone に追加する方法には、次の 2 つの方法があります。
- 画面から行う方法:
プラグインを追加/削除する(システム管理)
- plugin-uploader を使う方法: プラグインのアップロード:plugin-uploader
補足
2回目以降のパッケージング
同じプラグインファイルを 2 回目以降にパッケージングするときは、--ppk
オプションに秘密鍵ファイルを指定します。
同じプラグインとして認識されるため、kintone へ追加するときにプラグインを上書きできます。
|
|
Web 版の plugin-packer
Web 版の plugin-packer
を使うと、Web ブラウザーから、ドラッグアンドドロップでプラグインファイルにパッケージングできます。
-
カスタマイズファイルのディレクトリー(Quickstart の例では「src」)を左側のエリアへドラッグアンドドロップします。
-
2 回目のパッケージングの場合は、秘密鍵ファイルも右側のエリアへドラッグアンドドロップします。
-
【作成する】をクリックします。
更新履歴
plugin-packer の変更履歴は、
CHANGELOG
を確認してください。
この記事で紹介しているサンプルコードは、2022 年 5 月版 kintone および @kintone/plugin-packer v6.0.0 で動作を確認しています。