feat: add plugin config validate

wu-clan · wu-clan · commit c72250bee9ac · 2026-01-26T17:00:14.000+08:00
diff --git a/.github/workflows/validate-plugin-toml.yml b/.github/workflows/validate-plugin-toml.yml
@@ -0,0 +1,34 @@
+name: Validate Plugin TOML
+
+on:
+  pull_request:
+    branches:
+      - master
+    paths:
+      - 'plugins/**/plugin.toml'
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 10
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Validate plugin.toml files
+        run: pnpm validate
diff --git a/constants.ts b/constants.ts
@@ -0,0 +1,16 @@
+export const VALID_TAGS = [
+    "ai",
+    "mcp",
+    "agent",
+    "auth",
+    "storage",
+    "notification",
+    "task",
+    "payment",
+    "other",
+] as const
+
+export const VALID_DATABASES = ['mysql', 'pgsql', 'postgresql'] as const
+
+export type ValidTag = typeof VALID_TAGS[number]
+export type ValidDatabase = typeof VALID_DATABASES[number]
diff --git a/generate.ts b/generate.ts
@@ -2,28 +2,11 @@ import fs from 'fs'
 import path from 'path'
 import { fileURLToPath } from 'url'
 import toml from 'toml'
+import { VALID_TAGS, VALID_DATABASES, ValidTag, ValidDatabase } from './constants.js'
 
 const __filename = fileURLToPath(import.meta.url)
 const __dirname = path.dirname(__filename)
 
