mirror of
https://github.com/certd/certd.git
synced 2026-04-29 00:28:11 +08:00
10 KiB
10 KiB
name, description, version
| name | description | version |
|---|---|---|
| plugin-converter | 用于将 Certd 插件转换为 YAML 配置文件的命令行工具,支持分析单个插件文件、识别插件类型并生成对应的 YAML 配置。当用户需要生成插件配置、转换插件格式、批量处理插件或修改现有插件配置时触发。 | 1.0.0 |
插件转换工具技能
角色定义
你是一名 Certd 插件开发专家,擅长使用插件转换工具将 Certd 插件转换为 YAML 配置文件,熟悉命令行工具的使用和 Certd 插件开发规范。
核心指令
请严格按照以下步骤执行任务:
-
定位工具位置
- 工具位于
trae/skills/convert-plugin-to-yaml.js
- 工具位于
-
了解功能特性
- 单个插件转换:支持指定单个插件文件进行转换
- 批量插件转换:支持指定目录批量转换多个插件
- 自动类型识别:自动识别插件类型(Access、Task、DNS Provider、Notification、Addon)
- 详细日志输出:提供详细的转换过程日志
- YAML 配置生成:生成标准的 YAML 配置文件
- 配置文件保存:自动将生成的配置保存到
./metadata目录 - 自定义输出目录:支持指定自定义输出目录
- 格式化输出:支持格式化 YAML 输出
- 可复用函数:导出了可复用的函数,便于其他模块调用
-
使用工具
- 基本用法:
node trae/skills/convert-plugin-to-yaml.js <插件文件路径> - 批量转换:
node trae/skills/convert-plugin-to-yaml.js <目录路径> - 自定义输出目录:
node trae/skills/convert-plugin-to-yaml.js <插件文件路径> --output <输出目录> - 格式化输出:
node trae/skills/convert-plugin-to-yaml.js <插件文件路径> --format - 示例:
- 转换 Access 插件:
node trae/skills/convert-plugin-to-yaml.js packages/ui/certd-server/src/plugins/plugin-demo/access.js - 转换 Task 插件:
node trae/skills/convert-plugin-to-yaml.js packages/ui/certd-server/src/plugins/plugin-demo/plugins/plugin-test.js - 转换 DNS Provider 插件:
node trae/skills/convert-plugin-to-yaml.js packages/ui/certd-server/src/plugins/plugin-demo/dns-provider.js - 批量转换插件:
node trae/skills/convert-plugin-to-yaml.js packages/ui/certd-server/src/plugins/ - 自定义输出目录:
node trae/skills/convert-plugin-to-yaml.js packages/ui/certd-server/src/plugins/plugin-demo/access.js --output ./configs
- 转换 Access 插件:
- 基本用法:
-
理解转换过程
- 加载插件模块:使用
import()动态加载指定的插件文件 - 分析插件定义:检查模块导出的对象,寻找带有
define属性的插件 - 识别插件类型:根据插件的继承关系或属性识别插件类型
- 生成 YAML 配置:基于插件定义生成标准的 YAML 配置
- 保存配置文件:将生成的配置保存到
./metadata目录
- 加载插件模块:使用
-
了解输出说明
- 命令行输出:插件加载状态、插件导出的对象列表、插件类型识别结果、生成的 YAML 配置内容、配置文件保存路径
- 配置文件命名规则:
<插件类型>[_<子类型>]_<插件名称>.yaml
-
理解插件类型识别逻辑
- DNS Provider:如果插件定义中包含
accessType属性 - Task:如果插件继承自
AbstractTaskPlugin - Notification:如果插件继承自
BaseNotification - Access:如果插件继承自
BaseAccess - Addon:如果插件继承自
BaseAddon
- DNS Provider:如果插件定义中包含
-
遵循注意事项
- 文件路径:插件文件路径可以是相对路径或绝对路径
- 文件格式:仅支持
.js文件,不支持.ts文件(需要先编译) - 依赖安装:执行前确保已安装所有必要的依赖
- 配置目录:如果
./metadata目录不存在,工具会自动创建 - 错误处理:如果插件加载失败或识别失败,工具会输出错误信息但不会终止执行
输出规范
- 必须包含工具的使用方法和示例
- 必须包含转换过程的详细说明
- 必须包含输出说明和配置文件命名规则
- 必须包含插件类型识别逻辑
- 必须包含注意事项和故障排除建议
示例
示例 1: 转换单个 Access 插件
用户输入
将 Access 插件转换为 YAML 配置文件。
你的回答
# 转换 Access 插件
node trae/skills/convert-plugin-to-yaml.js packages/ui/certd-server/src/plugins/plugin-demo/access.js
输出
$ node trae/skills/convert-plugin-to-yaml.js packages/ui/certd-server/src/plugins/plugin-demo/access.js
开始转换插件: packages/ui/certd-server/src/plugins/plugin-demo/access.js
插件模块导出了 1 个对象: DemoAccess
处理插件: DemoAccess
插件类型: access
脚本路径: packages/ui/certd-server/src/plugins/plugin-demo/access.js
生成的 YAML 配置:
name: demo
title: 授权插件示例
desc: 这是一个示例授权插件,用于演示如何实现一个授权插件
icon: clarity:plugin-line
pluginType: access
type: builtIn
scriptFilePath: packages/ui/certd-server/src/plugins/plugin-demo/access.js
YAML 配置已保存到: ./metadata/access_demo.yaml
插件转换完成!
示例 2: 批量转换插件
用户输入
批量转换目录中的所有插件为 YAML 配置文件。
你的回答
# 批量转换插件
node trae/skills/convert-plugin-to-yaml.js packages/ui/certd-server/src/plugins/
输出
$ node trae/skills/convert-plugin-to-yaml.js packages/ui/certd-server/src/plugins/
开始转换目录: packages/ui/certd-server/src/plugins/
正在处理文件: packages/ui/certd-server/src/plugins/plugin-demo/access.js
开始转换插件: packages/ui/certd-server/src/plugins/plugin-demo/access.js
插件模块导出了 1 个对象: DemoAccess
处理插件: DemoAccess
插件类型: access
脚本路径: packages/ui/certd-server/src/plugins/plugin-demo/access.js
生成的 YAML 配置:
name: demo
title: 授权插件示例
desc: 这是一个示例授权插件,用于演示如何实现一个授权插件
icon: clarity:plugin-line
pluginType: access
type: builtIn
scriptFilePath: packages/ui/certd-server/src/plugins/plugin-demo/access.js
YAML 配置已保存到: ./metadata/access_demo.yaml
插件转换完成!
正在处理文件: packages/ui/certd-server/src/plugins/plugin-demo/plugins/plugin-test.js
开始转换插件: packages/ui/certd-server/src/plugins/plugin-demo/plugins/plugin-test.js
插件模块导出了 1 个对象: DemoTest
处理插件: DemoTest
插件类型: task
脚本路径: packages/ui/certd-server/src/plugins/plugin-demo/plugins/plugin-test.js
生成的 YAML 配置:
name: DemoTest
title: Demo-测试插件
desc: 这是一个示例任务插件,用于演示如何实现一个任务插件
icon: clarity:plugin-line
pluginType: task
group: other
type: builtIn
scriptFilePath: packages/ui/certd-server/src/plugins/plugin-demo/plugins/plugin-test.js
YAML 配置已保存到: ./metadata/task_DemoTest.yaml
插件转换完成!
正在处理文件: packages/ui/certd-server/src/plugins/plugin-demo/dns-provider.js
开始转换插件: packages/ui/certd-server/src/plugins/plugin-demo/dns-provider.js
插件模块导出了 1 个对象: DemoDnsProvider
处理插件: DemoDnsProvider
插件类型: dns-provider
脚本路径: packages/ui/certd-server/src/plugins/plugin-demo/dns-provider.js
生成的 YAML 配置:
name: demo
title: Dns提供商Demo
desc: dns provider示例
icon: clarity:plugin-line
pluginType: dns-provider
accessType: demo
order: 99
type: builtIn
scriptFilePath: packages/ui/certd-server/src/plugins/plugin-demo/dns-provider.js
YAML 配置已保存到: ./metadata/dns-provider_demo.yaml
插件转换完成!
批量转换完成,共处理 3 个插件文件
示例 3: 自定义输出目录
用户输入
将插件转换为 YAML 配置文件,并保存到自定义目录。
你的回答
# 自定义输出目录
node trae/skills/convert-plugin-to-yaml.js packages/ui/certd-server/src/plugins/plugin-demo/access.js --output ./configs
输出
$ node trae/skills/convert-plugin-to-yaml.js packages/ui/certd-server/src/plugins/plugin-demo/access.js --output ./configs
开始转换插件: packages/ui/certd-server/src/plugins/plugin-demo/access.js
插件模块导出了 1 个对象: DemoAccess
处理插件: DemoAccess
插件类型: access
脚本路径: packages/ui/certd-server/src/plugins/plugin-demo/access.js
生成的 YAML 配置:
name: demo
title: 授权插件示例
desc: 这是一个示例授权插件,用于演示如何实现一个授权插件
icon: clarity:plugin-line
pluginType: access
type: builtIn
scriptFilePath: packages/ui/certd-server/src/plugins/plugin-demo/access.js
YAML 配置已保存到: ./configs/access_demo.yaml
插件转换完成!
故障排除
常见问题
-
模块加载失败
- 原因:插件文件依赖未安装或路径错误
- 解决:确保已安装所有依赖,检查文件路径是否正确
-
插件类型识别失败
- 原因:插件未正确继承基类或缺少必要的属性
- 解决:检查插件代码,确保正确继承对应的基类
-
YAML 配置生成失败
- 原因:插件定义格式不正确
- 解决:检查插件的
define属性格式是否正确
-
配置文件保存失败
- 原因:权限不足或磁盘空间不足
- 解决:确保有足够的权限和磁盘空间
调试建议
- 查看详细日志:工具会输出详细的转换过程日志,仔细查看日志信息
- 检查插件代码:确保插件代码符合 Certd 插件开发规范
- 尝试简化插件:如果转换失败,尝试创建一个最小化的插件示例进行测试
- 检查依赖版本:确保使用的依赖版本与 Certd 兼容
代码结构
主要函数
- isPrototypeOf(value, cls):检查对象是否是指定类的原型
- loadSingleModule(filePath):加载单个插件模块
- convertSinglePlugin(pluginPath):分析单个插件并生成 YAML 配置
- main():主函数,处理命令行参数并执行转换
导出函数
工具导出了以下函数,便于其他模块调用:
export {
convertSinglePlugin, // 转换单个插件
loadSingleModule, // 加载单个模块
isPrototypeOf // 检查原型关系
};
应用场景
- 插件开发:在开发新插件时,快速生成配置文件
- 插件调试:查看插件的内部定义和配置
- 插件管理:批量转换现有插件为标准配置格式
- 自动化构建:集成到构建流程中,自动生成插件配置