Files
certd/packages/ui/certd-server/export-plugin-yaml.js

236 lines
6.3 KiB
JavaScript
Raw Normal View History

// 扫描目录,列出文件,然后加载为模块
2025-04-28 23:34:08 +08:00
import path, { join } from "path";
import fs from "fs";
import { pathToFileURL } from "node:url";
2025-04-15 00:16:57 +08:00
import * as yaml from "js-yaml";
import { AbstractTaskPlugin, BaseAccess, BaseNotification} from "@certd/pipeline";
import { BaseAddon} from "@certd/lib-server";
2026-01-08 00:39:31 +08:00
import { dnsProviderRegistry } from "@certd/plugin-cert";
import { pluginRegistry ,accessRegistry,notificationRegistry,pluginGroups} from "@certd/pipeline";
2025-04-28 23:34:08 +08:00
function scanDir(dir) {
const files = fs.readdirSync(dir);
const result = [];
// 扫描目录及子目录
for (const file of files) {
const filePath = join(dir, file);
const stat = fs.statSync(filePath);
if (stat.isDirectory()) {
result.push(...scanDir(filePath));
} else {
if (!file.endsWith(".js")) {
continue;
}
result.push(filePath);
}
}
return result
}
export default async function loadModules(dir) {
const files = scanDir(dir);
const modules = {}
for (const file of files) {
2025-04-27 15:11:50 +08:00
if(file === "dist/plugins/index.js" || file === "dist\\plugins\\index.js"){
continue
}
2025-12-30 11:26:59 +08:00
const content = fs.readFileSync(file, 'utf8')
if(content.includes(" abstract ")){
continue
}
2025-12-30 11:26:59 +08:00
const lines = content.split('\n')
let allExport = true
for (let line of lines) {
line = line.trim()
if (!line || line.startsWith("//")) {
continue
}
if(!line.startsWith("export ")){
allExport = false
break
}
}
if (allExport) {
continue
}
try {
// 转换为 file:// URLWindows 必需)
const moduleUrl = pathToFileURL(file).href
const module = await import(moduleUrl)
// 如果模块有默认导出,优先使用
modules[file] = module.default || module
} catch (err) {
console.error(`加载模块 ${file} 失败:`, err)
}
}
return modules;
}
2025-04-27 15:11:50 +08:00
function isPrototypeOf(value,cls){
return cls.prototype.isPrototypeOf(value.prototype)
}
2025-05-08 23:27:46 +08:00
async function genMetadata(){
const modules = await loadModules('./dist/plugins');
2025-04-27 15:11:50 +08:00
2025-05-08 23:27:46 +08:00
fs.rmSync("./metadata", { recursive: true });
fs.mkdirSync("./metadata", { recursive: true });
for (const key in modules) {
const module = modules[key]
const entry = Object.entries(module)
for (const [name, value] of entry) {
//如果有define属性
if(value.define){
//那么就是插件
let location = key.substring(4)
location = location.substring(0, location.length - 3)
location = location.replaceAll("\\","/")
location += ".js"
location = `${location}` // 从modules/plugin/plugin-service 加载 ../../plugins目录下的文件
2025-05-08 23:27:46 +08:00
const pluginDefine = {
...value.define
}
let subType = ""
2025-05-08 23:27:46 +08:00
if(pluginDefine.accessType){
pluginDefine.pluginType = "dnsProvider"
}else if(isPrototypeOf(value,AbstractTaskPlugin)){
pluginDefine.pluginType = "deploy"
}else if(isPrototypeOf(value,BaseNotification)){
pluginDefine.pluginType = "notification"
}else if(isPrototypeOf(value,BaseAccess)){
pluginDefine.pluginType = "access"
}else if(isPrototypeOf(value,BaseAddon)){
pluginDefine.pluginType = "addon"
subType = "_"+pluginDefine.addonType
2025-05-08 23:27:46 +08:00
}else{
console.log(`[warning] 未知的插件类型:${pluginDefine.name}`)
}
pluginDefine.type = "builtIn"
const filePath = path.join(`./metadata/${pluginDefine.pluginType}${subType}_${pluginDefine.name}.yaml`)
2025-04-15 00:16:57 +08:00
2025-05-08 23:27:46 +08:00
pluginDefine.scriptFilePath = location
2025-12-30 11:26:59 +08:00
console.log(location)
2025-05-08 23:27:46 +08:00
const data = yaml.dump(pluginDefine)
fs.writeFileSync(filePath,data ,'utf8')
}
2025-04-15 00:16:57 +08:00
}
}
}
2026-01-08 00:39:31 +08:00
async function genPluginMd() {
const plugins = {
access: [],
deploy: [],
dnsProvider: [],
notification: []
};
plugins.access = accessRegistry.getDefineList();
plugins.deploy = pluginRegistry.getDefineList();
plugins.dnsProvider = dnsProviderRegistry.getDefineList();
plugins.notification = notificationRegistry.getDefineList();
// function genMd(list) {
// let mdContent = `<table style='width:100%'>
// <thead style='width:100%'>
// <tr >
// <th width='70'>序号</th><th width='265'>名称</th><th>说明</th>
// </tr>
// </thead>
// <tbody>
// `;
// let i = 0;
// for (const x of list) {
// i++
// mdContent += `<tr> <td>${i}.</td> <td style='font-weight: bold'>${x.title}</td> <td>${x.desc||''}</td> </tr>`;
// }
// mdContent += `</tbody></table>`;
// return mdContent;
// }
// function genMd(list) {
// let mdContent = ``;
// let i = 0;
// for (const x of list) {
// i++
// mdContent += `${i}. **${x.title}** \n${x.desc||''} \n\n\n`;
// }
// return mdContent;
// }
function genMd(list) {
let mdContent = `
| 序号 | 名称 | 说明 |
|-----|-----|-----|
`;
let i = 0;
for (const x of list) {
i++
mdContent += `| ${i}.| **${x.title}** | ${x.desc||''} | \n`;
}
return mdContent;
}
function addTableStyle(){
return `
<style module>
table th:first-of-type {
width: 65px;
}
table th:nth-of-type(2) {
width: 240px;
}
</style>
`
}
let mdContent = "";
mdContent = "# 授权列表\n";
mdContent += genMd(plugins.access);
mdContent += addTableStyle()
fs.writeFileSync("../../../docs/guide/plugins/access.md", mdContent);
mdContent = "# DNS提供商\n";
mdContent += genMd(plugins.dnsProvider);
mdContent += addTableStyle()
fs.writeFileSync("../../../docs/guide/plugins/dns-provider.md", mdContent);
mdContent = "# 通知插件\n";
mdContent += genMd(plugins.notification);
mdContent += addTableStyle()
fs.writeFileSync("../../../docs/guide/plugins/notification.md", mdContent);
mdContent = "# 任务插件\n";
mdContent += `\`${plugins.deploy.length}\` 款任务插件 \n`
let index =0
for (const key in pluginGroups) {
index++
const group = pluginGroups[key];
mdContent += `## ${index}. ${group.title}\n`;
mdContent += genMd(group.plugins);
}
mdContent += addTableStyle()
fs.writeFileSync("../../../docs/guide/plugins/deploy.md", mdContent);
}
2025-04-28 23:34:08 +08:00
// import why from 'why-is-node-running'
// setTimeout(() => why(), 100); // 延迟打印原因
2026-01-08 00:39:31 +08:00
async function main(){
await genMetadata()
await genPluginMd()
process.exit()
}
main()
2025-04-28 23:34:08 +08:00