svharness 0.14.13 → 0.14.17

package/dist/lib/wiki/run-wiki-generation.js

@@ -0,0 +1,161 @@
+"use strict";
+/**
+ * Shared wiki generation logic used by both `svharness build` (Step 6b) and
+ * the standalone `svharness wiki` subcommand.
+ *
+ * This module is harness-agnostic: callers provide absolute paths for the
+ * source repo root and output directory. The `build` path copies baseline code
+ * first and outputs to `<harness>/baseline/wiki/`; the standalone `wiki` path
+ * scans source in-place and outputs to `./wiki/`.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runWikiGeneration = runWikiGeneration;
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const node_path_1 = __importDefault(require("node:path"));
+const wiki_1 = require("../../wiki");
+/**
+ * Guard that the source directory exists and is non-empty.
+ * Throws if the directory is missing or empty.
+ */
+async function assertSourceNotEmpty(repoRootFs) {
+    const exists = await fs_extra_1.default.pathExists(repoRootFs);
+    const entries = exists ? await fs_extra_1.default.readdir(repoRootFs) : [];
+    if (!exists || entries.length === 0) {
+        throw new Error(`Wiki 源码目录为空或不存在：${repoRootFs}。` +
+            '请检查 --wiki-source 路径或基线拷贝结果。');
+    }
+}
+/**
+ * Generate baseline wiki content.
+ *
+ * This function is non-fatal: on failure it returns `{ ok: false }` instead of
+ * throwing, allowing callers (build) to continue with a warning.
+ */
+async function runWikiGeneration(input) {
+    const { repoRootFs, wikiOutputRootFs, wikiRelPath, wikiLang, wikiModel, wikiBaseUrl, wikiApiKey, projectName, cliVersion, mode, cwd, forceFull, sourceRootRel, wikiAudience = 'human', onLog, onProgress, } = input;
+    const log = onLog ?? (() => { });
+    const progressCb = onProgress ??
+        ((p) => {
+            if (p.total > 0) {
+                log(`  [${p.done}/${p.total}] ${p.detail}`);
+            }
+            else {
+                log(`  ${p.detail}`);
+            }
+        });
+    const langFolder = wikiLang === 'en' ? 'en' : 'zh';
+    const langRun = (0, wiki_1.langRunForRepowikiTarget)(langFolder);
+    if (mode === 'full') {
+        // --- Full generation (runRepowikiIndex) ---
+        let fullOk = false;
+        try {
+            await assertSourceNotEmpty(repoRootFs);
+            const cfg = await (0, wiki_1.resolveWikiRunConfig)({
+                cwd: cwd ?? process.cwd(),
+                apiKey: wikiApiKey,
+                baseUrl: wikiBaseUrl,
+                model: wikiModel,
+            });
+            log(`  源码根：${repoRootFs}`);
+            log(`  输出到：${node_path_1.default.join(wikiOutputRootFs, wikiRelPath)}`);
+            log(`  语言：${langFolder} · 模型：${cfg.model}`);
+            await (0, wiki_1.runRepowikiIndex)({
+                repoRootFs,
+                wikiOutputRootFs,
+                wikiRelPath,
+                baseUrl: cfg.baseUrl,
+                apiKey: cfg.apiKey,
+                model: cfg.model,
+                languages: [langRun],
+                comprehensiveSections: true,
+                wikiAudience,
+                forceFull: !!forceFull,
+                onLog: log,
+                onProgress: progressCb,
+            });
+            fullOk = true;
+        }
+        catch (err) {
+            if ((0, wiki_1.isAbortError)(err)) {
+                log('wiki 生成被中断（已写出部分页可从 checkpoint 恢复）');
+            }
+            else {
+                log(`wiki 生成失败：${err.message}`);
+            }
+        }
+        if (fullOk) {
+            return { ok: true, mode: 'full', wikiPhase: 'done', wikiSource: undefined };
+        }
+        return {
+            ok: false,
+            mode: 'full',
+            wikiPhase: 'pending',
+            wikiSource: 'cli-full-degraded',
+        };
+    }
+    // --- Tasks-only mode (runRepowikiOutlineOnly + writeWikiTasks) ---
+    try {
+        await assertSourceNotEmpty(repoRootFs);
+        const cfg = await (0, wiki_1.resolveWikiRunConfig)({
+            cwd: cwd ?? process.cwd(),
+            apiKey: wikiApiKey,
+            baseUrl: wikiBaseUrl,
+            model: wikiModel,
+        });
+        log(`  源码根：${repoRootFs}`);
+        log(`  输出到：${node_path_1.default.join(wikiOutputRootFs, wikiRelPath)}`);
+        log(`  语言：${langFolder} · 模型：${cfg.model}`);
+        log('  模式：仅任务清单（tasks-only）');
+        const outline = await (0, wiki_1.runRepowikiOutlineOnly)({
+            repoRootFs,
+            wikiOutputRootFs,
+            wikiRelPath,
+            baseUrl: cfg.baseUrl,
+            apiKey: cfg.apiKey,
+            model: cfg.model,
+            languages: [langRun],
+            comprehensiveSections: true,
+            wikiAudience,
+            onLog: log,
+            onProgress: progressCb,
+        });
+        const resolvedSourceRootRel = sourceRootRel ??
+            (node_path_1.default.relative(wikiOutputRootFs, repoRootFs).replace(/\\/g, '/') || '.');
+        const tasksPath = await (0, wiki_1.writeWikiTasks)({
+            outline,
+            targetRoot: wikiOutputRootFs,
+            wikiRelPath,
+            projectName,
+            cliVersion,
+            model: cfg.model,
+            generatedAtIso: new Date().toISOString(),
+            sourceRootRel: resolvedSourceRootRel,
+            wikiAudience,
+        });
+        return {
+            ok: true,
+            mode: 'tasks',
+            wikiPhase: 'pending',
+            wikiSource: 'cli-tasks',
+            tasksPath,
+            pageCount: outline.pages.length,
+        };
+    }
+    catch (err) {
+        if ((0, wiki_1.isAbortError)(err)) {
+            log('wiki 任务清单生成被中断');
+        }
+        else {
+            log(`wiki 任务清单生成失败：${err.message}`);
+        }
+        return {
+            ok: false,
+            mode: 'tasks',
+            wikiPhase: 'pending',
+            wikiSource: 'cli-tasks',
+        };
+    }
+}

