@ks-dbdev/template-db-automatic-plugin

@ks-dbdev/template-db-automatic-plugin

多维表格自动化插件开发模板，用于创建自定义的自动化操作插件。

🚀 快速开始

使用 CLI 创建项目（推荐）

# 使用 dbdev CLI 工具
npx @ks-dbdev/cli create template

# 或全局安装后使用
npm install -g @ks-dbdev/cli
dbdev create template

选择 "自动化插件" 模板

📁 项目结构

template-db-automatic-plugin/
├── package.json
├── plugin.json              # 插件配置
├── rollup.config.js         # 打包配置
├── README.md
├── src/
│   ├── meta.json            # 插件元数据
│   ├── template.json        # 模板配置
│   ├── common/              # 公共工具库
│   │   ├── api.js          # API 工具
│   │   ├── config.js       # 配置管理
│   │   ├── logger.js       # 日志工具
│   │   └── utils.js        # 通用工具函数
│   └── scripts/            
│       └── index.js         # 主逻辑入口
├── build/                   # 打包脚本
└── dist/                    # 打包输出目录

🛠️ 开发流程

1. 安装依赖

npm install

2. 打包插件

启动本地调试服务

打开项目目录终端，执行以下命令启动本地调试服务：

npm run debug:server

打开目标多维表页面

打开需要调试的多维表页面，并在 URL 后增加查询参数：?autoTaskDebug=true

示例如下：

• 基础模式：https://www.kdocs.cn/l/XXXXXXXXX?autoTaskDebug=true
• 已含其他参数模式：https://www.kdocs.cn/l/XXXXXXXXX?R=XXXXXXXX&autoTaskDebug=true

验证本地调试效果

页面加载后，打开自动化流程指令列表，即可看到本地开发的对应指令，表示本地调试模式已成功启用。

💡请确保本地调试服务（npm run debug:server）处于运行状态，否则无法加载本地指令。

3. 打包插件

# 仅打包
npm run build

# 仅压缩
npm run zip

# 打包并压缩（推荐）
npm run build-zip

生成的 output/dist.zip 即可上传到WPS开放平台。

📝 可用命令

命令	说明
npm run debug:server	启动本地调试服务器
npm run build	打包插件代码
npm run zip	压缩打包后的文件
npm run build-zip	打包并压缩（一键发布）

📚 相关文档

• WPS多维表格自动化插件开发指南