webpack-plugin-kintone-plugin
關於 webpack-plugin-kintone-plugin
webpack-plugin-kintone-plugin是一個CLI工具,支援使用webpack 創建kintone外掛程式檔。
webpack
您可以使用 webpack 壓縮檔大小或捆綁第三方函式庫。
它以 npm 包的形式提供,因此可以在 Windows/macOS/Linux 環境中使用。
GitHub
https://github.com/kintone/js-sdk/tree/main/packages/webpack-plugin-kintone-plugin
授權
文件
https://github.com/kintone/js-sdk/blob/main/packages/webpack-plugin-kintone-plugin/README.md
下準備
要運行 webpack-plugin-kintone-plugin,需要 Node.js 和 npm(一個包管理工具)。
安裝 Node.js 時,會自動安裝 npm。
-
Node.js從官方網站下載安裝程式。
Node.js官方網站
對於所需的 Node.js 版本,請檢查以下儲存庫中的 engines 屬性。
packages/webpack-plugin-kintone-plugin/package.json
例如,以下要求Node.js版本 20 或更高版本:1 2 3"engines": { "node": ">=20" }, -
運行下載的安裝程式並按照畫面上的說明進行設定。
Quickstart
本節將對使用webpack-plugin-kintone-plugin的外掛程式文件的創建方法進行說明。
Step1:準備外掛程式檔
為要打包到外掛程式中的外掛程式準備自定義檔。
本快速入門以以下的資料夾・文件構成為例進行說明。
|
|
自行準備文件進行打包時,請按照「 準備外掛程式所需的檔 」中介紹的文件構成進行準備。
Step2:安裝所需的套件
在外掛程式檔案目錄下,安裝以下內容:
- webpack-plugin-kintone-plugin
- cli-kintone
- npm-run-all
- webpack
|
|
Step3:為構建檔案創建目錄
創建一個「plugin」作為目錄來儲存使用 webpack 構建的檔。
「plugin」中的檔打包在kintone外掛程式檔中。
|
|
Step4:創建並修改webpack-plugin-kintone-plugin的配置檔
為了運行webpack-plugin-kintone-plugin,需要創建並修改以下三個檔。
manifest.jsonwebpack.config.jspackage.json
manifest.json
這是用於打包外掛程式的配置檔。
將manifest.json移動到Step3中創建的「plugin」目錄。
|
|
webpack.config.js
webpack 配置檔。
在外掛程式檔目錄下直接創建一個「webpack.config.js」,其中包含以下內容。
|
|
您可以在 manifest.json 中使用外掛程式 ID 和版本作為生成的外掛程式檔的檔案名。
|
|
如果要更改輸出的檔案名,請在後述的upload腳本的--input中指定相同的路徑。
package.json
此文件用於管理 npm 包。
將package.json的scripts修改如下:
|
|
kintone的登入資訊可以管理在.env中,或在執行upload或start腳本之前,如下所示新增為環境變數。
以下為macOS/Linux的範例。
Windows的新增方法請參閱
cli-kintone文件
。
|
|
Step5:將非 js 檔移動到「plugin」
在這種情況下,我們不會將 css、HTML 或圖像檔與 webpack 捆綁在一起。
因此,請移動到「plugin」目錄,以便您可以打包它。
|
|
如果完成到Step5,「sample_plugin_project」的目錄結構如下。
|
|
Step6:打包到外掛程式檔中
執行以下命令:
|
|
在「dist」目錄下,外掛程式檔生成為「plugin.zip」。
|
|
之後,您可將創建的外掛程式添加到kintone中,並在kintone應用中使用。
在kintone中添加外掛程式有兩種方法:
- 在畫面上操作的方法:
新增/移除外掛程式(kintone系統管理)
- 使用cli-kintone的方法: 建立外掛程式 | STEP4 將外掛程式檔案新增到kintone
補充
監控檔並自動添加外掛程式到打包/kintone
執行以下命令,修改原始碼時即可自動打包外掛程式檔並上傳。
此命令執行的是cli-kintone的plugin upload命令。
執行命令前,請設定KINTONE_BASE_URL、KINTONE_USERNAME、KINTONE_PASSWORD環境變數。
詳細資訊請參閱以下頁面。
plugin upload
|
|
修訂記錄
查看CHANGELOG中查看webpack-plugin-kintone-plugin 的更新日誌。
CHANGELOG
本文介紹的範例代碼已在2026年8月版kintone、@kintone/webpack-plugin-kintone-plugin v9.0.5、@kintone/cli v1.21.1上確認可以運行。