package/dist/lib/win-registry.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SHELL_MENU_LABEL = exports.SHELL_MENU_KEY_DIR = exports.SHELL_MENU_KEY_BG = void 0;
 exports.regSetDefault = regSetDefault;
+exports.regSetString = regSetString;
 exports.regDeleteKey = regDeleteKey;
 exports.regKeyExists = regKeyExists;
 const child_process_1 = require("child_process");
@@ -18,6 +19,15 @@ function regSetDefault(key, value) {
         windowsHide: true,
     });
 }
+/**
+ * Set a named REG_SZ value on a registry key.
+ */
+function regSetString(key, name, value) {
+    (0, child_process_1.execSync)(`"${REG}" add "${key}" /v "${name}" /t REG_SZ /d "${quoteRegData(value)}" /f`, {
+        stdio: 'pipe',
+        windowsHide: true,
+    });
+}
 /**
  * Delete a registry key and subkeys.
  */

package/dist/utils/validate-args.js

@@ -26,6 +26,7 @@ const SUPPORTED_AGENTS = [
     'cursor',
     'claude-code',
     'opencode',
+    'codex',
     'generic',
 ];
 const DEFAULT_BASELINE_MAX_FILE_KB = 1024;

package/dist/wiki/repowikiIndexer.js

@@ -49,11 +49,12 @@ const repowikiCheckpoint_1 = require("./repowikiCheckpoint");
 const repowikiGit_1 = require("./repowikiGit");
 const repowikiConfig_1 = require("./repowikiConfig");
 const repowikiStructureNav_1 = require("./repowikiStructureNav");
-const repowikiStructureNormalize_1 = require("./repowikiStructureNormalize");
+const repowikiPrompts_1 = require("./repowikiPrompts");
 const repowikiMarkdownPost_1 = require("./repowikiMarkdownPost");
 const repowikiMetadataContent_1 = require("./repowikiMetadataContent");
 const repowikiMetadataJson_1 = require("./repowikiMetadataJson");
 const wikiStructureXml_1 = require("./wikiStructureXml");
