SDK & Tools

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 (External link)

ライセンス

MIT ライセンス (External link)

ドキュメント

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

下準備

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

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

    1
2
3

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

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

Quickstart

Step1：必要なパッケージのインストール

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

1

npm install -g @kintone/plugin-packer

Step2：プラグインにパッケージングするファイルの準備

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

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

Step3：プラグインファイルの作成

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

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 つの方法があります。

補足

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

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

1

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

Web 版の plugin-packer

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

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

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

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

更新履歴

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

infomation

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