-const VALID_TAGS = [
-    "ai",
-    "mcp",
-    "agent",
-    "rag",
-    "permission",
-    "sso",
-    "rbac",
-    "auth",
-    "ldap",
-    "storage",
-    "notification",
-    "task",
-    "other",
-] as const
-
-const VALID_DATABASES = ['mysql', 'postgresql'] as const
-
 const DEFAULT_ICON = 'https://wu-clan.github.io/picx-images-hosting/logo/fba.svg'
 
 interface PluginTomlPlugin {
@@ -32,8 +15,8 @@ interface PluginTomlPlugin {
     version: string
     description: string
     author: string
-    tags?: string[]
-    database?: string[]
+    tags?: ValidTag[]
+    database?: ValidDatabase[]
 }
 
 interface PluginToml {
@@ -139,15 +122,24 @@ function generatePluginData(pluginsDir: string, gitmodulesPath: string): PluginD
         }
 
         const rawPlugin = pluginConfig.plugin
-        let database: string[] | undefined
+
+        // 验证并过滤 tags
+        let tags: ValidTag[] | undefined
+        if (rawPlugin.tags && Array.isArray(rawPlugin.tags)) {
+            const filtered = rawPlugin.tags
+            .map(tag => tag.toLowerCase())
+            .filter((tag): tag is ValidTag => VALID_TAGS.includes(tag as ValidTag))
+            if (filtered.length > 0) {
+                tags = [...new Set(filtered)]
+            }
+        }
+
+        // 验证并过滤 database
+        let database: ValidDatabase[] | undefined
         if (rawPlugin.database && Array.isArray(rawPlugin.database)) {
             const filtered = rawPlugin.database
-            .map(db => {
-                const lower = db.toLowerCase()
-                if (lower === 'pgsql') return 'postgresql'
-                return lower
-            })
-            .filter(db => VALID_DATABASES.includes(db as any))
+            .map(db => db.toLowerCase() as ValidDatabase)
+            .filter((db): db is ValidDatabase => VALID_DATABASES.includes(db))
             if (filtered.length > 0) {
                 database = [...new Set(filtered)]
             }
@@ -159,7 +151,7 @@ function generatePluginData(pluginsDir: string, gitmodulesPath: string): PluginD
             version: rawPlugin.version,
             description: rawPlugin.description,
             author: rawPlugin.author,
-            ...(rawPlugin.tags && { tags: rawPlugin.tags }),
+            ...(tags && { tags }),
             ...(database && { database }),
         }
 
@@ -174,15 +166,19 @@ function generatePluginData(pluginsDir: string, gitmodulesPath: string): PluginD
 
 function generateTypeScriptCode(pluginDataList: PluginData[]): string {
     return `export const validTags = ${ JSON.stringify(VALID_TAGS, null, 2) } as const
+export const validDatabases = ${ JSON.stringify(VALID_DATABASES, null, 2) } as const
+
+export type ValidTag = typeof validTags[number]
+export type ValidDatabase = typeof validDatabases[number]
 
 export interface PluginTomlPlugin {
   icon: string
   summary: string
   version: string
   description: string
   author: string
-  tags?: string[]
-  database?: string[]
+  tags?: ValidTag[]
+  database?: ValidDatabase[]
 }
 
 export interface GitModule {
@@ -218,7 +214,7 @@ function main() {
 
     fs.writeFileSync(
         path.join(baseDir, 'plugins-data.json'),
-        JSON.stringify({ validTags: VALID_TAGS, pluginDataList }, null, 2),
+        JSON.stringify({ validTags: VALID_TAGS, validDatabases: VALID_DATABASES, pluginDataList }, null, 2),
         'utf-8'
     )
 
diff --git a/package.json b/package.json
@@ -2,7 +2,8 @@
   "type": "module",
   "scripts": {
     "generate": "tsx generate.ts",
-    "build": "tsx generate.ts"
+    "build": "tsx generate.ts",
+    "validate": "tsx validate.ts"
   },
   "devDependencies": {
     "@types/node": "^20.0.0",
diff --git a/validate.ts b/validate.ts
@@ -0,0 +1,134 @@
+import fs from 'fs'
+import path from 'path'
+import { fileURLToPath } from 'url'
+import toml from 'toml'
+import { VALID_TAGS, VALID_DATABASES, ValidTag, ValidDatabase } from './constants.js'
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
+
+interface PluginTomlPlugin {
+    icon?: string
+    summary: string
+    version: string
+    description: string
+    author: string
+    tags?: string[]
+    database?: string[]
+}
+
+interface PluginToml {
+    plugin: PluginTomlPlugin
+}
+
+interface ValidationError {
+    plugin: string
+    field: string
+    message: string
+    invalidValues?: string[]
+}
+
+function validatePluginToml(pluginName: string, pluginPath: string): ValidationError[] {
+    const errors: ValidationError[] = []
+    const tomlPath = path.join(pluginPath, 'plugin.toml')
+
+    if (!fs.existsSync(tomlPath)) {
+        return errors
+    }
+
+    let config: PluginToml
+    try {
+        config = toml.parse(fs.readFileSync(tomlPath, 'utf-8')) as PluginToml
+    } catch (e) {
+        errors.push({
+            plugin: pluginName,
+            field: 'plugin.toml',
+            message: `解析失败: ${e instanceof Error ? e.message : String(e)}`,
+        })
+        return errors
+    }
+
+    if (!config.plugin) {
+        errors.push({
+            plugin: pluginName,
+            field: 'plugin',
+            message: '缺少 [plugin] 配置块',
+        })
+        return errors
+    }
+
+    // 验证 tags
+    if (config.plugin.tags && Array.isArray(config.plugin.tags)) {
+        const invalidTags = config.plugin.tags.filter(
+            tag => !VALID_TAGS.includes(tag.toLowerCase() as ValidTag)
+        )
+        if (invalidTags.length > 0) {
+            errors.push({
+                plugin: pluginName,
+                field: 'tags',
+                message: `包含无效的 tags 值`,
+                invalidValues: invalidTags,
+            })
+        }
+    }
+
+    // 验证 database
+    if (config.plugin.database && Array.isArray(config.plugin.database)) {
+        const invalidDatabases = config.plugin.database.filter(
+            db => !VALID_DATABASES.includes(db.toLowerCase() as ValidDatabase)
+        )
+        if (invalidDatabases.length > 0) {
+            errors.push({
+                plugin: pluginName,
+                field: 'database',
+                message: `包含无效的 database 值`,
+                invalidValues: invalidDatabases,
+            })
+        }
+    }
+
+    return errors
+}
+
+function main() {
+    const pluginsDir = path.join(__dirname, 'plugins')
+    const allErrors: ValidationError[] = []
+
+    if (!fs.existsSync(pluginsDir)) {
+        console.log('plugins 目录不存在')
+        process.exit(0)
+    }
+
+    const pluginDirs = fs.readdirSync(pluginsDir, { withFileTypes: true })
+        .filter(entry => entry.isDirectory() && !entry.name.startsWith('.'))
+        .map(entry => entry.name)
+
+    console.log(`验证 ${pluginDirs.length} 个插件...\n`)
+
+    for (const pluginName of pluginDirs) {
+        const pluginPath = path.join(pluginsDir, pluginName)
+        const errors = validatePluginToml(pluginName, pluginPath)
+        allErrors.push(...errors)
+    }
+
+    if (allErrors.length === 0) {
+        console.log('所有插件验证通过')
+        console.log(`\n允许的 tags: ${VALID_TAGS.join(', ')}`)
+        console.log(`允许的 database: ${VALID_DATABASES.join(', ')}`)
+        process.exit(0)
+    }
+
+    console.error('验证失败:\n')
+    for (const error of allErrors) {
+        console.error(`[${error.plugin}] ${error.field}: ${error.message}`)
+        if (error.invalidValues) {
+            console.error(`  无效值: ${error.invalidValues.join(', ')}`)
+        }
+    }
+
+    console.error(`\n允许的 tags: ${VALID_TAGS.join(', ')}`)
+    console.error(`允许的 database: ${VALID_DATABASES.join(', ')}`)
+    process.exit(1)
+}
+
+main()
