mirror of https://github.com/msgbyte/tailchat
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
107 lines
2.3 KiB
TypeScript
107 lines
2.3 KiB
TypeScript
import glob from 'glob';
|
|
import path from 'path';
|
|
import url from 'url';
|
|
import fs from 'fs-extra';
|
|
|
|
interface PluginMeta {
|
|
label: string;
|
|
name: string;
|
|
url: string;
|
|
version: string;
|
|
author: string;
|
|
description: string;
|
|
documentUrl: string;
|
|
requireRestart: boolean;
|
|
}
|
|
|
|
const githubRepoUrl = 'https://github.com/msgbyte/tailchat';
|
|
const rootDir = path.resolve(__dirname, '../../');
|
|
const feMD = path.resolve(__dirname, '../docs/plugin-list/fe.md');
|
|
const themeMD = path.resolve(__dirname, '../docs/plugin-list/theme.md');
|
|
const beMD = path.resolve(__dirname, '../docs/plugin-list/full.md');
|
|
|
|
const feplugins = glob.sync(
|
|
path.join(rootDir, './client/web/plugins/*/manifest.json')
|
|
);
|
|
const beplugins = glob.sync(
|
|
path.join(rootDir, './server/plugins/*/web/plugins/*/manifest.json')
|
|
);
|
|
|
|
Promise.all(
|
|
feplugins.map(async (path) => ({
|
|
path,
|
|
manifest: (await fs.readJson(path)) as PluginMeta,
|
|
}))
|
|
).then(async (list) => {
|
|
const list1 = list.filter((item) => !item.manifest.name.includes('.theme.'));
|
|
const list2 = list.filter((item) => item.manifest.name.includes('.theme.'));
|
|
await writeMarkdown(
|
|
feMD,
|
|
list1,
|
|
`---
|
|
sidebar_position: 1
|
|
title: 纯前端插件 (${list1.length})
|
|
---`
|
|
);
|
|
|
|
await writeMarkdown(
|
|
themeMD,
|
|
list2,
|
|
`---
|
|
sidebar_position: 2
|
|
title: 自定义主题 (${list2.length})
|
|
---`
|
|
);
|
|
|
|
console.log('纯前端插件文档自动生成完毕');
|
|
});
|
|
|
|
Promise.all(
|
|
beplugins.map(async (path) => ({
|
|
path,
|
|
manifest: (await fs.readJson(path)) as PluginMeta,
|
|
}))
|
|
).then(async (list) => {
|
|
await writeMarkdown(
|
|
beMD,
|
|
list,
|
|
`---
|
|
sidebar_position: 3
|
|
title: 前后端插件 (${list.length})
|
|
---`
|
|
);
|
|
|
|
console.log('前后端插件文档自动生成完毕');
|
|
});
|
|
|
|
/**
|
|
* 写入markdown
|
|
*/
|
|
async function writeMarkdown(
|
|
path: string,
|
|
list: { path: string; manifest: PluginMeta }[],
|
|
header: string
|
|
) {
|
|
const text = `${header}
|
|
|
|
${list.map(renderPluginDetail).join('\n\n')}
|
|
`;
|
|
|
|
await fs.writeFile(path, text);
|
|
}
|
|
|
|
function renderPluginDetail(info: { path: string; manifest: PluginMeta }) {
|
|
const sourceCodeUrl = url.resolve(
|
|
`${githubRepoUrl}/blob/master/`,
|
|
path.dirname(path.relative(rootDir, info.path))
|
|
);
|
|
|
|
return `### ${info.manifest.name} ${info.manifest.label}
|
|
|
|
${info.manifest.description}
|
|
|
|
- [插件源码](${sourceCodeUrl})
|
|
- [manifest.json](${sourceCodeUrl}/manifest.json)
|
|
`;
|
|
}
|