create-plugin
本頁面使用機器翻譯而成。
機器翻譯免責聲明
關於 create-plugin
create-plugin是CLI工具,用於為kintone外掛程式創建範本。
它以 npm 包的形式提供,因此可以在 Windows/macOS/Linux 環境中使用。
GitHub
https://github.com/kintone/js-sdk/tree/main/packages/create-plugin
授權
文件
https://github.com/kintone/js-sdk/blob/main/packages/create-plugin/README.md
下準備
要運行 create-plugin,您需要 Node.js 和 npm(一個包管理工具)。
安裝 Node.js 時,會自動安裝 npm。
-
Node.js 從官方網站下載安裝程式。
Node.js官方網站
要查找所需的 Node.js版本,請確認以下存儲庫中的 engines 屬性:
packages/create-plugin/package.json
例如,以下要求Node.js版本 14 或更高版本。1 2 3
"engines": { "node": ">=14" },
-
運行下載的安裝程式並按照畫面上的說明進行設置。
Quickstart
本節介紹如何使用 create-plugin 創建範本。
Step1:安裝所需的套件
安裝 create-plugin。
本節以全域安裝 create-plugin 為例進行說明。
|
|
Step2:創建範本
-
以下命令建立一個範本: 在此示例中,我們將在名為「sample_plugin_project」的目錄下創建一個範本。
1
create-kintone-plugin sample_plugin_project
-
以交互方式輸入有關外掛程式的資訊,例如要創建的外掛程式的名稱。
這一次,請指定以下值:- 外掛程式英文名稱:鍵入「sample」,按 Enter 鍵。
- 外掛程式說明:按回車鍵跳過。
- 支援日語:按 Enter 鍵。
- 輸入外掛程式的日語描述:按 Enter 鍵跳過。
- 外掛程式的日文名稱:按 Enter 鍵跳過。
- 支援日語:按 Enter 鍵。
- 外掛程式的英文網站 URL:按 Enter 鍵跳過。
- 外掛程式的日語網站 URL:按 Enter 鍵跳過。
- 移動頁面支援:按 N 並按 Enter 鍵。
- @kintone/plugin-uploader 或按 N 和 Enter 鍵。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
create-kintone-plugin sample_plugin_project kintoneプラグインのプロジェクトを作成するために、いくつかの質問に答えてください :) では、はじめましょう! ? プラグインの英語名を入力してください [1-64文字] sample ? プラグインの説明を入力してください [1-200文字] sample ? 日本語をサポートしますか? Yes ? プラグインの日本語名を入力してください [1-64文字] (省略可) ? プラグインの日本語の説明を入力してください [1-200文字] (省略可) ? 中国語をサポートしますか? No ? プラグインの英語のWebサイトURLを入力してください (省略可) ? プラグインの日本語のWebサイトURLを入力してください (省略可) ? モバイルページをサポートしますか? No ? @kintone/plugin-uploaderを使いますか? No 依存ライブラリをインストールします : : Success! Created sample at sample_plugin_project : : kintoneプラグイン開発をはじめましょう! 開発に関する情報はcybozu developer network: https://developer.cybozu.io
生成「sample_plugin_project」目錄。
在「sample_plugin_project」下,生成創建外掛程式所需的檔,例如:
各文件的詳細內容請參考kintone外掛程式開發步驟。
kintone外掛程式開發流程
|
|
您可以使用 create-plugin 為您的外掛程式建立範本。
之後,您可以將其打包到外掛程式中,並將其應用到kintone中。
補充
自動化包裝
對於生成的「sample_plugin_project」,可以通過運行以下命令將其打包到外掛程式檔中:
當您在外掛程式中變更檔時,它會感知檔中的變更並自動打包。
若要停止自動打包,請按 Ctrl + C(在 Mac 上為 Command + C)取消。
|
|
在create-plugin中勾選「使用@kintone/plugin-uploader」後,npm start
可以通過執行命令自動將外掛程式添加到kintone中。
修訂記錄
確認CHANGELOG以獲取 @kintone/create-plugin 的更新日誌。
CHANGELOG
本文介紹的示例代碼已經過kintone的2022年5月版本和@kintone/create-plugin v5.0.0版本的測試。