plugin-packer

information

本頁面使用機器翻譯而成。
機器翻譯免責聲明 (External link)

目錄

什麼是外掛程式打包器?

plugin-packer是CLI工具,通過打包kintone外掛程式的自定義檔來創建外掛程式檔。

它以 npm 包的形式提供,因此可以在 Windows/macOS/Linux 環境中使用。
還有一個 plugin-packer 的 Web 版本,允許您從 Web 瀏覽器創建外掛程式檔。

GitHub

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

授權

麻省理工學院許可證 (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

步驟1:安裝所需的套件

安裝 plugin-packer。
本節以全域安裝plugin-packer為例進行說明。

1
npm install -g @kintone/plugin-packer

步驟2:準備要打包到外掛程式中的檔

為要打包到外掛程式中的外掛程式準備自定義檔。

本快速入門使用你在 create-plugin 快速入門 中創建的範本。
如需自行打包檔,請按照kintone外掛程式開發流程
中 「準備外掛程式所需的檔」 進行文件準備。

步驟3:創建外掛程式檔

執行以下命令:

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中添加外掛程式有兩種方法:

補充

第二次及以後的包裝

第二次或後續打包同一外掛程式檔時,請在--ppk 選項中指定私鑰檔。
由於它們被識別為同一個外掛程式,因此在添加kintone時可以覆蓋該外掛程式。

1
kintone-plugin-packer 外掛程式自定義文件目錄 --ppk 私鑰檔.ppk

plugin-packer 的 Web 版本

plugin-packer (External link) 的 Web 版本允許您透過拖放將外掛程式從 Web 瀏覽器打包到外掛程式檔中。

  1. 將自訂文件目錄(快速入門示例中的"src")拖放到左側區域。

  2. 第二次打包時,將私鑰檔拖拽到右側區域。

  3. 按兩下創建。

修訂記錄

檢查 CHANGELOG (External link) 以獲取 plugin-packer 的更新日誌。

information

本文介紹的示例代碼已經過kintone的2022年5月版本和@kintone/plugin-packer v6.0.0版本的測試。