@ibgib/vcs-gib 0.0.30 → 0.0.32

package/src/engine/status/status-helper.mts

@@ -1,383 +0,0 @@
-/**
- * @module status-helper
- *
- * Pure status inspection helpers and pending `.ib.*.md` comment metadata detection.
- */
-
-import path from 'node:path';
-import fs from 'node:fs/promises';
-import { Dirent } from 'node:fs';
-import crypto from 'node:crypto';
-
-import { B2tFSItemIbGib_V1, B2TFS_CHILD_ITEM_REL8N_NAME } from '../item/item-types.mjs';
-import { getIbGibWithMetaspaceFallback } from '../item/item-helper.mjs';
-import { B2tFSBranchIbGib_V1 } from '../branch/branch-types.mjs';
-import { isPathFiltered, parseFilterFileContent } from '../filter/glob-helper.mjs';
-import { getB2tFSIndexIbGib } from '../index/index-helper.mjs';
-import { B2tFSStagedItemRecord } from '../index/index-types.mjs';
-import { getOrCreateBranchSpace } from '../branch/branch-space-helper.mjs';
-import { resolveContextualBranchName } from '../branch/branch-helper.mjs';
-
-export interface VcsStatusItem {
-    path: string;
-    fsType: 'file' | 'folder';
-    status: 'untracked' | 'modified' | 'deleted' | 'staged';
-}
-
-export interface PendingCommentInfo {
-    /** Relative path of the companion file, e.g. "src/.ib.index.mts.md" or ".ib.architecture.md" */
-    commentRelPath: string;
-    /** Full disk path of the companion file */
-    commentFullPath: string;
-    /** Target relative path this comment attaches to, e.g. "src/index.mts" or "src" (folder) or "" (root) */
-    targetRelPath: string;
-    /** 'file' if .ib.<filename>.md matches a file, or 'folder' */
-    targetType: 'file' | 'folder';
-    /** The topic name (the * in .ib.*.md) or filename */
-    topicName: string;
-    /** Raw text content of the markdown comment file */
-    content: string;
-}
-
-export interface RepoStatusResult {
-    branchName: string;
-    activeWorktreeDir: string;
-    staged: VcsStatusItem[];
-    modified: VcsStatusItem[];
-    deleted: VcsStatusItem[];
-    untracked: VcsStatusItem[];
-    pendingComments: PendingCommentInfo[];
-}
-
-/**
- * Returns true if filename is a `.ib.*.md` comment metadata file.
- */
-export function isCommentMetadataFilename(filename: string): boolean {
-    return filename.startsWith('.ib.') && filename.endsWith('.md') && filename.length > '.ib..md'.length;
-}
-
-/**
- * Extracts the inner topic / filename from `.ib.<topic>.md`.
- */
-export function extractCommentTopicName(filename: string): string {
-    if (!isCommentMetadataFilename(filename)) { return ''; }
-    return filename.slice(4, -3); // strips leading '.ib.' and trailing '.md'
-}
-
-/**
- * Pure helper to walk the branch graph items.
- */
-export async function walkBranchGraph({
-    item,
-    space,
-    metaspace,
-    currentRelPath,
-    outMap,
-}: {
-    item: B2tFSItemIbGib_V1;
-    space: any;
-    metaspace?: any;
-    currentRelPath: string;
-    outMap: Map<string, { relPath: string; fileHash?: string; fsType: 'file' | 'folder' }>;
-}): Promise<void> {
-    if (!item || !item.data) { return; }
-
-    const { fsType, fileHash } = item.data;
-    if (currentRelPath) {
-        outMap.set(currentRelPath, { relPath: currentRelPath, fileHash, fsType });
-    }
-
-    if (fsType === 'folder') {
-        const childAddrs = item.rel8ns?.[B2TFS_CHILD_ITEM_REL8N_NAME] || [];
-        for (const childAddr of childAddrs) {
-            const childItem = await getIbGibWithMetaspaceFallback({
-                addr: childAddr,
-                space,
-                metaspace,
-            }) as B2tFSItemIbGib_V1;
-            if (childItem && childItem.data) {
-                const childRelPath = currentRelPath
-                    ? `${currentRelPath}/${childItem.data.name}`
-                    : childItem.data.name;
-                await walkBranchGraph({
-                    item: childItem,
-                    space,
-                    metaspace,
-                    currentRelPath: childRelPath,
-                    outMap,
-                });
-            }
-        }
-    }
-}
-
-/**
- * Pure helper to scan physical workspace, separating source files from `.ib.*.md` comment files.
- */
-export async function scanPhysicalWorkspace({
-    dirPath,
-    baseDir,
-    vcsFolderName,
-    filterPatterns,
-    outSourceMap,
-    outCommentFiles,
-}: {
-    dirPath: string;
-    baseDir: string;
-    vcsFolderName: string;
-    filterPatterns: string[];
-    outSourceMap: Map<string, { relPath: string; fullPath: string; isDirectory: boolean; fileHash?: string }>;
-    outCommentFiles: Array<{ relPath: string; fullPath: string; parentRelPath: string; filename: string }>;
-}): Promise<void> {
-    let entries: Dirent[] = [];
-    try {
-        entries = await fs.readdir(dirPath, { withFileTypes: true });
-    } catch {
-        return;
-    }
-
-    for (const entry of entries) {
-        const fullEntryPath = path.join(dirPath, entry.name);
-        const relPath = path.relative(baseDir, fullEntryPath).replace(/\\/g, '/');
-
-        // Ignore vcs storage folder, .git, and worktrees folder b
-        if (
-            relPath === vcsFolderName || relPath.startsWith(vcsFolderName + '/') ||
-            relPath === '.git' || relPath.startsWith('.git/') ||
-            relPath === 'b' || relPath.startsWith('b/')
-        ) {
-            continue;
-        }
-
-        if (isPathFiltered({ relativePath: relPath, isDirectory: entry.isDirectory(), filterPatterns })) {
-            continue;
-        }
-
-        if (entry.isDirectory()) {
-            outSourceMap.set(relPath, { relPath, fullPath: fullEntryPath, isDirectory: true });
-            await scanPhysicalWorkspace({
-                dirPath: fullEntryPath,
-                baseDir,
-                vcsFolderName,
-                filterPatterns,
-                outSourceMap,
-                outCommentFiles,
-            });
-        } else if (entry.isFile()) {
-            if (isCommentMetadataFilename(entry.name)) {
-                const parentRelPath = path.relative(baseDir, dirPath).replace(/\\/g, '/');
-                outCommentFiles.push({
-                    relPath,
-                    fullPath: fullEntryPath,
-                    parentRelPath: parentRelPath === '.' ? '' : parentRelPath,
-                    filename: entry.name,
-                });
-            } else {
-                let fileHash: string | undefined;
-                try {
-                    const fileData = await fs.readFile(fullEntryPath);
-                    fileHash = crypto.createHash('sha256').update(fileData).digest('hex');
-                } catch {
-                    // File unreadable
-                }
-                outSourceMap.set(relPath, { relPath, fullPath: fullEntryPath, isDirectory: false, fileHash });
-            }
-        }
-    }
-}
-
-/**
- * Computes complete repository status, including staged, modified, deleted, untracked,
- * and mapped pending `.ib.*.md` comment files.
- */
-export async function getRepoStatus({
-    metaspace,
-    localSpace,
-    vcsPath,
-    repoRoot,
-    targetDir = repoRoot,
-    vcsFolderName = '.vcsgib',
-}: {
-    metaspace: any;
-    localSpace: any;
-    vcsPath: string;
-    repoRoot: string;
-    targetDir?: string;
-    vcsFolderName?: string;
-}): Promise<RepoStatusResult> {
-    const indexIbGib = await getB2tFSIndexIbGib({ space: localSpace, vcsPath });
-    const branchName = resolveContextualBranchName({ targetDir, repoRoot, indexIbGib });
-    const activeWorktreeDir = branchName === 'main' ? repoRoot : path.join(repoRoot, 'b', branchName);
-
-    const { space: activeBranchSpace } = await getOrCreateBranchSpace({
-        metaspace,
-        vcsPath,
-        branchName,
-    });
-
-    const stagedMap = new Map<string, B2tFSStagedItemRecord>();
-    const indexStagedPaths = indexIbGib?.data?.stagedPaths || {};
-    for (const [relPath, itemRec] of Object.entries(indexStagedPaths)) {
-        stagedMap.set(relPath, itemRec);
-    }
-
-    let rootItemAddr: string | undefined;
-    const branchAddrs = [
-        ...(indexIbGib?.rel8ns?.branch || []),
-        ...(indexIbGib?.rel8ns?.branch_tjp || []),
-    ];
-
-    if (branchAddrs.length > 0) {
-        let branchIbGibs: B2tFSBranchIbGib_V1[] = [];
-        for (const bAddr of branchAddrs) {
-            const bIbGib = await getIbGibWithMetaspaceFallback({
-                addr: bAddr,
-                space: activeBranchSpace,
-                metaspace,
-            });
-            if (bIbGib) {
-                branchIbGibs.push(bIbGib as B2tFSBranchIbGib_V1);
-            }
-        }
-
-        const activeBranchIbGib = branchIbGibs.find(
-            (b) => (b as B2tFSBranchIbGib_V1)?.data?.name === branchName,
-        ) as B2tFSBranchIbGib_V1 || (branchIbGibs.at(0) as B2tFSBranchIbGib_V1);
-
-        rootItemAddr = activeBranchIbGib?.rel8ns?.b2tFS_item?.at(0) || activeBranchIbGib?.rel8ns?.b2tfs_item?.at(0);
-    }
-
-    let filterPatterns: string[] = [];
-    const ignorePath = path.join(activeWorktreeDir, '.ibgibignore');
-    try {
-        const ignoreContent = await fs.readFile(ignorePath, 'utf8');
-        filterPatterns = parseFilterFileContent(ignoreContent);
-    } catch {
-        // Ignore file missing is fine
-    }
-
-    const branchItemsMap = new Map<string, { relPath: string; fileHash?: string; fsType: 'file' | 'folder' }>();
-    if (rootItemAddr) {
-        const rootItem = await getIbGibWithMetaspaceFallback({
-            addr: rootItemAddr,
-            space: activeBranchSpace,
-            metaspace,
-        }) as B2tFSItemIbGib_V1;
-
-        if (rootItem) {
-            await walkBranchGraph({
-                item: rootItem,
-                space: activeBranchSpace,
-                metaspace,
-                currentRelPath: '',
-                outMap: branchItemsMap,
-            });
-        }
-    }
-
-    const physicalItemsMap = new Map<string, { relPath: string; fullPath: string; isDirectory: boolean; fileHash?: string }>();
-    const rawCommentFiles: Array<{ relPath: string; fullPath: string; parentRelPath: string; filename: string }> = [];
-
-    await scanPhysicalWorkspace({
-        dirPath: activeWorktreeDir,
-        baseDir: activeWorktreeDir,
-        vcsFolderName,
-        filterPatterns,
-        outSourceMap: physicalItemsMap,
-        outCommentFiles: rawCommentFiles,
-    });
-
-    const staged: VcsStatusItem[] = [];
-    const modified: VcsStatusItem[] = [];
-    const deleted: VcsStatusItem[] = [];
-    const untracked: VcsStatusItem[] = [];
-
-    for (const [relPath, stagedRec] of stagedMap.entries()) {
-        staged.push({
-            path: relPath,
-            fsType: stagedRec.fsType || 'file',
-            status: 'staged',
-        });
-    }
-
-    for (const [relPath, physItem] of physicalItemsMap.entries()) {
-        if (stagedMap.has(relPath)) {
-            continue;
-        }
-
-        const branchItem = branchItemsMap.get(relPath);
-        if (!branchItem) {
-            untracked.push({
-                path: relPath,
-                fsType: physItem.isDirectory ? 'folder' : 'file',
-                status: 'untracked',
-            });
-        } else {
-            if (!physItem.isDirectory && physItem.fileHash && branchItem.fileHash && physItem.fileHash !== branchItem.fileHash) {
-                modified.push({
-                    path: relPath,
-                    fsType: 'file',
-                    status: 'modified',
-                });
-            }
-        }
-    }
-
-    for (const [relPath, branchItem] of branchItemsMap.entries()) {
-        if (!relPath || relPath === '.' || relPath === '') { continue; }
-        if (!physicalItemsMap.has(relPath) && !stagedMap.has(relPath)) {
-            deleted.push({
-                path: relPath,
-                fsType: branchItem.fsType,
-                status: 'deleted',
-            });
-        }
-    }
-
-    // Map raw comment files to targets (file or folder)
-    const pendingComments: PendingCommentInfo[] = [];
-    for (const raw of rawCommentFiles) {
-        const topicName = extractCommentTopicName(raw.filename);
-        const candidateFileRelPath = raw.parentRelPath ? `${raw.parentRelPath}/${topicName}` : topicName;
-
-        let targetType: 'file' | 'folder' = 'folder';
-        let targetRelPath = raw.parentRelPath;
-
-        if (physicalItemsMap.has(candidateFileRelPath) && !physicalItemsMap.get(candidateFileRelPath)?.isDirectory) {
-            targetType = 'file';
-            targetRelPath = candidateFileRelPath;
-        } else if (branchItemsMap.has(candidateFileRelPath) && branchItemsMap.get(candidateFileRelPath)?.fsType === 'file') {
-            targetType = 'file';
-            targetRelPath = candidateFileRelPath;
-        } else if (stagedMap.has(candidateFileRelPath)) {
-            targetType = 'file';
-            targetRelPath = candidateFileRelPath;
-        }
-
-        let content = '';
-        try {
-            content = await fs.readFile(raw.fullPath, 'utf8');
-        } catch {
-            // Unreadable comment file
-        }
-
-        pendingComments.push({
-            commentRelPath: raw.relPath,
-            commentFullPath: raw.fullPath,
-            targetRelPath,
-            targetType,
-            topicName,
-            content,
-        });
-    }
-
-    return {
-        branchName,
-        activeWorktreeDir,
-        staged,
-        modified,
-        deleted,
-        untracked,
-        pendingComments,
-    };
-}