• TAPD 开放平台
• TAPD 开放平台插件文档

根据下面的步骤来配置你的开发环境。同时你需要安装 TAPD 提供的 CLI 工具来创建和开发 TAPD 插件。

• Node.js 14.13.0 及以上

1. 安装 Node.js
2. 安装 tplugin-cli

   npm install -g @opentapd/tplugin-cli
   

安装之后，tplugin-cli 将基于本身身份，提供插件创建、管理、调试等功能。用户需要首先通过登录命令进行 Oauth 授权，完成身份认证：

tplugin-cli login

登录完成后，会保存一段时间的登录态，在这期间，可以调用 tplugin-cli 的其他指令完成操作。

可以通过 --help 指令查看 tplugin-cli 拥有哪些功能支持：

tplugin-cli --help

1. 调用 create 命令，带上应用 Code（例如 HelloWorld，需自定义且全站唯一）：

   tplugin-cli create HelloWorld
   

   输出示例：

   Usage: tplugin-cli create [options] <code>
   
   通过CLI创建一个TAPD插件
   
   Options:
     -h, --help         display help for command
   

2. 选择模板：

   ? 请选择你要创建的模板: 
   ❯ UI NodeJs Vue (UI界面扩展(Vue))
     Event NodeJs (监听/处理事件) 
     AutoTask Object (扩展自动化助手对象) 
     Event Python (监听/处理事件(Python))
     ... ...
   

3. 根据提示，选择扩展模块：

   ? 请选择扩展模块: (Press <space> to select, <a> to toggle all, <i> to invert selection)
   ❯ ◯ app_for_project (项目导航)
     ◯ app_for_setting (应用设置)
     ◯ app_for_devops_setting (流水线设置)
     ◯ app_for_obj_more (业务对象更多)
     ◯ app_for_obj_tab (业务对象tab)
     ◯ app_for_obj_detail_panel (业务对象详情页版块)
     ◯ app_for_obj_attachment (业务对象附件)
     ... ...
   

4. 进入插件目录，进行开发：

   cd HelloWorld（或为应用 Code 即为文件夹名）
   

5. 开发调试：

   tplugin-cli serve
   

---

选择一个项目，订阅远端成功后，进入TAPD项目，进行代码调试

目录	说明
auto-task-object-nodejs	自动化助手扩展插件 Demo
ci-nodejs-vue	CI/CD 插件 Demo（Node.js + Vue）
field-extend-nodejs	字段扩展插件 Demo
im-nodejs-vue	IM（即时通讯）插件 Demo
scm-nodejs-vue	SCM（代码管理）插件 Demo
workflow-nodejs	工作流校验扩展插件 Demo

克隆仓库 bash git clone https://cnb.cool/tapd.cn/tapd-plugin-demo.git

进入Demo 目录， plugin.yaml 和源码，本地调试。

plugin.yaml 为插件的主要配置文件，包含插件的基本信息、标识、扩展配置和路由。例如：

app:
  code: HelloWorld
  name: HelloWorld
  resources:
    - key: app_for_project
      name: Demo应用
      path: pages/app_for_project

• SCM插件demo
• CI插件demo
• 字段扩展插件demo
• IM插件demo
• 自动化助手扩展插件demo
• 工作流校验扩展插件demo