autosnippet 3.0.0 → 3.0.2

package/scripts/recipe-audit.js

@@ -10,6 +10,7 @@
 
 import fs from 'node:fs';
 import path from 'node:path';
+
 const REQUIRED_FIELDS = [
   'title',
   'trigger',
@@ -17,7 +18,7 @@ const REQUIRED_FIELDS = [
   'language',
   'summary_cn',
   'summary_en',
-  'headers'
+  'headers',
 ];
 
 const CATEGORIES = new Set([
@@ -28,7 +29,7 @@ const CATEGORIES = new Set([
   'Network',
   'Storage',
   'UI',
-  'Utility'
+  'Utility',
 ]);
 
 const FRONTMATTER_RE = /^---\r?\n([\s\S]*?)\r?\n---\r?\n/;
@@ -39,9 +40,11 @@ const FENCED_CODE_RE = /```(\w*)\r?\n([\s\S]*?)```/;
 function findProjectRoot(startDir) {
   let current = startDir;
   while (current && current !== path.dirname(current)) {
-  const candidate = path.join(current, 'AutoSnippet', 'AutoSnippet.boxspec.json');
-  if (fs.existsSync(candidate)) return current;
-  current = path.dirname(current);
+    const candidate = path.join(current, 'AutoSnippet', 'AutoSnippet.boxspec.json');
+    if (fs.existsSync(candidate)) {
+      return current;
+    }
+    current = path.dirname(current);
   }
   return null;
 }
@@ -50,12 +53,12 @@ function readAllMarkdownFiles(dir) {
   const results = [];
   const entries = fs.readdirSync(dir, { withFileTypes: true });
   for (const entry of entries) {
-  const full = path.join(dir, entry.name);
-  if (entry.isDirectory()) {
-    results.push(...readAllMarkdownFiles(full));
-  } else if (entry.isFile() && entry.name.endsWith('.md')) {
-    results.push(full);
-  }
+    const full = path.join(dir, entry.name);
+    if (entry.isDirectory()) {
+      results.push(...readAllMarkdownFiles(full));
+    } else if (entry.isFile() && entry.name.endsWith('.md')) {
+      results.push(full);
+    }
   }
   return results;
 }
@@ -63,63 +66,78 @@ function readAllMarkdownFiles(dir) {
 function parseFrontmatter(text) {
   const out = {};
   const match = text.match(FRONTMATTER_RE);
-  if (!match || !match[1]) return out;
+  if (!match || !match[1]) {
+    return out;
+  }
   const lines = match[1].split(/\r?\n/);
   let key = null;
   let valueLines = [];
   for (const line of lines) {
-  const m = line.match(/^(\w+):\s*(.*)$/);
-  if (m) {
-    if (key) {
-    out[key] = normalizeValue(valueLines.join('\n'));
-    }
-    key = m[1];
-    const rest = m[2].trim();
-    if (rest.startsWith('[')) {
-    out[key] = parseInlineArray(rest);
-    key = null;
-    valueLines = [];
+    const m = line.match(/^(\w+):\s*(.*)$/);
+    if (m) {
+      if (key) {
+        out[key] = normalizeValue(valueLines.join('\n'));
+      }
+      key = m[1];
+      const rest = m[2].trim();
+      if (rest.startsWith('[')) {
+        out[key] = parseInlineArray(rest);
+        key = null;
+        valueLines = [];
+      } else {
+        valueLines = [rest];
+      }
+    } else if (key && line.match(/^\s*-\s+/)) {
+      valueLines.push(line.trim().replace(/^[-\s]+/, ''));
+    } else if (key && line.match(/^\s/)) {
+      valueLines.push(line.trim());
     } else {
-    valueLines = [rest];
+      if (key) {
+        out[key] = normalizeValue(valueLines.join('\n'));
+      }
+      key = null;
+      valueLines = [];
     }
-  } else if (key && line.match(/^\s*-\s+/)) {
-    valueLines.push(line.trim().replace(/^[-\s]+/, ''));
-  } else if (key && line.match(/^\s/)) {
-    valueLines.push(line.trim());
-  } else {
-    if (key) {
-    out[key] = normalizeValue(valueLines.join('\n'));
-    }
-    key = null;
-    valueLines = [];
   }
+  if (key) {
+    out[key] = normalizeValue(valueLines.join('\n'));
   }
-  if (key) out[key] = normalizeValue(valueLines.join('\n'));
   return out;
 }
 
 function parseInlineArray(str) {
   try {
-  const parsed = JSON.parse(str.replace(/'/g, '"'));
-  return Array.isArray(parsed) ? parsed : [String(parsed)];
+    const parsed = JSON.parse(str.replace(/'/g, '"'));
+    return Array.isArray(parsed) ? parsed : [String(parsed)];
   } catch (_) {
-  return [str];
+    return [str];
   }
 }
 
 function normalizeValue(value) {
-  if (value == null) return '';
-  const trimmed = String(value).trim().replace(/^['"]|['"]$/g, '');
+  if (value == null) {
+    return '';
+  }
+  const trimmed = String(value)
+    .trim()
+    .replace(/^['"]|['"]$/g, '');
   if (trimmed.includes('\n')) {
-  const list = trimmed.split(/\r?\n/).map(v => v.trim()).filter(Boolean);
-  return list.length > 0 ? list : trimmed;
+    const list = trimmed
+      .split(/\r?\n/)
+      .map((v) => v.trim())
+      .filter(Boolean);
+    return list.length > 0 ? list : trimmed;
   }
   return trimmed;
 }
 
 function toArray(value) {
-  if (Array.isArray(value)) return value;
-  if (!value) return [];
+  if (Array.isArray(value)) {
+    return value;
+  }
+  if (!value) {
+    return [];
+  }
   return [String(value)];
 }
 
@@ -132,69 +150,76 @@ function auditRecipe(filePath, content) {
   const hasCodeBlock = FENCED_CODE_RE.test(body);
 
   for (const field of REQUIRED_FIELDS) {
-  const value = fm[field];
-  if (!value || (Array.isArray(value) && value.length === 0)) {
-    issues.push(`缺少必填字段: ${field}`);
-  }
+    const value = fm[field];
+    if (!value || (Array.isArray(value) && value.length === 0)) {
+      issues.push(`缺少必填字段: ${field}`);
+    }
   }
 
   if (fm.trigger && !String(fm.trigger).startsWith('@')) {
-  issues.push('trigger 必须以 @ 开头');
+    issues.push('trigger 必须以 @ 开头');
   }
 
   if (fm.category && !CATEGORIES.has(String(fm.category))) {
-  issues.push(`category 非法: ${fm.category}`);
+    issues.push(`category 非法: ${fm.category}`);
   }
 
-  if (fm.language && !['swift', 'objectivec', 'markdown'].includes(String(fm.language).toLowerCase())) {
-  issues.push(`language 非法: ${fm.language}`);
+  if (
+    fm.language &&
+    !['swift', 'objectivec', 'markdown'].includes(String(fm.language).toLowerCase())
+  ) {
+    issues.push(`language 非法: ${fm.language}`);
   }
 
   const headers = toArray(fm.headers);
   if (headers.length > 0) {
-  const bad = headers.filter(h => !/^#import\s+<.+>$/.test(h) && !/^import\s+\w+/.test(h));
-  if (bad.length > 0) issues.push('headers 包含非完整 import 语句');
+    const bad = headers.filter((h) => !/^#import\s+<.+>$/.test(h) && !/^import\s+\w+/.test(h));
+    if (bad.length > 0) {
+      issues.push('headers 包含非完整 import 语句');
+    }
   }
 
-  if (!hasUsageHeading) issues.push('缺少 Usage Guide 标题');
+  if (!hasUsageHeading) {
+    issues.push('缺少 Usage Guide 标题');
+  }
   if (!hasSnippetHeading && hasCodeBlock) {
-  issues.push('存在代码块但缺少 Snippet 标题');
+    issues.push('存在代码块但缺少 Snippet 标题');
   }
 
   const introOnly = !hasCodeBlock;
 
   return {
-  filePath,
-  introOnly,
-  issues
+    filePath,
+    introOnly,
+    issues,
   };
 }
 
 function main() {
   const projectRoot = findProjectRoot(process.cwd());
   if (!projectRoot) {
-  console.error('未找到项目根（AutoSnippet/AutoSnippet.boxspec.json）。');
-  process.exit(1);
+    console.error('未找到项目根（AutoSnippet/AutoSnippet.boxspec.json）。');
+    process.exit(1);
   }
 
   const recipesDir = path.join(projectRoot, 'AutoSnippet', 'recipes');
   if (!fs.existsSync(recipesDir)) {
-  console.error(`未找到 recipes 目录: ${recipesDir}`);
-  process.exit(1);
+    console.error(`未找到 recipes 目录: ${recipesDir}`);
+    process.exit(1);
   }
 
   const files = readAllMarkdownFiles(recipesDir);
   const results = [];
   for (const file of files) {
-  const content = fs.readFileSync(file, 'utf-8');
-  results.push(auditRecipe(path.relative(projectRoot, file), content));
+    const content = fs.readFileSync(file, 'utf-8');
+    results.push(auditRecipe(path.relative(projectRoot, file), content));
   }
 
-  const withIssues = results.filter(r => r.issues.length > 0);
+  const withIssues = results.filter((r) => r.issues.length > 0);
   const summary = {
-  checked: results.length,
-  withIssues: withIssues.length,
-  introOnly: results.filter(r => r.introOnly).length
+    checked: results.length,
+    withIssues: withIssues.length,
+    introOnly: results.filter((r) => r.introOnly).length,
   };
 
   const report = { summary, results: withIssues };
@@ -203,25 +228,24 @@ function main() {
   fs.writeFileSync(path.join(reportDir, 'recipe-audit.json'), JSON.stringify(report, null, 2));
 
   const mdLines = [
-  '# Recipe 审计报告',
-  '',
-  `- 总数: ${summary.checked}`,
-  `- 有问题: ${summary.withIssues}`,
-  `- Intro-only: ${summary.introOnly}`,
-  '',
-  '## 需要处理的条目',
-  ''
+    '# Recipe 审计报告',
+    '',
+    `- 总数: ${summary.checked}`,
+    `- 有问题: ${summary.withIssues}`,
+    `- Intro-only: ${summary.introOnly}`,
+    '',
+    '## 需要处理的条目',
+    '',
   ];
 
   for (const item of withIssues) {
-  mdLines.push(`- ${item.filePath}`);
-  for (const issue of item.issues) {
-    mdLines.push(`  - ${issue}`);
-  }
+    mdLines.push(`- ${item.filePath}`);
+    for (const issue of item.issues) {
+      mdLines.push(`  - ${issue}`);
+    }
   }
 
   fs.writeFileSync(path.join(reportDir, 'recipe-audit.md'), mdLines.join('\n'));
-  console.log(`审计完成：${summary.checked} 条，问题 ${summary.withIssues} 条。报告已输出到 reports/recipe-audit.*`);
 }
 
 if (require.main === module) {