+const repowikiStructureNormalize_1 = require("./repowikiStructureNormalize");
 /** Canonical labels for outline + page generation (structure step uses `label`). */
 exports.REPOWIKI_LANG_EN = {
     folder: "en",
@@ -68,6 +69,9 @@ function langRunForRepowikiTarget(target) {
 }
 /** When `languages` is omitted, generate Simplified Chinese only. */
 const DEFAULT_LANGS = [exports.REPOWIKI_LANG_ZH];
+function resolveWikiAudience(audience) {
+    return audience ?? "human";
+}
 /** AbortSignal that never aborts — used as default when caller passes nothing. */
 const NEVER_ABORT = new AbortController().signal;
 async function chatCompletionTextForIndex(signal, params) {
@@ -111,134 +115,8 @@ async function pathExists(abs) {
         return false;
     }
 }
-function structurePrompt(repoName, treeText, readmeChunk, structureLang, comprehensive) {
-    const zhOutlineExtra = structureLang.folder === "zh"
-        ? `
-
-【简体中文硬性要求 — 纲要步骤】凡是给人看的文字（仓库级 <title>/ <description>、每个 <section> 的 <title>、每个 <page> 的 <title> 与 <description>）必须全部是简体中文（zh-CN）。禁止使用英文句子或段落；仅路径、文件名、代码标识符/API 符号可保留英文。`
-        : "";
-    const enOutlineExtra = structureLang.folder === "en"
-        ? `
-
-【English hard requirement — outline step】All human-readable text in this XML (repo-level <title>/<description>, each <section>'s <title>, each <page>'s <title> and <description>) MUST be fluent English. Do not write Chinese, Japanese, or other non-English prose for those fields. Only code identifiers, filenames, paths, API symbols, and unavoidable proper nouns may stay non-English where appropriate.`
-        : "";
-    const sectionBlock = comprehensive
-        ? `Use **multiple** top-level \`<section>\` blocks under \`<sections>\`: **between 2 and 7** (inclusive). **Never** return only **one** section when the wiki has **two or more** pages — split topics into **distinct** sections (do **not** collapse everything into a single bucket named after the wiki title).
-Use **at most 7** sections total. For very small repos with only **one** page, **one** section is acceptable.
-Each section MUST have a **unique** \`id\` attribute (letters, digits, hyphens only — stable identifier).
-Each section's \`<title>\` MUST be **in the outline language** (${structureLang.label}), **repo-specific**, and suitable as a section heading (this becomes the subdirectory name under each language folder).
-**Filesystem folders** under the language directory are derived from each section \`<title>\` (slugified), **not** from \`id\`.
-Distribute pages across sections: each section's \`<pages>\` lists \`<page_ref>\` ids; use **at most ${wikiStructureXml_1.REPOWIKI_MAX_PAGES}** pages **total** across all sections.
-
-Return ONLY valid XML in this shape:
-
-<wiki_structure>
-  <title>[Overall title]</title>
-  <description>[Brief]</description>
-  <sections>
-    <section id="getting-started">
-      <title>[Section title in outline language]</title>
-      <pages>
-        <page_ref>page-1</page_ref>
-      </pages>
-      <subsections/>
-    </section>
-    <!-- more sections with unique ids -->
-  </sections>
-  <pages>
-    <page id="page-1">
-      <title>[Title]</title>
-      <description>[What this covers]</description>
-      <importance>high</importance>
-      <relevant_files>
-        <file_path>[repo-relative/path]</file_path>
-      </relevant_files>
-      <related_pages/>
-      <parent_section>getting-started</parent_section>
-    </page>
-  </pages>
-</wiki_structure>`
-        : `<wiki_structure>
-  <title>[Overall title]</title>
-  <description>[Brief]</description>
-  <pages>
-    <page id="page-1">
-      <title>[Title]</title>
-      <description>[What]</description>
-      <importance>high</importance>
-      <relevant_files>
-        <file_path>[path]</file_path>
-      </relevant_files>
-      <related_pages/>
-    </page>
-  </pages>
-</wiki_structure>`;
-    return `Analyze the repository "${repoName}" and propose a concise developer wiki outline.
-
-<file_tree>
-${treeText}
-</file_tree>
-
-<readme_excerpt>
-${readmeChunk.slice(0, 12_000)}
-</readme_excerpt>
-
-Target language for human-readable titles/descriptions ONLY in this outline step: ${structureLang.label}.${zhOutlineExtra}${enOutlineExtra}
-
-${sectionBlock}
-
-Rules:
-- Produce **at most ${wikiStructureXml_1.REPOWIKI_MAX_PAGES}** wiki pages total with **stable** ids \`page-1\`, \`page-2\`, …, \`page-${wikiStructureXml_1.REPOWIKI_MAX_PAGES}\` (use consecutive ids; fewer pages is OK).
-${comprehensive ? `- Every \`<page>\` MUST include \`<parent_section>\` with the **exact** \`id\` of the section that owns this page (the section whose \`<page_ref>\` lists this page id).\n- Each page id must appear in exactly one section's \`page_ref\` list.` : `- Without a \`<sections>\` block, every page is stored under **one** folder derived from the wiki \`<title>\`; omit \`<parent_section>\` or ignore it for paths.`}
-${comprehensive ? `- Each section \`<title>\` becomes a subdirectory name (slugified); keep titles concise and filesystem-friendly where possible.` : `- The wiki \`<title>\` alone determines that single subdirectory name (slugified).`}
-- Ensure \`relevant_files\` cite real paths from file_tree where possible (skip generated/vendor dirs).
-${comprehensive ? `- CRITICAL: Every tag must be closed. After \`<sections>\`, you MUST include one final \`<pages>...</pages>\` block containing every full \`<page id="...">...</page>\` with title, description, parent_section, and relevant_files. Section-level \`<pages>\` may only list \`<page_ref>\` — never omit the outer \`<page>\` definitions.` : `- CRITICAL: Every tag must be closed. Include a \`<pages>\` block listing every full \`<page id="...">...</page>\` with title, description, and relevant_files.`}
-- Return ONLY XML. No markdown fences. No HTML. Start with <wiki_structure> end </wiki_structure>.`;
-}
-function pageMarkdownPrompt(langFolder, langDescriptor, pageTopic, ctx) {
-    const zhExtra = langFolder === "zh"
-        ? `
-
-【简体中文硬性要求 — 正文】全部正文、各级标题（# / ## / ###）、表格单元格、Mermaid 与其它图中的说明文字一律使用简体中文（zh-CN）。禁止英文句子，除非直接引用代码、路径、标识符或 API 名称。`
-        : "";
-    const enExtra = langFolder === "en"
-        ? `
-
-【English hard requirement — body】All prose, headings (# / ## / ###), table cell text, and explanatory labels inside Mermaid/diagrams MUST be English. Do not write Chinese prose (or mixed-language explanations) unless you are quoting literal content from repo files/strings. Preserve non-English only in fenced code excerpts, paths, identifiers, and API symbols as they appear in the repo.`
-        : "";
-    const h1Rule = langFolder === "zh"
-        ? `2. Start with '# [title]' (the H1 must match the topic; for a zh-CN wiki, use Simplified Chinese for that title line).`
-        : langFolder === "en"
-            ? `2. Start with '# [title]' (the H1 must match the topic in English prose).`
-            : `2. Start with '# [title]' (the H1 must match the topic).`;
-    return `You write accurate technical Markdown documentation for developers.
-
-Output language: ${langDescriptor}.${zhExtra}${enExtra}
-
-Repository context bundled as tagged files:
-
-${ctx}
-
-Write ONE wiki page for topic: "${pageTopic}".
-
-Strict rules:
-1. Ground claims only in supplied files.
-${h1Rule}
-3. After the introduction (first paragraph or short opener) and **before** the first \`##\`, add a concise **table of contents**: a bullet or numbered list of links to the \`##\` sections that follow (use markdown links with anchors, e.g. \`[Section](#section-slug)\`, matching your real headings). **Omit this TOC** if the page is very short or only has a single \`##\` section (avoid a redundant mini-TOC).
-4. Use '##','###', tables, fenced code from files when helpful.
-5. Prefer Mermaid with \`\`\`mermaid diagrams using TOP-DOWN flow (\`graph TD\`, not LR).
-6. Where useful cite repository files on one line: \`Sources: path/to/file:line-range\` (comma-separated if multiple). Paths are repo-relative with \`/\` separators.
-
-If bundled files lack coverage, acknowledge gaps briefly — do not invent APIs.`;
-}
-function pageGenerationSystemPrompt(langFolder) {
-    if (langFolder === "zh") {
-        return "你是技术文档撰写者，只根据提供的 <file path=…> 摘录作答。Wiki 页的各级标题、正文、表格文字、图中的文字说明必须全部是简体中文（zh-CN）。除代码摘录、仓库路径与标识符/API 英文名外禁止使用英文 prose。";
-    }
-    if (langFolder === "en") {
-        return "You are a technical writer. Answer ONLY from bundled <file path=…> excerpts. The entire Markdown page MUST be English: headings, body, table text, diagram labels/explanations. Use non-English prose only inside literal code fences or when verbatim-quoting user-facing strings from the repository; identifiers, paths, and API symbols follow the codebase.";
-    }
-    return "You write factual Markdown grounded strictly in bundled <file path=…> excerpts.";
+async function mkdirp(p) {
+    await fs.mkdir(p, { recursive: true });
 }
 function normalizeLeadingH1(md, canonicalTitle) {
     const t = canonicalTitle.trim();
@@ -255,9 +133,6 @@ function normalizeLeadingH1(md, canonicalTitle) {
     }
     return md;
 }
-async function mkdirp(p) {
-    await fs.mkdir(p, { recursive: true });
-}
 function bucketAndStemFromRel(relPosix) {
     const n = relPosix.replace(/\\/g, "/");
     const slash = n.lastIndexOf("/");
@@ -314,6 +189,7 @@ async function runRepowikiIndex(opts) {
     const readme = await (0, repowikiScanner_1.tryReadFirstReadme)(opts.repoRootFs);
     const structureLang = langs[0] ?? exports.REPOWIKI_LANG_ZH;
     const langFolders = langs.map((l) => l.folder);
+    const wikiAudience = resolveWikiAudience(opts.wikiAudience);
     let existingCp = forceFull ? null : await (0, repowikiCheckpoint_1.readRepowikiCheckpoint)(wikiBase);
     if (forceFull && existingCp) {
         await (0, repowikiCheckpoint_1.clearRepowikiCheckpoint)(wikiBase);
@@ -364,11 +240,7 @@ async function runRepowikiIndex(opts) {
     if (!resumed) {
         report?.({ done: 0, total: 0, detail: "Requesting wiki outline from model…" });
         log("[repowiki] Requesting wiki structure…");
-        const structureSystem = structureLang.folder === "zh"
-            ? "你只输出格式正确的 wiki_structure XML（符合用户给定模板）；不要使用 markdown 代码围栏。纲要中凡是给人阅读的标题与描述必须使用简体中文（zh-CN）。"
-            : structureLang.folder === "en"
-                ? "You output ONLY well-formed wiki_structure XML matching the user's template. Never use markdown fences. Every repo title, wiki title/description, section titles, page titles, and page descriptions meant for humans must be fluent English (no Chinese prose in those strings unless it is unavoidable quoted content from the repository)."
-                : "You output ONLY well-formed wiki_structure XML matching the user's template. Never use markdown fences.";
+        const structureSystem = (0, repowikiPrompts_1.structureSystemPrompt)(wikiAudience, structureLang.folder);
         const comprehensive = opts.comprehensiveSections ?? false;
         let structureRaw = await chatCompletionTextForIndex(signal, {
             baseUrl: opts.baseUrl,
@@ -379,7 +251,7 @@ async function runRepowikiIndex(opts) {
                 { role: "system", content: structureSystem },
                 {
                     role: "user",
-                    content: structurePrompt(repoName, treeText, readme, structureLang, comprehensive),
+                    content: (0, repowikiPrompts_1.structurePrompt)(wikiAudience, repoName, treeText, readme, structureLang, comprehensive),
                 },
             ],
         });
@@ -407,8 +279,8 @@ async function runRepowikiIndex(opts) {
                     { role: "system", content: structureSystem },
                     {
                         role: "user",
-                        content: structurePrompt(repoName, treeText, readme, structureLang, comprehensive) +
-                            (0, repowikiStructureNormalize_1.structureRepairUserAppendix)(structureRaw, structureLang.folder),
+                        content: (0, repowikiPrompts_1.structurePrompt)(wikiAudience, repoName, treeText, readme, structureLang, comprehensive) +
+                            (0, repowikiStructureNormalize_1.structureRepairUserAppendix)(structureRaw, structureLang.folder, wikiAudience),
                     },
                 ],
             });
@@ -586,10 +458,10 @@ async function runRepowikiIndex(opts) {
                 model: opts.model,
                 temperature: 0.25,
                 messages: [
-                    { role: "system", content: pageGenerationSystemPrompt(lg.folder) },
+                    { role: "system", content: (0, repowikiPrompts_1.pageGenerationSystemPrompt)(wikiAudience, lg.folder) },
                     {
                         role: "user",
-                        content: pageMarkdownPrompt(lg.folder, lg.label, `${page.title}\n\n${page.description}`, ctxBundle),
+                        content: (0, repowikiPrompts_1.pageMarkdownPrompt)(wikiAudience, lg.folder, lg.label, `${page.title}\n\n${page.description}`, ctxBundle),
                     },
                 ],
             });
@@ -706,13 +578,10 @@ async function runRepowikiOutlineOnly(opts) {
     const treeText = (0, repowikiScanner_1.summarizeTreeLines)(fileList, 260);
     const readme = await (0, repowikiScanner_1.tryReadFirstReadme)(opts.repoRootFs);
     const structureLang = langs[0] ?? exports.REPOWIKI_LANG_ZH;
+    const wikiAudience = resolveWikiAudience(opts.wikiAudience);
     report?.({ done: 0, total: 0, detail: "Requesting wiki outline from model…" });
     log("[repowiki] Requesting wiki structure…");
-    const structureSystem = structureLang.folder === "zh"
-        ? "你只输出格式正确的 wiki_structure XML（符合用户给定模板）；不要使用 markdown 代码围栏。纲要中凡是给人阅读的标题与描述必须使用简体中文（zh-CN）。"
-        : structureLang.folder === "en"
-            ? "You output ONLY well-formed wiki_structure XML matching the user's template. Never use markdown fences. Every repo title, wiki title/description, section titles, page titles, and page descriptions meant for humans must be fluent English (no Chinese prose in those strings unless it is unavoidable quoted content from the repository)."
-            : "You output ONLY well-formed wiki_structure XML matching the user's template. Never use markdown fences.";
+    const structureSystem = (0, repowikiPrompts_1.structureSystemPrompt)(wikiAudience, structureLang.folder);
     const comprehensive = opts.comprehensiveSections ?? false;
     let structureRaw = await chatCompletionTextForIndex(signal, {
         baseUrl: opts.baseUrl,
@@ -723,7 +592,7 @@ async function runRepowikiOutlineOnly(opts) {
             { role: "system", content: structureSystem },
             {
                 role: "user",
-                content: structurePrompt(repoName, treeText, readme, structureLang, comprehensive),
+                content: (0, repowikiPrompts_1.structurePrompt)(wikiAudience, repoName, treeText, readme, structureLang, comprehensive),
             },
         ],
     });
@@ -751,8 +620,8 @@ async function runRepowikiOutlineOnly(opts) {
                 { role: "system", content: structureSystem },
                 {
                     role: "user",
-                    content: structurePrompt(repoName, treeText, readme, structureLang, comprehensive) +
-                        (0, repowikiStructureNormalize_1.structureRepairUserAppendix)(structureRaw, structureLang.folder),
+                    content: (0, repowikiPrompts_1.structurePrompt)(wikiAudience, repoName, treeText, readme, structureLang, comprehensive) +
+                        (0, repowikiStructureNormalize_1.structureRepairUserAppendix)(structureRaw, structureLang.folder, wikiAudience),
                 },
             ],
         });