@gordon.gan/specflow 1.4.6-beta → 1.7.0-beta

package/dist/core/approval/bundle.js

@@ -0,0 +1,172 @@
+import { createHash } from 'node:crypto';
+import { promises as fs } from 'node:fs';
+import { join, dirname } from 'node:path';
+import yaml from 'js-yaml';
+import { parseApprovalPlaybook } from './playbook-schema.js';
+import { readApprovalIndex } from './assemble.js';
+import { getApprovalPartPath, getApprovalWorkspaceDir, getChangeDirectory, } from './paths.js';
+function sha256(content) {
+    return createHash('sha256').update(content, 'utf8').digest('hex');
+}
+function resolveSourceChangeDir(workspaceRoot, source) {
+    const planningRoot = source.root ?? workspaceRoot;
+    return getChangeDirectory(planningRoot, source.change);
+}
+async function loadSourceParts(changeDir, includeParts) {
+    const index = await readApprovalIndex(changeDir);
+    const partIds = includeParts === 'all'
+        ? [...index.parts_order]
+        : includeParts.filter((id) => index.parts_order.includes(id));
+    const results = [];
+    for (const partId of partIds) {
+        try {
+            const content = await fs.readFile(getApprovalPartPath(changeDir, partId), 'utf-8');
+            results.push({ partId, content });
+        }
+        catch {
+            // skip missing
+        }
+    }
+    return results;
+}
+export async function bundleApprovalDocument(options) {
+    const diagnostics = [];
+    const { workspaceRoot, changeDir, playbookPath, write = true } = options;
+    let playbook;
+    let indexOutputOverride;
+    try {
+        const raw = yaml.load(await fs.readFile(playbookPath, 'utf-8'));
+        playbook = parseApprovalPlaybook(raw);
+        try {
+            const index = await readApprovalIndex(changeDir);
+            indexOutputOverride = index.multi_repo?.bundle?.output;
+        }
+        catch {
+            // index optional for bundle-only dry runs
+        }
+    }
+    catch (error) {
+        const message = error instanceof Error ? error.message : String(error);
+        return {
+            ok: false,
+            diagnostics: [
+                { code: 'invalid_playbook', severity: 'error', message: `Invalid playbook: ${message}` },
+            ],
+        };
+    }
+    const body = [];
+    body.push(`# ${playbook.title}`);
+    body.push('');
+    body.push(`> **合订视图** (read-only bundle) | change: \`${playbook.change}\``);
+    body.push(`> 生成方式: \`specflow approval bundle\` — 确定性拼接，禁止 LLM Reduce`);
+    body.push(`> 主仓: \`${playbook.primary_repo}\``);
+    body.push('');
+    body.push('---');
+    body.push('');
+    if (playbook.overlay && playbook.overlay.length > 0) {
+        const approvalDir = getApprovalWorkspaceDir(changeDir);
+        for (const overlayRel of playbook.overlay) {
+            const overlayPath = join(approvalDir, overlayRel);
+            try {
+                const content = await fs.readFile(overlayPath, 'utf-8');
+                if (playbook.assemble.inject_headers !== false) {
+                    body.push(`## Overlay · ${overlayRel}`);
+                    body.push('');
+                }
+                body.push(content.trim());
+                body.push('');
+                body.push('---');
+                body.push('');
+            }
+            catch {
+                diagnostics.push({
+                    code: 'overlay_missing',
+                    severity: 'error',
+                    message: `Overlay file not found: ${overlayPath}`,
+                });
+            }
+        }
+    }
+    for (const source of playbook.sources) {
+        const sourceChangeDir = resolveSourceChangeDir(workspaceRoot, source);
+        try {
+            await fs.access(sourceChangeDir);
+        }
+        catch {
+            diagnostics.push({
+                code: 'source_change_missing',
+                severity: 'error',
+                message: `Source change not found: ${sourceChangeDir} (repo=${source.repo})`,
+            });
+            continue;
+        }
+        const includeParts = source.include_parts ?? 'all';
+        const parts = await loadSourceParts(sourceChangeDir, includeParts);
+        if (parts.length === 0) {
+            diagnostics.push({
+                code: 'source_parts_empty',
+                severity: 'warning',
+                message: `No parts loaded for source ${source.repo}/${source.change}`,
+            });
+        }
+        if (playbook.assemble.inject_headers !== false) {
+            body.push(`## 来源 · ${source.repo} (\`${source.change}\`)`);
+            body.push('');
+        }
+        for (const { partId, content } of parts) {
+            body.push(`<!-- bundle-source: ${source.repo}/${source.change}/${partId} -->`);
+            body.push(content.trim());
+            body.push('');
+        }
+        body.push('---');
+        body.push('');
+    }
+    if (diagnostics.some((d) => d.severity === 'error')) {
+        return { ok: false, diagnostics };
+    }
+    let markdown = body.join('\n').replace(/\n{3,}/g, '\n\n').trim() + '\n';
+    if (playbook.assemble.dedupe_appendix !== false) {
+        const appendixMatches = markdown.match(/^##\s+附录\s*A/mg);
+        if (appendixMatches && appendixMatches.length > 1) {
+            diagnostics.push({
+                code: 'duplicate_appendix',
+                severity: 'warning',
+                message: `Bundle output contains ${appendixMatches.length} "## 附录 A" headings`,
+            });
+        }
+    }
+    if (playbook.assemble.readonly) {
+        markdown =
+            `> **READ-ONLY VIEW** — apply 请使用各仓 \`approval.md\` 真源，勿直接消费本合订文件。\n\n` +
+                markdown;
+    }
+    const outputRel = indexOutputOverride ?? playbook.assemble.output;
+    const outputPath = join(changeDir, outputRel);
+    if (!write) {
+        return { ok: true, markdown, outputPath, diagnostics };
+    }
+    await fs.mkdir(dirname(outputPath), { recursive: true });
+    await fs.writeFile(outputPath, markdown, 'utf-8');
+    const bundleManifestPath = join(getApprovalWorkspaceDir(changeDir), 'bundle-manifest.json');
+    await fs.writeFile(bundleManifestPath, JSON.stringify({
+        schema: 'specflow.approval.bundle-manifest/v1',
+        change: playbook.change,
+        playbook: playbookPath,
+        output: outputRel,
+        sha256: sha256(markdown),
+        assembled_at: new Date().toISOString(),
+        sources: playbook.sources.map((s) => ({ repo: s.repo, change: s.change })),
+    }, null, 2), 'utf-8');
+    return { ok: true, markdown, outputPath, diagnostics };
+}
+export async function resolvePlaybookPath(changeDir, explicitPath) {
+    if (explicitPath) {
+        return explicitPath;
+    }
+    const index = await readApprovalIndex(changeDir);
+    const fromIndex = index.multi_repo?.bundle?.playbook;
+    if (fromIndex) {
+        return join(getApprovalWorkspaceDir(changeDir), fromIndex);
+    }
+    return join(getApprovalWorkspaceDir(changeDir), 'approval-playbook.yaml');
+}

package/dist/core/approval/forbidden-patterns.d.ts

@@ -0,0 +1,6 @@
+/** Shared stub / inconsistency patterns for assemble lazy-check and approval lint. */
+export declare const FORBIDDEN_STUB_PATTERNS: readonly RegExp[];
+/** Semantic inconsistency hints (warnings unless strict mode) — long-document generic. */
+export declare const INCONSISTENCY_HINT_PATTERNS: readonly RegExp[];
+export declare function findForbiddenMatch(content: string): RegExp | null;
+export declare function findInconsistencyHints(content: string): readonly RegExp[];

package/dist/core/approval/forbidden-patterns.js

@@ -0,0 +1,37 @@
+/** Shared stub / inconsistency patterns for assemble lazy-check and approval lint. */
+export const FORBIDDEN_STUB_PATTERNS = [
+    /\bTODO\b/i,
+    /待补充/,
+    /待 refine 澄清(?!.*\[)/,
+    /此处省略/,
+    /详见\s*(?:上文|下文|附件)(?!.*§)/,
+    /略\s*[。.]?$/,
+    /TBD\s*[。.]?$/,
+    /(?:^|\n)\s*\.{3}\s*(?:\n|$)/,
+    /(?:^|\n)\s*(?:同上|同前)\s*[。.]?\s*(?:\n|$)/,
+    /实现时(?:命名|对齐)/,
+    /(?:RPC|rpc).*暂定/,
+    /暂定\s*[`']?\w+[`']?/,
+    /\b如\s+[A-Z]\w*(?:Result|Request|Response)/,
+    /内部(?:经|调用)\s*I\d+[^.\n]{0,40}(?:一行|代替|省略)/,
+];
+/** Semantic inconsistency hints (warnings unless strict mode) — long-document generic. */
+export const INCONSISTENCY_HINT_PATTERNS = [
+    /约\s*\d+\s*次/,
+    /\b(?:等|etc\.?)\s*[。.)]/,
+    /(?:status|状态|enum|枚举)[^.\n]{0,30}(?:等|etc)/i,
+    /\b(?:TBD|待定|未定)\b/i,
+    /(?:同上|同前|见上)(?!.*§)/,
+    /\d+\s*[或\\/]\s*\d+\s*(?:均可|都行)/,
+];
+export function findForbiddenMatch(content) {
+    for (const pattern of FORBIDDEN_STUB_PATTERNS) {
+        if (pattern.test(content)) {
+            return pattern;
+        }
+    }
+    return null;
+}
+export function findInconsistencyHints(content) {
+    return INCONSISTENCY_HINT_PATTERNS.filter((p) => p.test(content));
+}