xtep-workspace 1.10.10

package/dist/storage/MarkdownStorage.d.ts

@@ -0,0 +1,178 @@
+import type { FileSystemAdapter } from "./FileSystemAdapter.js";
+import type { WorkspaceMdData, LogEntry, ProblemData, DocRef } from "../types/workspace.js";
+import type { NodeInfoData, NodeStatus } from "../types/node.js";
+import type { TypedLogEntry } from "../types/context.js";
+/**
+ * 解析后的 Markdown 数据
+ */
+interface ParsedMarkdown {
+    frontmatter: Record<string, unknown>;
+    content: string;
+}
+/**
+ * Markdown 存储封装
+ * 提供 Markdown 文件的读写和 frontmatter 解析
+ */
+export declare class MarkdownStorage {
+    private fs;
+    constructor(fs: FileSystemAdapter);
+    /**
+     * 解析 Markdown 内容（提取 frontmatter 和正文）
+     * 增强健壮性：处理各种边界情况和格式变体
+     */
+    parse(content: string): ParsedMarkdown;
+    /**
+     * 安全地提取 section 内容
+     * @param content Markdown 内容
+     * @param sectionName section 名称（不含 ##）
+     * @param isLast 是否是最后一个 section（不需要后续 section 作为结束标记）
+     * @returns 提取的内容，如果未找到返回空字符串
+     */
+    private extractSection;
+    /**
+     * 安全解析列表项
+     * @param content section 内容
+     * @returns 列表项数组
+     */
+    private parseListItems;
+    /**
+     * 序列化 Markdown 数据
+     */
+    serialize(data: ParsedMarkdown): string;
+    /**
+     * 读取 Workspace.md
+     * @param isArchived 是否为归档工作区
+     */
+    readWorkspaceMd(projectRoot: string, workspaceId: string, isArchived?: boolean): Promise<WorkspaceMdData>;
+    /**
+     * 读取旧版 Workspace.md 中的 goal（仅用于懒迁移）
+     * 新版工作区 goal 存储在根节点 requirement 中
+     * @returns goal 内容，如果不存在或为空返回 null
+     */
+    readLegacyGoal(projectRoot: string, workspaceId: string, isArchived?: boolean): Promise<string | null>;
+    /**
+     * 写入 Workspace.md
+     */
+    writeWorkspaceMd(projectRoot: string, workspaceId: string, data: WorkspaceMdData): Promise<void>;
+    /**
+     * 读取节点 Info.md
+     * @param wsDirName 工作区目录名（非 workspaceId，需通过 graph 解析）
+     * @param nodeDirName 节点目录名（非 nodeId，需通过 graph.nodes[nodeId].dirName 获取）
+     * @param isArchived 是否为归档工作区
+     */
+    readNodeInfo(projectRoot: string, wsDirName: string, nodeDirName: string, isArchived?: boolean): Promise<NodeInfoData>;
+    /**
+     * 写入节点 Info.md
+     * @param wsDirName 工作区目录名（非 workspaceId）
+     * @param nodeDirName 节点目录名（非 nodeId）
+     */
+    writeNodeInfo(projectRoot: string, wsDirName: string, nodeDirName: string, data: NodeInfoData): Promise<void>;
+    /**
+     * 读取日志
+     * 增强健壮性：处理各种表格格式变体
+     */
+    readLog(projectRoot: string, workspaceId: string, nodeId?: string): Promise<LogEntry[]>;
+    /**
+     * 安全解析日志表格
+     * @param content 日志内容
+     * @returns 解析后的日志条目
+     */
+    private parseLogTableSafe;
+    /**
+     * 获取日志文件路径（支持归档目录）
+     */
+    private getLogPath;
+    /**
+     * 追加日志
+     * @param isArchived 是否写入归档目录（当 nodeId 为 true 时表示 isArchived）
+     */
+    appendLog(projectRoot: string, workspaceId: string, entry: LogEntry, nodeIdOrIsArchived?: string | boolean, isArchived?: boolean): Promise<void>;
+    /**
+     * 创建空的日志文件
+     */
+    createEmptyLog(projectRoot: string, workspaceId: string, nodeId?: string): Promise<void>;
+    /**
+     * 读取问题
+     * @param isArchived 是否为归档工作区
+     */
+    readProblem(projectRoot: string, workspaceId: string, nodeId?: string, isArchived?: boolean): Promise<ProblemData>;
+    /**
+     * 写入问题
+     */
+    writeProblem(projectRoot: string, workspaceId: string, data: ProblemData, nodeId?: string): Promise<void>;
+    /**
+     * 创建空的问题文件
+     */
+    createEmptyProblem(projectRoot: string, workspaceId: string, nodeId?: string): Promise<void>;
+    /**
+     * 读取 Workspace.md 原始内容
+     * @param isArchived 是否为归档工作区
+     */
+    readWorkspaceMdRaw(projectRoot: string, workspaceId: string, isArchived?: boolean): Promise<string>;
+    /**
+     * 读取节点 Info.md 原始内容
+     * @param wsDirName 工作区目录名（非 workspaceId）
+     * @param nodeDirName 节点目录名（非 nodeId）
+     * @param isArchived 是否为归档工作区
+     */
+    readNodeInfoRaw(projectRoot: string, wsDirName: string, nodeDirName: string, isArchived?: boolean): Promise<string>;
+    /**
+     * 读取日志原始内容
+     */
+    readLogRaw(projectRoot: string, workspaceId: string, nodeId?: string, isArchived?: boolean): Promise<string>;
+    /**
+     * 读取问题原始内容
+     */
+    readProblemRaw(projectRoot: string, workspaceId: string, nodeId?: string, isArchived?: boolean): Promise<string>;
+    /**
+     * 解析日志表格（返回带类型的日志条目）
+     * 增强健壮性：处理各种表格格式变体
+     */
+    parseLogTable(content: string): TypedLogEntry[];
+    /**
+     * 追加带类型的日志条目
+     */
+    appendTypedLogEntry(projectRoot: string, workspaceId: string, entry: TypedLogEntry, nodeId?: string): Promise<void>;
+    /**
+     * 解析文档引用
+     * 格式：- [文件名](路径) - 说明
+     * 向后兼容：忽略旧数据中的 (active)/(expired) 状态
+     */
+    parseDocs(content: string): DocRef[];
+    /**
+     * 序列化文档引用
+     */
+    serializeDoc(doc: DocRef): string;
+    /**
+     * 更新 Info.md 的结论部分
+     * @param wsDirName 工作区目录名（非 workspaceId）
+     * @param nodeDirName 节点目录名（非 nodeId）
+     */
+    updateConclusion(projectRoot: string, wsDirName: string, nodeDirName: string, conclusion: string): Promise<void>;
+    /**
+     * 更新 Info.md 的状态
+     * @param wsDirName 工作区目录名（非 workspaceId）
+     * @param nodeDirName 节点目录名（非 nodeId）
+     */
+    updateNodeStatus(projectRoot: string, wsDirName: string, nodeDirName: string, status: NodeStatus): Promise<void>;
+    /**
+     * 读取节点 Info.md（包含文档引用）
+     * @param wsDirName 工作区目录名（非 workspaceId）
+     * @param nodeDirName 节点目录名（非 nodeId）
+     * @param isArchived 是否为归档工作区
+     */
+    readNodeInfoFull(projectRoot: string, wsDirName: string, nodeDirName: string, isArchived?: boolean): Promise<NodeInfoData>;
+    /**
+     * 读取 Workspace.md（包含文档引用）
+     * @param isArchived 是否为归档工作区
+     */
+    readWorkspaceMdFull(projectRoot: string, workspaceId: string, isArchived?: boolean): Promise<WorkspaceMdData>;
+    /**
+     * 写入节点 Info.md（完整版本，用于服务层）
+     * @param wsDirName 工作区目录名（非 workspaceId）
+     * @param nodeDirName 节点目录名（非 nodeId）
+     */
+    writeNodeInfoFull(projectRoot: string, wsDirName: string, nodeDirName: string, data: NodeInfoData): Promise<void>;
+}
+export {};
+//# sourceMappingURL=MarkdownStorage.d.ts.map

