lkddi/certd
1
0
Fork 0
mirror of https://github.com/certd/certd.git synced 2026-07-17 11:37:32 +08:00
Code Issues Packages Projects Releases Wiki Activity

chore: format

Browse Source
This commit is contained in:
xiaojunnuo
2026-05-31 01:45:15 +08:00
parent 4b57a0d729
commit e834e31510
36 changed files with 690 additions and 643 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.trae/skills/access-plugin-dev/SKILL.md
+67 -54
View File
@@ -7,29 +7,36 @@ version: 1.0.0
# Access 插件开发技能
## 角色定义
你是一名 Certd 插件开发专家，擅长创建和实现 Access 类型的插件，熟悉 TypeScript 编程和 Certd 插件开发规范。
## 核心指令
请严格按照以下步骤执行任务：
1. **导入必要的依赖**
- 导入 `AccessInput`, `BaseAccess`, `IsAccess`, `Pager`, `PageRes`, `PageSearch` 等必要的类型和装饰器
- 导入 `DomainRecord` 等相关类型
2. **使用 @IsAccess 注解注册插件**
- 配置插件的唯一标识、标题、图标和描述
- 继承 `BaseAccess` 类
3. **定义授权属性**
- 使用 `@AccessInput` 注解定义授权属性
- 配置属性的标题、默认值、组件类型和验证规则
- 对于敏感信息，设置 `encrypt: true` 进行加密
4. **实现测试方法**
- 添加测试按钮配置
- 实现 `onTestRequest` 方法，用于测试接口调用是否正常
5. **实现 API 方法**
- 实现必要的 API 方法，如 `GetDomainList`
- 封装统一的 API 请求方法 `doRequest`，处理错误和日志
@@ -39,6 +46,7 @@ version: 1.0.0
- 实现代码复用，避免重复逻辑
## 输出规范
- 必须包含完整的插件实现代码，包括所有必要的导入语句
- 代码必须包含详细的注释说明，解释每个步骤的目的和实现细节
- 提供完整的示例代码，展示插件的使用方法，包括不同类型的授权方式
@@ -51,6 +59,7 @@ version: 1.0.0
### 示例 1: 基本 Access 插件
#### 用户输入
创建一个 Access 插件，用于存储第三方应用的授权信息并提供 API 接口。
#### 你的回答
@@ -70,7 +79,6 @@ import { DomainRecord } from '@certd/plugin-lib';
desc: '这是一个示例授权插件，用于演示如何实现一个授权插件',
})
export class DemoAccess extends BaseAccess {
/**
* 授权属性配置
*/
@@ -78,16 +86,17 @@ export class DemoAccess extends BaseAccess {
title: '授权方式',
value: 'apiKey', //默认值
component: {
name: "a-select", //基于antdv的输入组件
vModel: "value", // v-model绑定的属性名
options: [ //组件参数
name: 'a-select', //基于antdv的输入组件
vModel: 'value', // v-model绑定的属性名
options: [
//组件参数
{
label: "API密钥（推荐）",
value: "apiKey"
label: 'API密钥（推荐）',
value: 'apiKey',
},
{
label: "账号密码",
value: "account"
label: '账号密码',
value: 'account',
},
],
placeholder: 'demoKeyId',
@@ -102,7 +111,7 @@ export class DemoAccess extends BaseAccess {
@AccessInput({
title: '密钥Id',
component: {
name:"a-input",
name: 'a-input',
allowClear: true,
placeholder: 'demoKeyId',
},
@@ -111,19 +120,19 @@ export class DemoAccess extends BaseAccess {
demoKeyId = '';
@AccessInput({
title: '密钥',//标题
required: true, //text组件可以省略
title: '密钥', //标题
required: true, //text组件可以省略
encrypt: true, //该属性是否需要加密
})
demoKeySecret = '';
@AccessInput({
title: "测试",
title: '测试',
component: {
name: "api-test",
action: "TestRequest"
name: 'api-test',
action: 'TestRequest',
},
helper: "点击测试接口是否正常"
helper: '点击测试接口是否正常',
})
testRequest = true;
@@ -132,7 +141,7 @@ export class DemoAccess extends BaseAccess {
*/
async onTestRequest() {
await this.GetDomainList({});
return "ok"
return 'ok';
}
/**
@@ -143,41 +152,41 @@ export class DemoAccess extends BaseAccess {
this.ctx.logger.info(`获取域名列表，req:${JSON.stringify(req)}`);
const pager = new Pager(req);
const resp = await this.doRequest({
action: "ListDomains",
action: 'ListDomains',
data: {
domain: req.searchKey,
offset: pager.getOffset(),
limit: pager.pageSize,
}
},
});
const total = resp?.TotalCount || 0;
let list = resp?.DomainList?.map((item) => {
let list = resp?.DomainList?.map(item => {
item.domain = item.Domain;
item.id = item.DomainId;
return item;
})
});
return {
total,
list
list,
};
}
/**
* 通用api调用方法, 具体如何构造请求体，需参考对应应用的API文档
*/
async doRequest(req: { action: string, data?: any }) {
async doRequest(req: { action: string; data?: any }) {
const res = await this.ctx.http.request({
url: "https://api.demo.cn/api/",
method: "POST",
url: 'https://api.demo.cn/api/',
method: 'POST',
data: {
Action: req.action,
Body: req.data
}
Body: req.data,
},
});
if (res.Code !== 0) {
//异常处理
throw new Error(res.Message || "请求失败");
//异常处理
throw new Error(res.Message || '请求失败');
}
return res.Resp;
}
@@ -187,6 +196,7 @@ export class DemoAccess extends BaseAccess {
### 示例 2: 支持 OAuth 授权的 Access 插件
#### 用户输入
创建一个支持 OAuth 授权方式的 Access 插件。
#### 你的回答
@@ -205,21 +215,20 @@ import { DomainRecord } from '@certd/plugin-lib';
desc: '这是一个支持OAuth授权的插件示例',
})
export class OAuthDemoAccess extends BaseAccess {
@AccessInput({
title: '授权方式',
value: 'oauth',
component: {
name: "a-select",
vModel: "value",
name: 'a-select',
vModel: 'value',
options: [
{
label: "OAuth授权",
value: "oauth"
label: 'OAuth授权',
value: 'oauth',
},
{
label: "API密钥",
value: "apiKey"
label: 'API密钥',
value: 'apiKey',
},
],
},
@@ -230,7 +239,7 @@ export class OAuthDemoAccess extends BaseAccess {
@AccessInput({
title: '客户端ID',
component: {
name:"a-input",
name: 'a-input',
placeholder: 'Client ID',
},
required: true,
@@ -247,7 +256,7 @@ export class OAuthDemoAccess extends BaseAccess {
@AccessInput({
title: '授权回调地址',
component: {
name:"a-input",
name: 'a-input',
placeholder: 'https://your-domain.com/callback',
},
required: true,
@@ -268,12 +277,12 @@ export class OAuthDemoAccess extends BaseAccess {
refreshToken = '';
@AccessInput({
title: "测试",
title: '测试',
component: {
name: "api-test",
action: "TestOAuth"
name: 'api-test',
action: 'TestOAuth',
},
helper: "点击测试OAuth授权是否正常"
helper: '点击测试OAuth授权是否正常',
})
testOAuth = true;
@@ -285,7 +294,7 @@ export class OAuthDemoAccess extends BaseAccess {
// 测试AccessToken是否有效
const result = await this.doOAuthRequest('GET', '/api/user/profile');
this.ctx.logger.info('OAuth测试成功:', result);
return "OAuth授权测试成功";
return 'OAuth授权测试成功';
} catch (error) {
this.ctx.logger.error('OAuth测试失败:', error);
throw new Error('OAuth授权测试失败');
@@ -300,10 +309,10 @@ export class OAuthDemoAccess extends BaseAccess {
url: `https://api.oauth-demo.com${endpoint}`,
method,
headers: {
'Authorization': `Bearer ${this.accessToken}`,
'Content-Type': 'application/json'
Authorization: `Bearer ${this.accessToken}`,
'Content-Type': 'application/json',
},
data
data,
});
if (res.status !== 200) {
@@ -327,8 +336,8 @@ export class OAuthDemoAccess extends BaseAccess {
grant_type: 'refresh_token',
refresh_token: this.refreshToken,
client_id: this.clientId,
client_secret: this.clientSecret
}
client_secret: this.clientSecret,
},
});
if (res.status === 200 && res.data.access_token) {
@@ -349,15 +358,15 @@ export class OAuthDemoAccess extends BaseAccess {
const res = await this.doOAuthRequest('GET', '/api/domains', {
search: req.searchKey,
page: req.page,
pageSize: req.pageSize
pageSize: req.pageSize,
});
return {
total: res.total,
list: res.items.map((item: any) => ({
id: item.id,
domain: item.domain
}))
domain: item.domain,
})),
};
} catch (error) {
// 尝试刷新AccessToken并重试
@@ -366,15 +375,15 @@ export class OAuthDemoAccess extends BaseAccess {
const res = await this.doOAuthRequest('GET', '/api/domains', {
search: req.searchKey,
page: req.page,
pageSize: req.pageSize
pageSize: req.pageSize,
});
return {
total: res.total,
list: res.items.map((item: any) => ({
id: item.id,
domain: item.domain
}))
domain: item.domain,
})),
};
}
throw error;
@@ -397,9 +406,13 @@ export class OAuthDemoAccess extends BaseAccess {
### 实现统一的 API 请求封装
**好处：**
- **代码复用**：避免在每个 API 方法中重复编写相同的 header 设置和错误处理逻辑
- **错误处理一致**：统一捕获和处理各种错误情况，确保错误信息格式统一
- **日志记录完善**：集中记录详细的错误信息，便于调试和问题排查
- **接口调用简化**：调用方只需关注业务逻辑，无需关心底层请求细节
- **易于维护**：统一修改 API 调用方式时，只需修改一处代码
```
```
```
.trae/skills/access-plugin-dev/examples/input.md
+1 -1
View File
@@ -1 +1 @@
我需要开发一个 Access 插件，用于存储和管理第三方应用的授权信息。请指导我如何实现。
我需要开发一个 Access 插件，用于存储和管理第三方应用的授权信息。请指导我如何实现。
.trae/skills/access-plugin-dev/examples/output.md
+2 -2
View File
@@ -129,7 +129,7 @@ async doRequest(req: { action: string, data?: any }) {
});
if (res.Code !== 0) {
//异常处理
//异常处理
throw new Error(res.Message || "请求失败");
}
return res.Resp;
@@ -142,4 +142,4 @@ async doRequest(req: { action: string, data?: any }) {
2. **属性加密**：对于敏感信息（如密钥），应设置 `encrypt: true`。
3. **日志输出**：必须使用 `this.ctx.logger` 输出日志，而不是 `console`。
4. **错误处理**：API 调用失败时应抛出明确的错误信息。
5. **测试方法**：实现 `onTestRequest` 方法，以便用户可以测试授权是否正常。
5. **测试方法**：实现 `onTestRequest` 方法，以便用户可以测试授权是否正常。
.trae/skills/agent.md
+1 -1
View File
@@ -10,4 +10,4 @@ DnsProvider: DNS提供商插件，它用于在ACME申请证书时给域名添加
1、使用技能：在开始工作前，请阅读并加载.trae/skills下面的技能，根据skills进行相应的插件开发
2、迭代技能：当开发过程用户提醒你更好的做法时，你需要总结经验，更新相应的skills，让skills越来越完善，能够在以后得新插件开发中具备指导意义。
3、一般调用的api接口文档会比较复杂，你不知道接口是什么时，请务必询问用户，让用户提供API接口文档
4、完成开发后无需测试，通知用户自己去测试
4、完成开发后无需测试，通知用户自己去测试
.trae/skills/dns-provider-dev/SKILL.md
+32 -18
View File
@@ -7,30 +7,37 @@ version: 1.0.0
# DNS Provider 插件开发技能
## 角色定义
你是一名 Certd 插件开发专家，擅长创建和实现 DNS Provider 类型的插件，熟悉 TypeScript 编程和 Certd 插件开发规范。
## 核心指令
请严格按照以下步骤执行任务：
1. **导入必要的依赖**
- 导入 `AbstractDnsProvider`, `CreateRecordOptions`, `IsDnsProvider`, `RemoveRecordOptions` 等必要的类型和装饰器
- 导入对应的 Access 插件类型
2. **定义记录数据结构**
- 定义适合对应云平台的记录数据结构
- 至少包含 id 字段，用于后续删除记录
3. **使用 @IsDnsProvider 注解注册插件**
- 配置插件的唯一标识、标题、描述、图标
- 指定对应的云平台的 access 类型名称
- 设置排序值（可选）
- 继承 `AbstractDnsProvider` 类
4. **实现 onInstance 方法**
- 获取并保存对应的 Access 实例
- 执行初始化操作
5. **实现 createRecord 方法**
- 解析传入的参数（fullRecord, value, type, domain）
- 记录操作开始日志
- 调用云平台 API 创建 TXT 类型的 DNS 解析记录
@@ -39,6 +46,7 @@ version: 1.0.0
- 返回创建的记录信息，用于后续删除操作
6. **实现 removeRecord 方法**
- 解析传入的参数和之前创建的记录信息
- 记录操作开始日志
- 调用云平台 API 删除 TXT 类型的 DNS 解析记录
@@ -46,6 +54,7 @@ version: 1.0.0
- 记录操作结果日志
7. **实现 getDomainListPage 方法**
- 实现获取域名列表的方法
- 支持分页查询
- 处理可能的错误：网络错误、API调用失败、授权失败等
@@ -55,6 +64,7 @@ version: 1.0.0
- 实例化插件，确保插件被注册
## 输出规范
- 必须包含完整的插件实现代码
- 代码必须包含详细的注释说明
- 提供完整的示例代码，展示插件的使用方法
@@ -65,12 +75,13 @@ version: 1.0.0
### 示例 1: 基本 DNS Provider 插件
#### 用户输入
创建一个 DNS Provider 插件，用于在 ACME 申请证书时添加和删除 TXT 解析记录。
#### 你的回答
```typescript
import { Pager, PageRes, PageSearch } from "@certd/pipeline";
import { Pager, PageRes, PageSearch } from '@certd/pipeline';
import { AbstractDnsProvider, CreateRecordOptions, IsDnsProvider, RemoveRecordOptions, DomainRecord } from '@certd/plugin-cert';
import { DemoAccess } from './access.js';
@@ -124,7 +135,7 @@ export class DemoDnsProvider extends AbstractDnsProvider<DemoRecord> {
// })
// // 返回本次创建的 dns 解析记录，这个记录会在删除的时候用到
// return record
// 模拟返回
return { id: 'demo-record-id' };
} catch (error) {
@@ -141,7 +152,7 @@ export class DemoDnsProvider extends AbstractDnsProvider<DemoRecord> {
const { fullRecord, value, domain } = options.recordReq;
const record = options.recordRes;
this.logger.info('删除域名解析：', domain, fullRecord, value, record);
try {
// 这里调用删除 txt dns 解析记录接口
// 请根据实际接口情况调用，例如：
@@ -150,7 +161,7 @@ export class DemoDnsProvider extends AbstractDnsProvider<DemoRecord> {
// // 授权参数
// // 删除 dns 解析记录的参数
// })
this.logger.info('删除域名解析成功:', fullRecord, value);
} catch (error) {
this.logger.error('删除DNS记录失败:', error);
@@ -166,11 +177,12 @@ export class DemoDnsProvider extends AbstractDnsProvider<DemoRecord> {
const pager = new Pager(req);
const res = await this.http.request({
// 请求接口获取域名列表
})
const list = res.Domains?.map(item => ({
id: item.Id,
domain: item.DomainName,
})) || []
});
const list =
res.Domains?.map(item => ({
id: item.Id,
domain: item.DomainName,
})) || [];
return {
list,
@@ -190,6 +202,7 @@ new DemoDnsProvider();
### 示例 2: 阿里云 DNS Provider 插件
#### 用户输入
创建一个阿里云 DNS Provider 插件，用于在 ACME 申请证书时添加和删除 TXT 解析记录。
#### 你的回答
@@ -230,7 +243,7 @@ export class AliyunDnsProvider extends AbstractDnsProvider<AliyunRecord> {
try {
// 提取主机记录
const hostRecord = fullRecord.replace(`.${domain}`, '');
// 调用阿里云 API 创建解析记录
const response = await this.access.doRequest({
action: 'AddDomainRecord',
@@ -240,7 +253,7 @@ export class AliyunDnsProvider extends AbstractDnsProvider<AliyunRecord> {
Type: type,
Value: value,
TTL: 600, // 10分钟
}
},
});
this.logger.info('阿里云DNS: 解析记录创建成功', { RecordId: response.RecordId });
@@ -265,7 +278,7 @@ export class AliyunDnsProvider extends AbstractDnsProvider<AliyunRecord> {
action: 'DeleteDomainRecord',
data: {
RecordId: record.RecordId,
}
},
});
this.logger.info('阿里云DNS: 解析记录删除成功', { RecordId: record.RecordId });
@@ -287,7 +300,7 @@ export class AliyunDnsProvider extends AbstractDnsProvider<AliyunRecord> {
PageNumber: pager.page,
PageSize: pager.pageSize,
KeyWord: req.searchKey,
}
},
});
const list = response.Domains.Domain.map((domain: any) => ({
@@ -313,6 +326,7 @@ new AliyunDnsProvider();
### 示例 3: 腾讯云 DNS Provider 插件
#### 用户输入
创建一个腾讯云 DNS Provider 插件，用于在 ACME 申请证书时添加和删除 TXT 解析记录。
#### 你的回答
@@ -353,7 +367,7 @@ export class TencentDnsProvider extends AbstractDnsProvider<TencentRecord> {
try {
// 提取主机记录
const hostRecord = fullRecord.replace(`.${domain}`, '');
// 调用腾讯云 API 创建解析记录
const response = await this.access.doRequest({
action: 'CreateRecord',
@@ -363,7 +377,7 @@ export class TencentDnsProvider extends AbstractDnsProvider<TencentRecord> {
RecordType: type,
RecordValue: value,
TTL: 600, // 10分钟
}
},
});
this.logger.info('腾讯云DNS: 解析记录创建成功', { RecordId: response.RecordId });
@@ -388,7 +402,7 @@ export class TencentDnsProvider extends AbstractDnsProvider<TencentRecord> {
action: 'DeleteRecord',
data: {
RecordId: record.RecordId,
}
},
});
this.logger.info('腾讯云DNS: 解析记录删除成功', { RecordId: record.RecordId });
@@ -410,7 +424,7 @@ export class TencentDnsProvider extends AbstractDnsProvider<TencentRecord> {
Offset: (pager.page - 1) * pager.pageSize,
Limit: pager.pageSize,
Keyword: req.searchKey,
}
},
});
const list = response.Domains.map((domain: any) => ({
@@ -439,4 +453,4 @@ new TencentDnsProvider();
2. **accessType**：必须指定对应的云平台的 access 类型名称。
3. **记录结构**：定义适合对应云平台的记录数据结构，至少包含 id 字段用于删除记录。
4. **日志输出**：使用 `this.logger` 输出日志，而不是 `console`，参数文本化，不要传对象，否则会输出`[object Object]}`。
5. **错误处理**：API 调用失败时应抛出明确的错误信息。
5. **错误处理**：API 调用失败时应抛出明确的错误信息。
.trae/skills/dns-provider-dev/examples/input.md
+1 -1
View File
@@ -1 +1 @@
我需要开发一个 DNS Provider 插件，用于在 ACME 申请证书时添加 TXT 解析记录。请指导我如何实现。
我需要开发一个 DNS Provider 插件，用于在 ACME 申请证书时添加 TXT 解析记录。请指导我如何实现。
.trae/skills/dns-provider-dev/examples/output.md
+1 -1
View File
@@ -118,4 +118,4 @@ if (isDev()) {
3. **记录结构**：定义适合对应云平台的记录数据结构，至少包含 id 字段用于删除记录。
4. **日志输出**：使用 `this.logger` 输出日志，而不是 `console`。
5. **错误处理**：API 调用失败时应抛出明确的错误信息。
6. **实例化**：生产环境中应移除 `if (isDev())` 条件，确保插件在生产环境中也能被注册。
6. **实例化**：生产环境中应移除 `if (isDev())` 条件，确保插件在生产环境中也能被注册。
.trae/skills/fast-crud-page-dev/SKILL.md
+32 -33
View File
@@ -33,42 +33,41 @@ version: 1.0.0
7. 删除、审核通过、拒绝等危险操作必须保留确认弹窗和错误提示，成功后刷新当前 CRUD 列表。
8. 对话框里只做纯确认时可以使用 `Modal.confirm`；只要需要字段输入、表单校验或提交字段，统一使用 `useFormDialog` / `openFormDialog`，不要在 `Modal.confirm` 的 `content` 里手写输入框。
## crud 配置
const crudOptions ={
id: string, //表格唯一标识，同一个页面的多个表格的列设置和字段设置会根据id进行区分保存
request:{}, //http请求
columns:{ //字段配置
key:{ //字段key
column:{}, //对应table-column配置
form:{}, //表单中该字段的公共配置，viewForm、addForm、editForm、search会集成此配置，支持对应ui的form-item配置
viewForm:{}, //查看表单中该字段的配置，支持对应ui的form-item配置
addForm:{}, // 添加表单中该字段的配置，支持对应ui的form-item配置
editForm:{}, //编辑表单中该字段的配置，支持对应ui的form-item配置
search:{} //对应查询表单的form-item配置
}
},
search:{ //查询框配置 ，对应fs-search组件
options:{} //查询表单配置 ，对应el-from, a-form配置
},
actionbar:{}, //动作条，添加按钮，对应fs-actionbar组件
toolbar:{}, //工具条 ，对应fs-toolbar组件
table:{ //表格配置，对应fs-table
// 对应 el-table / a-table的配置
slots:{} // 对应el-table ,a-table的插槽
},
data:{}, //列表数据，无需配置，自动从pageRequest中获取
// 如果你要手动改变表格数据，可以通过crudBinding.value.data直接赋值修改表格数据
rowHandle:{}, //操作列配置，对应fs-row-handle
form:{ //表单的公共配置,对应el-form，a-form配置
wrapper:{} //表单外部容器（对话框）的配置，对应el-dialog,el-drawer,a-model,a-drawer的配置
},
viewForm:{}, //查看表单的独立配置
editForm:{}, //编辑表单的独立配置
addForm:{}, //添加表单的独立配置
pagination:{}, //分页配置 ，对应el-pagination / a-pagination
container:{}, //容器配置 ，对应fs-container
id: string, //表格唯一标识，同一个页面的多个表格的列设置和字段设置会根据id进行区分保存
request:{}, //http请求
columns:{ //字段配置
key:{ //字段key
column:{}, //对应table-column配置
form:{}, //表单中该字段的公共配置，viewForm、addForm、editForm、search会集成此配置，支持对应ui的form-item配置
viewForm:{}, //查看表单中该字段的配置，支持对应ui的form-item配置
addForm:{}, // 添加表单中该字段的配置，支持对应ui的form-item配置
editForm:{}, //编辑表单中该字段的配置，支持对应ui的form-item配置
search:{} //对应查询表单的form-item配置
}
},
search:{ //查询框配置 ，对应fs-search组件
options:{} //查询表单配置 ，对应el-from, a-form配置
},
actionbar:{}, //动作条，添加按钮，对应fs-actionbar组件
toolbar:{}, //工具条 ，对应fs-toolbar组件
table:{ //表格配置，对应fs-table
// 对应 el-table / a-table的配置
slots:{} // 对应el-table ,a-table的插槽
},
data:{}, //列表数据，无需配置，自动从pageRequest中获取
// 如果你要手动改变表格数据，可以通过crudBinding.value.data直接赋值修改表格数据
rowHandle:{}, //操作列配置，对应fs-row-handle
form:{ //表单的公共配置,对应el-form，a-form配置
wrapper:{} //表单外部容器（对话框）的配置，对应el-dialog,el-drawer,a-model,a-drawer的配置
},
viewForm:{}, //查看表单的独立配置
editForm:{}, //编辑表单的独立配置
addForm:{}, //添加表单的独立配置
pagination:{}, //分页配置 ，对应el-pagination / a-pagination
container:{}, //容器配置 ，对应fs-container
}
## 布局高度
.trae/skills/plugin-converter/SKILL.md
+22 -4
View File
@@ -7,15 +7,19 @@ version: 1.0.0
# 插件转换工具技能
## 角色定义
你是一名 Certd 插件开发专家，擅长使用插件转换工具将 Certd 插件转换为 YAML 配置文件，熟悉命令行工具的使用和 Certd 插件开发规范。
## 核心指令
请严格按照以下步骤执行任务：
1. **定位工具位置**
- 工具位于 `trae/skills/convert-plugin-to-yaml.js`
2. **了解功能特性**
- 单个插件转换：支持指定单个插件文件进行转换
- 批量插件转换：支持指定目录批量转换多个插件
- 自动类型识别：自动识别插件类型（Access、Task、DNS Provider、Notification、Addon）
@@ -27,6 +31,7 @@ version: 1.0.0
- 可复用函数：导出了可复用的函数，便于其他模块调用
3. **使用工具**
- 基本用法：`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 <输出目录>`
@@ -39,6 +44,7 @@ version: 1.0.0
- 自定义输出目录：`node trae/skills/convert-plugin-to-yaml.js packages/ui/certd-server/src/plugins/plugin-demo/access.js --output ./configs`
4. **理解转换过程**
- 加载插件模块：使用 `import()` 动态加载指定的插件文件
- 分析插件定义：检查模块导出的对象，寻找带有 `define` 属性的插件
- 识别插件类型：根据插件的继承关系或属性识别插件类型
@@ -46,10 +52,12 @@ version: 1.0.0
- 保存配置文件：将生成的配置保存到 `./metadata` 目录
5. **了解输出说明**
- 命令行输出：插件加载状态、插件导出的对象列表、插件类型识别结果、生成的 YAML 配置内容、配置文件保存路径
- 配置文件命名规则：`<插件类型>[_<子类型>]_<插件名称>.yaml`
6. **理解插件类型识别逻辑**
- DNS Provider：如果插件定义中包含 `accessType` 属性
- Task：如果插件继承自 `AbstractTaskPlugin`
- Notification：如果插件继承自 `BaseNotification`
@@ -64,6 +72,7 @@ version: 1.0.0
- 错误处理：如果插件加载失败或识别失败，工具会输出错误信息但不会终止执行
## 输出规范
- 必须包含工具的使用方法和示例
- 必须包含转换过程的详细说明
- 必须包含输出说明和配置文件命名规则
@@ -75,6 +84,7 @@ version: 1.0.0
### 示例 1: 转换单个 Access 插件
#### 用户输入
将 Access 插件转换为 YAML 配置文件。
#### 你的回答
@@ -85,6 +95,7 @@ node trae/skills/convert-plugin-to-yaml.js packages/ui/certd-server/src/plugins/
```
#### 输出
```bash
$ 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
@@ -109,6 +120,7 @@ YAML 配置已保存到: ./metadata/access_demo.yaml
### 示例 2: 批量转换插件
#### 用户输入
批量转换目录中的所有插件为 YAML 配置文件。
#### 你的回答
@@ -119,6 +131,7 @@ node trae/skills/convert-plugin-to-yaml.js packages/ui/certd-server/src/plugins/
```
#### 输出
```bash
$ node trae/skills/convert-plugin-to-yaml.js packages/ui/certd-server/src/plugins/
开始转换目录: packages/ui/certd-server/src/plugins/
@@ -189,6 +202,7 @@ YAML 配置已保存到: ./metadata/dns-provider_demo.yaml
### 示例 3: 自定义输出目录
#### 用户输入
将插件转换为 YAML 配置文件，并保存到自定义目录。
#### 你的回答
@@ -199,6 +213,7 @@ node trae/skills/convert-plugin-to-yaml.js packages/ui/certd-server/src/plugins/
```
#### 输出
```bash
$ 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
@@ -225,14 +240,17 @@ YAML 配置已保存到: ./configs/access_demo.yaml
### 常见问题
1. **模块加载失败**
- 原因：插件文件依赖未安装或路径错误
- 解决：确保已安装所有依赖，检查文件路径是否正确
2. **插件类型识别失败**
- 原因：插件未正确继承基类或缺少必要的属性
- 解决：检查插件代码，确保正确继承对应的基类
3. **YAML 配置生成失败**
- 原因：插件定义格式不正确
- 解决：检查插件的 `define` 属性格式是否正确
@@ -262,9 +280,9 @@ YAML 配置已保存到: ./configs/access_demo.yaml
```javascript
export {
convertSinglePlugin, // 转换单个插件
loadSingleModule, // 加载单个模块
isPrototypeOf // 检查原型关系
convertSinglePlugin, // 转换单个插件
loadSingleModule, // 加载单个模块
isPrototypeOf, // 检查原型关系
};
```
@@ -273,4 +291,4 @@ export {
1. **插件开发**：在开发新插件时，快速生成配置文件
2. **插件调试**：查看插件的内部定义和配置
3. **插件管理**：批量转换现有插件为标准配置格式
4. **自动化构建**：集成到构建流程中，自动生成插件配置
4. **自动化构建**：集成到构建流程中，自动生成插件配置
.trae/skills/plugin-converter/examples/input.md
+1 -1
View File
@@ -1 +1 @@
我需要将一个插件转换为 YAML 配置文件。请指导我如何使用插件转换工具。
我需要将一个插件转换为 YAML 配置文件。请指导我如何使用插件转换工具。
.trae/skills/plugin-converter/examples/output.md
+2 -1
View File
@@ -65,6 +65,7 @@ node .trae/skills/plugin-converter/resources/convert-plugin-to-yaml.js packages/
```
例如：
- `access_demo.yaml`（Access 插件）
- `deploy_DemoTest.yaml`（Task 插件）
- `dnsProvider_demo.yaml`（DNS Provider 插件）
@@ -92,4 +93,4 @@ scriptFilePath: packages/ui/certd-server/src/plugins/plugin-demo/access.js
YAML 配置已保存到: ./metadata/access_demo.yaml
插件转换完成!
```
```
.trae/skills/plugin-converter/resources/convert-plugin-to-yaml.js
+48 -53
View File
@@ -1,11 +1,11 @@
// 转换单个插件为 YAML 配置的技能脚本
import path from "path";
import fs from "fs";
import { pathToFileURL } from "node:url";
import * as yaml from "js-yaml";
import { AbstractTaskPlugin, BaseAccess, BaseNotification} from "@certd/pipeline";
import { BaseAddon} from "@certd/lib-server";
import path from 'path';
import fs from 'fs';
import { pathToFileURL } from 'node:url';
import * as yaml from 'js-yaml';
import { AbstractTaskPlugin, BaseAccess, BaseNotification } from '@certd/pipeline';
import { BaseAddon } from '@certd/lib-server';
/**
* 检查对象是否是指定类的原型
@@ -34,23 +34,23 @@ async function loadSingleModule(filePath) {
*/
async function convertSinglePlugin(pluginPath) {
console.log(`开始转换插件: ${pluginPath}`);
// 加载插件模块
const module = await loadSingleModule(pluginPath);
if (!module) {
console.error("加载插件失败，退出");
console.error('加载插件失败，退出');
return;
}
// 处理模块中的所有导出
const entry = Object.entries(module);
if (entry.length === 0) {
console.error("插件模块没有导出任何内容");
console.error('插件模块没有导出任何内容');
return;
}
console.log(`插件模块导出了 ${entry.length} 个对象: ${entry.map(([name]) => name).join(", ")}`);
console.log(`插件模块导出了 ${entry.length} 个对象: ${entry.map(([name]) => name).join(', ')}`);
// 处理每个导出的对象
for (const [name, value] of entry) {
// 检查是否是插件（有 define 属性）
@@ -58,64 +58,64 @@ async function convertSinglePlugin(pluginPath) {
console.log(`跳过非插件对象: ${name}`);
continue;
}
console.log(`处理插件: ${name}`);
// 构建插件定义
const pluginDefine = {
...value.define
...value.define,
};
let subType = "";
let subType = '';
// 确定插件类型
if (pluginDefine.accessType) {
pluginDefine.pluginType = "dnsProvider";
pluginDefine.pluginType = 'dnsProvider';
} else if (isPrototypeOf(value, AbstractTaskPlugin)) {
pluginDefine.pluginType = "deploy";
pluginDefine.pluginType = 'deploy';
} else if (isPrototypeOf(value, BaseNotification)) {
pluginDefine.pluginType = "notification";
pluginDefine.pluginType = 'notification';
} else if (isPrototypeOf(value, BaseAccess)) {
pluginDefine.pluginType = "access";
pluginDefine.pluginType = 'access';
} else if (isPrototypeOf(value, BaseAddon)) {
pluginDefine.pluginType = "addon";
subType = "_" + (pluginDefine.addonType || "");
pluginDefine.pluginType = 'addon';
subType = '_' + (pluginDefine.addonType || '');
} else {
console.log(`[warning] 未知的插件类型：${pluginDefine.name}`);
continue;
}
pluginDefine.type = "builtIn";
pluginDefine.type = 'builtIn';
// 计算脚本文件路径
const relativePath = path.relative(process.cwd(), pluginPath);
const scriptFilePath = relativePath.replace(/\\/g, "/").replace(/\.js$/, ".js");
const scriptFilePath = relativePath.replace(/\\/g, '/').replace(/\.js$/, '.js');
pluginDefine.scriptFilePath = scriptFilePath;
console.log(`插件类型: ${pluginDefine.pluginType}`);
console.log(`脚本路径: ${scriptFilePath}`);
// 生成 YAML 配置
const yamlContent = yaml.dump(pluginDefine);
console.log("\n生成的 YAML 配置:");
console.log('\n生成的 YAML 配置:');
console.log(yamlContent);
// 可选：保存到文件
const outputDir = "./metadata";
const outputDir = './metadata';
if (!fs.existsSync(outputDir)) {
fs.mkdirSync(outputDir, { recursive: true });
}
const outputFileName = `${pluginDefine.pluginType}${subType}_${pluginDefine.name}.yaml`;
const outputPath = path.join(outputDir, outputFileName);
fs.writeFileSync(outputPath, yamlContent, 'utf8');
console.log(`\nYAML 配置已保存到: ${outputPath}`);
return pluginDefine;
}
console.error("未找到有效的插件定义");
console.error('未找到有效的插件定义');
}
/**
@@ -123,25 +123,25 @@ async function convertSinglePlugin(pluginPath) {
*/
async function main() {
const args = process.argv.slice(2);
if (args.length === 0) {
console.error("请指定插件文件路径");
console.log("用法: node convert-plugin-to-yaml.js <插件文件路径>");
console.error('请指定插件文件路径');
console.log('用法: node convert-plugin-to-yaml.js <插件文件路径>');
process.exit(1);
}
const pluginPath = args[0];
if (!fs.existsSync(pluginPath)) {
console.error(`插件文件不存在: ${pluginPath}`);
process.exit(1);
}
try {
await convertSinglePlugin(pluginPath);
console.log("\n插件转换完成!");
console.log('\n插件转换完成!');
} catch (error) {
console.error("转换过程中出错:", error);
console.error('转换过程中出错:', error);
process.exit(1);
}
}
@@ -152,9 +152,4 @@ if (import.meta.url === pathToFileURL(process.argv[1]).href) {
}
// 导出函数，以便其他模块使用
export {
convertSinglePlugin,
loadSingleModule,
isPrototypeOf
};
export { convertSinglePlugin, loadSingleModule, isPrototypeOf };
.trae/skills/task-plugin-dev/SKILL.md
+18 -2
View File
@@ -7,12 +7,15 @@ version: 1.0.0
# Task 插件开发技能
## 角色定义
你是一名 Certd 插件开发专家，擅长创建和实现 Task 类型的插件，熟悉 TypeScript 编程和 Certd 插件开发规范。
## 核心指令
请严格按照以下步骤执行任务：
1. **导入必要的依赖**
- 导入 `AbstractTaskPlugin`, `IsTaskPlugin`, `PageSearch`, `pluginGroups`, `RunStrategy`, `TaskInput` 等必要的类型和装饰器
- 导入 `CertInfo`, `CertReader` 等证书相关类型
- 导入 `createCertDomainGetterInputDefine`, `createRemoteSelectInputDefine` 等工具函数
@@ -20,22 +23,26 @@ version: 1.0.0
- 导入 `CertApplyPluginNames` 等常量
2. **使用 @IsTaskPlugin 注解注册插件**
- 配置插件的唯一标识、标题、图标
- 设置插件分组
- 配置默认策略（如 `SkipWhenSucceed`）
- 确保类名与插件名称一致
3. **定义任务输入参数**
- 使用 `@TaskInput` 注解定义各种输入参数
- 必须包含证书选择参数，用于获取前置任务输出的域名证书
- 可以添加授权选择框、文本输入、选择框等参数
- 使用 `createCertDomainGetterInputDefine` 获取证书域名列表
4. **实现动态显隐配置**
- 使用 `mergeScript` 实现根据其他输入值动态控制输入项的显隐状态
- 利用 `ctx.compute` 函数访问表单中的其他字段值
5. **实现插件方法**
- **onInstance 方法**：插件实例化时执行的初始化操作
- **execute 方法**：插件的核心执行逻辑
- 获取授权信息
@@ -55,6 +62,7 @@ version: 1.0.0
- 授权获取：使用 `this.getAccess(accessId)` 获取授权信息
## 输出规范
- 必须包含完整的插件实现代码
- 代码必须包含详细的注释说明
- 提供完整的示例代码，展示插件的使用方法
@@ -65,6 +73,7 @@ version: 1.0.0
### 示例 1: 基本 Task 插件
#### 用户输入
创建一个 Task 插件，用于将证书部署到对应的应用上。
#### 你的回答
@@ -74,7 +83,7 @@ import { AbstractTaskPlugin, IsTaskPlugin, PageSearch, pluginGroups, RunStrategy
import { CertInfo, CertReader } from '@certd/plugin-cert';
import { createCertDomainGetterInputDefine, createRemoteSelectInputDefine } from '@certd/plugin-lib';
import { optionsUtils } from '@certd/basic';
import { CertApplyPluginNames} from '@certd/plugin-cert';
import { CertApplyPluginNames } from '@certd/plugin-cert';
@IsTaskPlugin({
//命名规范，插件类型+功能，大写字母开头，驼峰命名
@@ -281,6 +290,7 @@ export class DemoTest extends AbstractTaskPlugin {
### 示例 2: Nginx 部署 Task 插件
#### 用户输入
创建一个 Task 插件，用于将证书部署到 Nginx 服务器上。
#### 你的回答
@@ -459,6 +469,7 @@ new NginxDeploy();
### 示例 3: 阿里云 OSS 部署 Task 插件
#### 用户输入
创建一个 Task 插件，用于将证书部署到阿里云 OSS 上。
#### 你的回答
@@ -628,6 +639,7 @@ new AliyunOSSDeploy();
## 部署逻辑注意事项
1. **部署接口逻辑**：
- 研究应用的部署接口逻辑，一般有两种：
a. 用户选择网站ID，给网站部署新证书
b. 用户选择证书ID，只需要更新证书即可
@@ -635,6 +647,7 @@ new AliyunOSSDeploy();
- 确保出错后重新运行能够回归到正常状态
2. **前置证书选择**：
- 前置证书可以是原始的 `certInfo` 类型，也可能是上传到平台之后返回的证书id
- 根据接口要求选择合适的证书类型：
a. 如果接口需要上传后的证书id，那么部署时要先将证书上传，再部署
@@ -643,4 +656,7 @@ new AliyunOSSDeploy();
3. **证书清理**：
- 如果是先上传再部署的，那么在部署完成后，可能需要考虑清理证书
```
```
```
.trae/skills/task-plugin-dev/examples/input.md
+1 -1
View File
@@ -1 +1 @@
我需要开发一个 Task 插件，用于将申请的证书部署到指定的应用系统中。请指导我如何实现。
我需要开发一个 Task 插件，用于将申请的证书部署到指定的应用系统中。请指导我如何实现。
.trae/skills/task-plugin-dev/examples/output.md
+2 -2
View File
@@ -9,7 +9,7 @@ import { AbstractTaskPlugin, IsTaskPlugin, PageSearch, pluginGroups, RunStrategy
import { CertInfo, CertReader } from '@certd/plugin-cert';
import { createCertDomainGetterInputDefine, createRemoteSelectInputDefine } from '@certd/plugin-lib';
import { optionsUtils } from '@certd/basic';
import { CertApplyPluginNames} from '@certd/plugin-cert';
import { CertApplyPluginNames } from '@certd/plugin-cert';
```
### 2. 使用 @IsTaskPlugin 注解注册插件
@@ -126,4 +126,4 @@ async execute(): Promise<void> {
3. **证书选择**：必须包含证书选择参数，用于获取前置任务输出的域名证书。
4. **日志输出**：使用 `this.logger` 输出日志，而不是 `console`。
5. **错误处理**：执行过程中的错误应被捕获并记录。
6. **授权获取**：使用 `this.getAccess(accessId)` 获取授权信息。
6. **授权获取**：使用 `this.getAccess(accessId)` 获取授权信息。