autosnippet
Version:
Extract code patterns into a knowledge base for AI coding assistants
254 lines (253 loc) • 9.35 kB
JavaScript
/**
* RecipeParser — Recipe Markdown 解析器
* 从完整 Recipe MD 提取结构化数据
*/
import fs from 'node:fs';
import path from 'node:path';
import { LanguageService } from '../../shared/LanguageService.js';
const FRONTMATTER_RE = /^---\n([\s\S]*?)\n---/;
const _SNIPPET_HEADING_RE = /^##\s+(?:Snippet|Code|代码)/im;
const USAGE_HEADING_RE = /^##\s+(?:Usage\s*Guide|用法|使用指南)/im;
const FENCED_CODE_RE = /```(\w*)\n([\s\S]*?)```/;
export class RecipeParser {
/**
* 检查文本是否为完整 Recipe MD
* 需包含: frontmatter + 代码块 + Usage Guide
*/
isCompleteRecipe(text) {
if (!text) {
return false;
}
return FRONTMATTER_RE.test(text) && FENCED_CODE_RE.test(text) && USAGE_HEADING_RE.test(text);
}
/** 检查是否为「仅介绍」Recipe（有 frontmatter 但无代码块） */
isIntroOnly(text) {
if (!text) {
return false;
}
return FRONTMATTER_RE.test(text) && !FENCED_CODE_RE.test(text);
}
/** 解析完整 Recipe MD 为结构化对象 */
parse(text) {
if (!text) {
return null;
}
const frontmatter = this.parseFrontmatter(text);
const body = text.replace(FRONTMATTER_RE, '').trim();
// 提取代码块
const codeBlocks = [];
let match;
const codeRe = /```(\w*)\n([\s\S]*?)```/g;
while ((match = codeRe.exec(body)) !== null) {
codeBlocks.push({ language: match[1] || 'text', code: match[2].trim() });
}
// 提取 Usage Guide
const usageMatch = body.match(USAGE_HEADING_RE);
let usageGuide = '';
if (usageMatch && usageMatch.index !== undefined) {
const usageStart = usageMatch.index + usageMatch[0].length;
const nextHeading = body.slice(usageStart).search(/^##\s+/m);
usageGuide =
nextHeading > 0
? body.slice(usageStart, usageStart + nextHeading).trim()
: body.slice(usageStart).trim();
}
// 提取标题
const titleMatch = body.match(/^#\s+(.+)/m);
const title = frontmatter.title || (titleMatch ? titleMatch[1].trim() : '');
// 提取 headers
const headers = this.#extractHeaders(body);
return {
title,
summary: frontmatter.summary || frontmatter.description || '',
description: frontmatter.description || frontmatter.summary || '',
trigger: frontmatter.trigger || this.#generateTrigger(title),
category: frontmatter.category || 'general',
language: frontmatter.language ||
(codeBlocks[0]?.language !== 'text' ? codeBlocks[0]?.language : 'swift'),
code: codeBlocks.map((b) => b.code).join('\n\n'),
codeBlocks,
usageGuide,
headers,
includeHeaders: headers.length > 0,
frontmatter,
};
}
/** 从文本中解析多段 Recipe（按 `---` 分隔） */
parseAll(text) {
if (!text) {
return [];
}
const segments = text.split(/\n---\n/).filter((s) => s.trim().length > 0);
return segments.map((s) => this.parse(s)).filter((r) => r !== null);
}
/** 解析 frontmatter YAML */
parseFrontmatter(text) {
const match = text.match(FRONTMATTER_RE);
if (!match) {
return {};
}
const fm = {};
for (const line of match[1].split('\n')) {
const colonIdx = line.indexOf(':');
if (colonIdx > 0) {
const key = line.slice(0, colonIdx).trim();
let value = line.slice(colonIdx + 1).trim();
if (typeof value === 'string' && value.startsWith('[') && value.endsWith(']')) {
value = value
.slice(1, -1)
.split(',')
.map((s) => s.trim().replace(/^['"]|['"]$/g, ''));
}
else if (value === 'true') {
value = true;
}
else if (value === 'false') {
value = false;
}
else if (typeof value === 'string' && /^\d+$/.test(value)) {
value = parseInt(value, 10);
}
else if (typeof value === 'string') {
value = value.replace(/^['"]|['"]$/g, '');
}
fm[key] = value;
}
}
return fm;
}
/** 从内容提取 trigger */
getTrigger(text) {
const fm = this.parseFrontmatter(text);
return fm.trigger || '';
}
/**
* 从文件路径读取并提取 Recipe 候选
* @param relativePath 相对路径
* @param [opts.projectRoot] 项目根目录
* @returns >}
*/
async extractFromPath(relativePath, opts = {}) {
const projectRoot = opts.projectRoot || process.cwd();
const fullPath = path.isAbsolute(relativePath)
? relativePath
: path.resolve(projectRoot, relativePath);
if (!fs.existsSync(fullPath)) {
throw new Error(`文件不存在: ${fullPath}`);
}
const content = fs.readFileSync(fullPath, 'utf8');
const ext = path.extname(fullPath).toLowerCase();
const language = LanguageService.langFromExt(ext);
// 尝试解析为完整 Recipe Markdown
if (this.isCompleteRecipe(content)) {
const parsed = this.parse(content);
if (parsed) {
return { items: [parsed], isMarked: false };
}
}
// 尝试多段解析
const allRecipes = this.parseAll(content);
if (allRecipes.length > 0) {
return { items: allRecipes, isMarked: false };
}
// 回退: 将整个文件内容作为代码片段
const title = path.basename(fullPath, ext);
return {
items: [
{
title,
summary: '',
description: '',
trigger: this.#generateTrigger(title),
category: 'Utility',
language,
code: content,
codeBlocks: [{ language, code: content }],
usageGuide: '',
headers: this.#extractHeaders(content),
includeHeaders: false,
frontmatter: {},
},
],
isMarked: false,
};
}
/** 从文本解析 Recipe（优先完整 Markdown 格式） */
async parseFromText(text, opts = {}) {
if (!text || text.trim().length === 0) {
throw new Error('文本内容为空');
}
// 尝试完整 Recipe 解析
if (this.isCompleteRecipe(text)) {
const parsed = this.parse(text);
if (parsed) {
return parsed;
}
}
// 尝试批量解析
const all = this.parseAll(text);
if (all.length > 0) {
return all;
}
throw new Error('文本不是有效的 Recipe Markdown 格式');
}
/** 从文本提取代码片段（兜底方法，不要求 Markdown 格式） */
async extractFromText(text, opts = {}) {
if (!text || text.trim().length === 0) {
throw new Error('文本内容为空');
}
const language = opts.language || 'unknown';
// 先尝试标准解析
try {
const result = await this.parseFromText(text, opts);
return result;
}
catch {
/* 继续兜底逻辑 */
}
// 提取代码块
const codeBlocks = [];
const codeRe = /```(\w*)\n([\s\S]*?)```/g;
let match;
while ((match = codeRe.exec(text)) !== null) {
codeBlocks.push({ language: match[1] || language, code: match[2].trim() });
}
const code = codeBlocks.length > 0 ? codeBlocks.map((b) => b.code).join('\n\n') : text.trim();
// 简单标题推断
const titleLine = text.split('\n').find((l) => l.trim().startsWith('#'));
const title = titleLine ? titleLine.replace(/^#+\s*/, '').trim() : 'Untitled Snippet';
return {
title,
summary: '',
description: '',
trigger: this.#generateTrigger(title),
category: 'Utility',
language,
code,
codeBlocks: codeBlocks.length > 0 ? codeBlocks : [{ language, code }],
usageGuide: '',
headers: this.#extractHeaders(code),
includeHeaders: false,
frontmatter: {},
};
}
#extractHeaders(body) {
const headers = [];
const re = /#import\s+[<"]([^>"]+)[>"]/g;
let match;
while ((match = re.exec(body)) !== null) {
headers.push(match[1]);
}
return headers;
}
#generateTrigger(title) {
if (!title) {
return '';
}
return title
.toLowerCase()
.replace(/[^a-z0-9]+/g, '_')
.replace(/(^_|_$)/g, '')
.slice(0, 30);
}
}