使用 CLI 创建扩展

使用 CLI 创建扩展

概述

Zoho Marketplace 是一个在线商店，您可以在其中上传您为 Zoho 任何产品开发的扩展程序。您也可以将我们商店中提供的扩展程序用于您的业务。本开发者指南将帮助您构建扩展程序并将其部署到我们的 Marketplace。


开始前需要记住的事项


清单文件

每个扩展程序都必须有一个自己的 plugin-manifest.json 文件来定义其行为。定义此文件后，您可以使用 HTML、JavaScript 和 CSS 等客户端技术来构建扩展程序。您可以将扩展程序托管为私有的，也可以将其声明为公开的。


私有扩展和公共扩展


提交扩展时，您需要声明其为私有扩展还是公共扩展。不过，了解它们的区别可能有助于您更好地规划工作：

行为

私有扩展

公共扩展

能见度

任何拥有安装 URL 的人都可以访问该扩展。

所有人

提交后审核

NA

是的。

我们将审核该扩展程序并将其发布到 Zoho Marketplace。

 

设置运行时环境

  1. 安装“Node.js”为您的扩展程序设置开发环境。

  2. 从以下链接下载文件。

  3. 通过执行以下命令验证其版本：$ node -v
安装 Zoho 扩展工具包

Zoho 扩展工具包 (ZET) 是一个命令行界面工具。您将使用此工具来构建、测试和打包您的扩展程序。执行与您的操作系统对应的命令即可安装该工具。

您的操作系统

指令

MacOS / Linux

sudo npm install -g zoho-extension-toolkit

Windows

npm install -g zoho-extension-toolkit

 

-g 表示全局安装。全局安装 ZET 后，您将能够在计算机的任何位置执行命令。否则，您必须导航到 ZET 的安装路径，然后执行 ZET 命令。安装完成后，请执行以下命令验证其版本：zet -v


ZET 选项

ZET 指令

init  

Usage: $zet init

此命令会创建一个新的项目模板目录。执行本节中的步骤 1 至 4，以获取为您的扩展程序创建的文件夹结构。

run  

Usage: $zet run

此命令以当前目录为上下文启动本地服务器。执行本节中的步骤 6 和 7 即可运行您的扩展程序。

validate  

Usage: $zet validate

此命令用于验证当前扩展程序。请执行本节中的步骤 8，根据 plugin-manifest.json 文件中定义的规则验证您的扩展程序。


pack  

Usage: $zet pack

此命令将项目打包为 zip 文件，以便将其上传到 Zoho Marketplace。执行本节中的第 9 步来打包您的扩展程序。这是创建扩展程序的最后一步。


创建您的第一个扩展程序

如何创建扩展程序

  1. 执行 zet init

  • 您将看到一个提示，您必须选择要为其创建扩展的 Zoho 服务。

  1. 选择 Zoho Projects

  2. 为您的扩展程序命名。将创建一个文件夹结构。

  3. 执行 cd [扩展名]

  4. 导航到您机器中的上述目录并使用 HTML、JS、CSS 等客户端技术开发您的扩展。

  5. 执行 zet run

  6. 访问 http://127.0.0.1:5000/plugin-manifest.json 或 http://127.0.0.1:5000/app/index.html 确认服务器是否已成功启动。在验证扩展程序之前，您还可以在开发者模式下对其进行测试。

  7. 执行 zet 验证

  8. 执行 zet pack

 

  1. 为您的扩展程序命名。系统将创建一个文件夹结构。

  2. 执行 cd [扩展程序名称]

  • 此命令将当前路径设置为新创建的扩展的目录路径。

  1. 导航到您机器中的上述目录并使用 HTML、JS、CSS 等客户端技术开发您的扩展。

  • 要点：

      清晰定义清单引用。

  • 在调用我们支持的 JS SDK 方法之前，请将此 JS 代码添加到您的代码中。

  1. 执行 zet run

  • 此命令将启动本地服务器并在本地运行扩展程序。

  • 您的扩展程序将在端口 5000 上运行。请在执行此命令之前确保该端口可用。

  1. 访问 http://127.0.0.1:5000/plugin-manifest.json 或 http://127.0.0.1:5000/app/index.html 确认服务器是否已成功启动。在验证扩展程序之前，您还可以在开发者模式下对其进行测试。

  2. 执行 zet validate

  • 此命令会检查扩展程序是否符合 plugin-manifest.json 文件中定义的准则。点击此处了解如何配置 plugin-manifest.json 文件。

 

  • 如果文件通过验证，则将显示绿色的成功消息。如果失败，请进行相应的更改，然后再次执行 zet verify。

  1. 执行 zet pack

 

  • 此命令会压缩运行扩展程序所需的文件和文件夹，并输出一个“.zip”文件。该文件将位于路径“/{扩展程序的目录}/dist”中。

  • 示例文件路径：“/myfirstextension/dist”。

  • 无论您的扩展程序是私有的还是公开的，都应将此压缩文件提交给 ZApps。

 

 


在开发者模式下测试扩展

  1. 点击右上角的 。

  2. 选择“集成”下的“开发者空间”，然后选择“创建扩展”。

  3. 点击“启用开发者模式”。

  4. 在端口 5000 上运行的扩展程序将在 Zoho Projects 中所有预定义的位置呈现。您可以导航到指定的小部件位置并测试该扩展程序。

  5. 启用开发者模式后，只有本地运行的扩展程序才会呈现，其他扩展程序将被禁用。

  6. 要退出开发者模式，请取消选择“启用开发者模式”按钮。




 


更新市场中的现有扩展程序

开发者可以随时更新其扩展程序。每次更新后，扩展程序的版本都会不断变化。以下是如何在市场中更新现有扩展程序的方法：

  1. 前往 https://sigma.zoho.com

  2. 点击“扩展程序详情”图标。

  3. 点击扩展程序标题下方。

  4. 上传新的 zip 文件（扩展程序的打包版本）。

  5. 接受条款和条件。

  6. 点击“另存为草稿”。

  7. 点击右上角的“发布”。