plugin-packer

目次

plugin-packerとは

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

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

GitHub

https://github.com/kintone/js-sdk/tree/main/packages/plugin-packer (External link)

ライセンス

MITライセンス (External link)

ドキュメント

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

下準備

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

  1. Node.js公式サイトからインストーラーをダウンロードします。
    Node.js公式サイト (External link)
    必要なNode.jsのバージョンは、下記リポジトリあるenginesプロパティを確認してください。
    packages/plugin-packer/package.json (External link)
    たとえば次の記載の場合、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で作成したテンプレートを使います。
create-pluginのQuickstart
自分でパッケージングするファイルを用意する場合には、下記kintoneプラグイン開発手順の「プラグイン作成に必要なファイルの準備」記載のファイル構成にしたがって、ファイルを準備してください。
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を使うと、Webブラウザーから、ドラッグアンドドロップでプラグインファイルにパッケージングできます。
Web版のplugin-packer (External link)

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

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

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

更新履歴

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

information

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