package/dist/storage/MarkdownStorage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MarkdownStorage.d.ts","sourceRoot":"","sources":["../../src/storage/MarkdownStorage.ts"],"names":[],"mappings":"AAmBA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,KAAK,EAAE,eAAe,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAC5F,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAgC,MAAM,kBAAkB,CAAC;AAC/F,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAUzD;;GAEG;AACH,UAAU,cAAc;IACtB,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACrC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,qBAAa,eAAe;IACd,OAAO,CAAC,EAAE;gBAAF,EAAE,EAAE,iBAAiB;IAIzC;;;OAGG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,cAAc;IA2DtC;;;;;;OAMG;IACH,OAAO,CAAC,cAAc;IAetB;;;;OAIG;IACH,OAAO,CAAC,cAAc;IAStB;;OAEG;IACH,SAAS,CAAC,IAAI,EAAE,cAAc,GAAG,MAAM;IAWvC;;;OAGG;IACG,eAAe,CAAC,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,UAAU,UAAQ,GAAG,OAAO,CAAC,eAAe,CAAC;IAkD7G;;;;OAIG;IACG,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,UAAU,UAAQ,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAsB1G;;OAEG;IACG,gBAAgB,CAAC,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IA0CtG;;;;;OAKG;IACG,YAAY,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,UAAU,GAAE,OAAe,GAAG,OAAO,CAAC,YAAY,CAAC;IAiFnI;;;;OAIG;IACG,aAAa,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IA0EnH;;;OAGG;IACG,OAAO,CAAC,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAkB7F;;;;OAIG;IACH,OAAO,CAAC,iBAAiB;IAiCzB;;OAEG;IACH,OAAO,CAAC,UAAU;IAWlB;;;OAGG;IACG,SAAS,CAAC,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,kBAAkB,CAAC,EAAE,MAAM,GAAG,OAAO,EAAE,UAAU,UAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IA+BpJ;;OAEG;IACG,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAgB9F;;;OAGG;IACG,WAAW,CAAC,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,UAAU,GAAE,OAAe,GAAG,OAAO,CAAC,WAAW,CAAC;IAiC/H;;OAEG;IACG,YAAY,CAAC,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAyB/G;;OAEG;IACG,kBAAkB,CAAC,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IASlG;;;OAGG;IACG,kBAAkB,CAAC,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,UAAU,UAAQ,GAAG,OAAO,CAAC,MAAM,CAAC;IAOvG;;;;;OAKG;IACG,eAAe,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,UAAU,GAAE,OAAe,GAAG,OAAO,CAAC,MAAM,CAAC;IAOhI;;OAEG;IACG,UAAU,CAAC,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,UAAU,GAAE,OAAe,GAAG,OAAO,CAAC,MAAM,CAAC;IAiBzH;;OAEG;IACG,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,UAAU,GAAE,OAAe,GAAG,OAAO,CAAC,MAAM,CAAC;IAmB7H;;;OAGG;IACH,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,aAAa,EAAE;IAiC/C;;OAEG;IACG,mBAAmB,CACvB,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,MAAM,EACnB,KAAK,EAAE,aAAa,EACpB,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,IAAI,CAAC;IAuBhB;;;;OAIG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE;IAiBpC;;OAEG;IACH,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAKjC;;;;OAIG;IACG,gBAAgB,CACpB,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,EACnB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,IAAI,CAAC;IAOhB;;;;OAIG;IACG,gBAAgB,CACpB,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,UAAU,GACjB,OAAO,CAAC,IAAI,CAAC;IAMhB;;;;;OAKG;IACG,gBAAgB,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,UAAU,GAAE,OAAe,GAAG,OAAO,CAAC,YAAY,CAAC;IAwEvI;;;OAGG;IACG,mBAAmB,CAAC,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,UAAU,GAAE,OAAe,GAAG,OAAO,CAAC,eAAe,CAAC;IAyC1H;;;;OAIG;IACG,iBAAiB,CACrB,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,YAAY,GACjB,OAAO,CAAC,IAAI,CAAC;CAyEjB"}