@popoverai/dotrequirements 0.24.0 → 0.24.2

package/dist/commands/mcp-setup.js

@@ -1,441 +0,0 @@
-import { execSync } from "node:child_process";
-import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
-import { homedir } from "node:os";
-import { join } from "node:path";
-import prompts from "prompts";
-import { brand } from "../utils/brand.js";
-import { appendOrUpdateSection, buildNoGitRepoMessage, findDotrequirementsSection, findGitRoot, getContextFileName, } from "../utils/context-file.js";
-import { loadTemplate } from "../utils/templates.js";
-/**
- * Load the context file section template
- */
-function loadContextFileSection() {
-    return loadTemplate("context-file-section.md");
-}
-/**
- * Install workflow guidance to the appropriate context file for a platform
- */
-async function installContextFileSection(platform) {
-    const fileName = getContextFileName(platform);
-    if (!fileName) {
-        console.error(`\n❌ Unknown platform: ${platform}`);
-        return;
-    }
-    const gitRoot = await findGitRoot();
-    if (!gitRoot) {
-        console.log(`\n${buildNoGitRepoMessage(fileName)}\n`);
-        return;
-    }
-    const contextFilePath = join(gitRoot, fileName);
-    const sectionContent = loadContextFileSection();
-    // Check if file exists and has existing section
-    let existingSection = null;
-    if (existsSync(contextFilePath)) {
-        const content = readFileSync(contextFilePath, "utf-8");
-        const section = findDotrequirementsSection(content);
-        if (section) {
-            existingSection = section.content;
-        }
-    }
-    // Prompt user
-    const action = existingSection
-        ? "Update"
-        : existsSync(contextFilePath)
-            ? "Add to"
-            : "Create";
-    const response = await prompts({
-        type: "confirm",
-        name: "install",
-        message: `${action} ${fileName} with dotrequirements workflow guidance?`,
-        initial: true,
-    });
-    if (!response.install) {
-        console.log("");
-        return;
-    }
-    // If updating, show what will change
-    if (existingSection) {
-        const confirmUpdate = await prompts({
-            type: "confirm",
-            name: "confirm",
-            message: "Existing dotrequirements section found. Replace it?",
-            initial: true,
-        });
-        if (!confirmUpdate.confirm) {
-            console.log("   Skipped.\n");
-            return;
-        }
-    }
-    try {
-        const result = appendOrUpdateSection(contextFilePath, sectionContent);
-        const actionVerb = result.action === "created"
-            ? "Created"
-            : result.action === "appended"
-                ? "Added to"
-                : "Updated";
-        console.log(`✅ ${actionVerb} ${contextFilePath}\n`);
-    }
-    catch (error) {
-        console.error(`❌ Failed to update ${fileName}`);
-        console.log(`   Error: ${error instanceof Error ? error.message : String(error)}\n`);
-    }
-}
-/**
- * MCP setup command - configures the MCP server for AI assistants
- */
-export async function mcpSetupCommand() {
-    console.log(`🔧 Setting up ${brand} MCP server\n`);
-    // Interactive client selector
-    const response = await prompts({
-        type: "select",
-        name: "client",
-        message: "Which AI assistant are you using?",
-        choices: [
-            { title: "Claude Code", value: "claude-code" },
-            { title: "Claude Desktop", value: "claude-desktop" },
-            { title: "Cursor", value: "cursor" },
-            { title: "Google Antigravity", value: "antigravity" },
-            { title: "OpenAI Codex", value: "codex" },
-            { title: "GitHub Copilot", value: "github-copilot" },
-            { title: "Other (custom path)", value: "other" },
-        ],
-        initial: 0,
-    });
-    if (!response.client) {
-        console.log("\nSetup cancelled.");
-        return;
-    }
-    switch (response.client) {
-        case "claude-code":
-            await setupClaudeCode();
-            break;
-        case "claude-desktop":
-            await setupClaudeDesktop();
-            break;
-        case "cursor":
-            await setupCursor();
-            break;
-        case "antigravity":
-            await setupAntigravity();
-            break;
-        case "codex":
-            await setupCodex();
-            break;
-        case "github-copilot":
-            await setupGitHubCopilot();
-            break;
-        case "other":
-            await setupOther();
-            break;
-        default:
-            console.log(`\n❌ ${response.client} is not yet supported.`);
-            console.log("Please refer to the documentation for manual setup.");
-    }
-}
-async function setupClaudeCode() {
-    console.log("\n📦 Configuring MCP for Claude Code...\n");
-    const command = `claude mcp add-json dotrequirements '{"type":"stdio","command":"npx","args":["-y","@popoverai/dotrequirements","mcp"]}'`;
-    let mcpConfigured = false;
-    try {
-        execSync(command, { stdio: "pipe" });
-        console.log("✅ MCP configured successfully for Claude Code!");
-        mcpConfigured = true;
-    }
-    catch (error) {
-        const execError = error;
-        const stderr = execError.stderr?.toString() || "";
-        const errorMessage = execError.message || "";
-        const combinedError = stderr + errorMessage;
-        if (combinedError.includes("already exists")) {
-            console.log("✅ MCP server already configured for Claude Code");
-            mcpConfigured = true;
-        }
-        else {
-            console.error("❌ Failed to configure MCP automatically.");
-            console.log("\nYou can manually run:");
-            console.log(`  ${command}`);
-            if (stderr) {
-                console.log(`\nError: ${stderr}`);
-            }
-        }
-    }
-    if (mcpConfigured) {
-        console.log("\n⚠️  Important: Restart Claude Code for changes to take effect.");
-        console.log("\nYou can now ask your AI assistant to help write requirements!\n");
-        await installContextFileSection("claude-code");
-    }
-}
-async function setupClaudeDesktop() {
-    console.log("\n📦 Configuring MCP for Claude Desktop...\n");
-    // Determine config path based on OS
-    const platform = process.platform;
-    let configPath;
-    let configDir;
-    if (platform === "darwin") {
-        configDir = join(homedir(), "Library", "Application Support", "Claude");
-        configPath = join(configDir, "claude_desktop_config.json");
-    }
-    else if (platform === "win32") {
-        const appData = process.env.APPDATA || join(homedir(), "AppData", "Roaming");
-        configDir = join(appData, "Claude");
-        configPath = join(configDir, "claude_desktop_config.json");
-    }
-    else {
-        console.error("❌ Claude Desktop is only supported on macOS and Windows.");
-        console.log("\nFor Linux, please manually configure the MCP server.");
-        return;
-    }
-    const mcpServerConfig = {
-        command: "npx",
-        args: ["-y", "@popoverai/dotrequirements", "mcp"],
-        env: {
-            REQUIREMENTS_DIR: process.cwd(),
-        },
-    };
-    try {
-        if (!existsSync(configDir)) {
-            console.log("Creating Claude Desktop config directory...");
-            mkdirSync(configDir, { recursive: true });
-        }
-        let config = {};
-        if (existsSync(configPath)) {
-            try {
-                const existingContent = readFileSync(configPath, "utf-8");
-                if (existingContent.trim()) {
-                    config = JSON.parse(existingContent);
-                }
-            }
-            catch (parseError) {
-                console.log("⚠️  Existing config file is invalid, creating fresh config...");
-                config = {};
-            }
-        }
-        if (!config.mcpServers) {
-            config.mcpServers = {};
-        }
-        config.mcpServers.dotrequirements = mcpServerConfig;
-        writeFileSync(configPath, JSON.stringify(config, null, 2), "utf-8");
-        console.log(`✅ MCP configured successfully!`);
-        console.log(`   Config file: ${configPath}`);
-        console.log(`   REQUIREMENTS_DIR: ${process.cwd()}\n`);
-        console.log("⚠️  Important: Quit and restart Claude Desktop for changes to take effect.");
-        console.log("              (Cmd+Q on macOS, not just close the window)\n");
-        console.log("You can now ask Claude Desktop to help write requirements!\n");
-        // Claude Desktop doesn't use skills like Claude Code, so we skip that step
-    }
-    catch (error) {
-        console.error("❌ Failed to configure MCP automatically.");
-        console.log(`\nError: ${error instanceof Error ? error.message : String(error)}`);
-        console.log("\nYou can manually edit the config file at:");
-        console.log(`  ${configPath}\n`);
-        console.log("Add the following configuration:");
-        const manualConfig = {
-            mcpServers: {
-                dotrequirements: mcpServerConfig,
-            },
-        };
-        console.log(JSON.stringify(manualConfig, null, 2));
-    }
-}
-async function setupCursor() {
-    console.log("\n📦 Configuring MCP for Cursor (project-specific)...\n");
-    const configPath = join(process.cwd(), ".cursor", "mcp.json");
-    const configDir = join(process.cwd(), ".cursor");
-    const mcpServerConfig = {
-        command: "npx",
-        args: ["-y", "@popoverai/dotrequirements", "mcp"],
-    };
-    try {
-        if (!existsSync(configDir)) {
-            console.log("Creating Cursor config directory...");
-            mkdirSync(configDir, { recursive: true });
-        }
-        let config = {};
-        if (existsSync(configPath)) {
-            try {
-                const existingContent = readFileSync(configPath, "utf-8");
-                if (existingContent.trim()) {
-                    config = JSON.parse(existingContent);
-                }
-            }
-            catch (parseError) {
-                console.log("⚠️  Existing config file is invalid, creating fresh config...");
-                config = {};
-            }
-        }
-        if (!config.mcpServers) {
-            config.mcpServers = {};
-        }
-        config.mcpServers.dotrequirements = mcpServerConfig;
-        writeFileSync(configPath, JSON.stringify(config, null, 2), "utf-8");
-        console.log(`✅ MCP configured successfully!`);
-        console.log(`   Config file: ${configPath}\n`);
-        console.log("⚠️  Important: Reload or restart Cursor for changes to take effect.");
-        console.log("\nYou can now ask your AI assistant to help write requirements!\n");
-        await installContextFileSection("cursor");
-    }
-    catch (error) {
-        console.error("❌ Failed to configure MCP automatically.");
-        console.log(`\nError: ${error instanceof Error ? error.message : String(error)}`);
-        console.log("\nYou can manually edit the config file at:");
-        console.log(`  ${configPath}\n`);
-        console.log("Add the following configuration:");
-        const manualConfig = {
-            mcpServers: {
-                dotrequirements: mcpServerConfig,
-            },
-        };
-        console.log(JSON.stringify(manualConfig, null, 2));
-    }
-}
-async function setupAntigravity() {
-    console.log("\n📦 Configuring MCP for Google Antigravity...\n");
-    const configPath = join(homedir(), ".gemini", "antigravity", "mcp_config.json");
-    const configDir = join(homedir(), ".gemini", "antigravity");
-    // Check if we're in a dotrequirements project directory
-    const envLocalPath = join(process.cwd(), ".env.local");
-    let projectId = null;
-    let projectPath = null;
-    if (existsSync(envLocalPath)) {
-        try {
-            const envContent = readFileSync(envLocalPath, "utf-8");
-            const lines = envContent.split("\n");
-            for (const line of lines) {
-                const trimmed = line.trim();
-                if (trimmed.startsWith("DOTREQUIREMENTS_PROJECT_ID=")) {
-                    projectId = trimmed.split("=")[1]?.trim().replace(/['"]/g, "");
-                    projectPath = process.cwd();
-                    break;
-                }
-            }
-        }
-        catch (error) {
-            // .env.local exists but couldn't read it - continue with global setup
-        }
-    }
-    try {
-        if (!existsSync(configDir)) {
-            console.log("Creating Antigravity config directory...");
-            mkdirSync(configDir, { recursive: true });
-        }
-        let config = {};
-        if (existsSync(configPath)) {
-            try {
-                const existingContent = readFileSync(configPath, "utf-8");
-                if (existingContent.trim()) {
-                    config = JSON.parse(existingContent);
-                }
-            }
-            catch (parseError) {
-                console.log("⚠️  Existing config file is invalid, creating fresh config...");
-                config = {};
-            }
-        }
-        if (!config.mcpServers) {
-            config.mcpServers = {};
-        }
-        if (!config.mcpServers.dotrequirements) {
-            config.mcpServers.dotrequirements = {
-                command: "npx",
-                args: ["-y", "@popoverai/dotrequirements", "mcp"],
-                env: {},
-            };
-        }
-        // biome-ignore lint/suspicious/noExplicitAny: `config` is parsed JSON from a user-owned MCP config file; its shape isn't ours to type fully. We only need the `env` bag, which we narrow ad-hoc here.
-        const dotreqServer = config.mcpServers.dotrequirements;
-        if (!dotreqServer.env) {
-            dotreqServer.env = {};
-        }
-        if (projectId && projectPath) {
-            const envKey = `PROJ_${projectId}`;
-            dotreqServer.env[envKey] = projectPath;
-            console.log(`✅ Added project to MCP config: ${envKey}`);
-            console.log(`   Path: ${projectPath}\n`);
-        }
-        else {
-            console.log(`ℹ️  Not in a ${brand} project directory (no .env.local with DOTREQUIREMENTS_PROJECT_ID found)`);
-            console.log("   Setting up global MCP server only.\n");
-        }
-        writeFileSync(configPath, JSON.stringify(config, null, 2), "utf-8");
-        console.log(`✅ MCP configured successfully!`);
-        console.log(`   Config file: ${configPath}\n`);
-        console.log("⚠️  Important: Reload or restart Google Antigravity for changes to take effect.");
-        console.log("\nYou can now ask your AI assistant to help write requirements!");
-        if (projectId) {
-            console.log(`\n💡 To add more projects, run \`dotreq mcp-setup\` from each project directory.\n`);
-        }
-        else {
-            console.log("");
-        }
-        await installContextFileSection("antigravity");
-    }
-    catch (error) {
-        console.error("❌ Failed to configure MCP automatically.");
-        console.log(`\nError: ${error instanceof Error ? error.message : String(error)}`);
-        console.log("\nYou can manually edit the config file at:");
-        console.log(`  ${configPath}`);
-    }
-}
-async function setupCodex() {
-    console.log("\n📦 Configuring MCP for OpenAI Codex...\n");
-    const command = `codex mcp add dotrequirements -- npx -y @popoverai/dotrequirements mcp`;
-    try {
-        execSync(command, { stdio: "inherit" });
-        console.log("\n✅ MCP configured successfully for Codex!");
-        console.log("\n⚠️  Important: Restart Codex for changes to take effect.");
-        console.log("\nYou can now ask your AI assistant to help write requirements!\n");
-        await installContextFileSection("codex");
-    }
-    catch (error) {
-        console.error("\n❌ Failed to configure MCP automatically.");
-        console.log("\nYou can manually run:");
-        console.log(`  ${command}`);
-        console.log("\nOr manually edit ~/.codex/config.toml and add:");
-        console.log("[mcp_servers.dotrequirements]");
-        console.log('command = "npx"');
-        console.log('args = ["-y", "@popoverai/dotrequirements", "mcp"]');
-    }
-}
-async function setupGitHubCopilot() {
-    console.log("\n📦 Configuring skills for GitHub Copilot...\n");
-    console.log("ℹ️  GitHub Copilot discovers MCP servers from your IDE configuration.");
-    console.log("   Please configure the MCP server in VS Code settings or GitHub settings.\n");
-    console.log("   MCP server command: npx -y @popoverai/dotrequirements mcp\n");
-    await installContextFileSection("github-copilot");
-}
-async function setupOther() {
-    console.log("\n📦 Custom Context File Setup\n");
-    console.log("ℹ️  Workflow guidance is added to a context file at your project root.");
-    console.log("   Common file names by platform:");
-    console.log("   - CLAUDE.md   (Claude Code)");
-    console.log("   - AGENTS.md   (Cursor, Codex, GitHub Copilot)");
-    console.log("   - GEMINI.md   (Antigravity)\n");
-    const response = await prompts({
-        type: "select",
-        name: "file",
-        message: "Which context file should we update?",
-        choices: [
-            { title: "AGENTS.md (most compatible)", value: "AGENTS.md" },
-            { title: "CLAUDE.md", value: "CLAUDE.md" },
-            { title: "GEMINI.md", value: "GEMINI.md" },
-        ],
-        initial: 0,
-    });
-    if (!response.file) {
-        console.log("\nSetup cancelled.");
-        return;
-    }
-    console.log("\n📝 MCP Server Setup\n");
-    console.log("Configure your AI assistant to run the MCP server:");
-    console.log("   Command: npx");
-    console.log("   Args: -y @popoverai/dotrequirements mcp\n");
-    // Determine platform based on file choice for the install function
-    const platformMap = {
-        "CLAUDE.md": "claude-code",
-        "AGENTS.md": "cursor", // Any AGENTS.md platform works
-        "GEMINI.md": "antigravity",
-    };
-    const platform = platformMap[response.file];
-    await installContextFileSection(platform);
-}
-//# sourceMappingURL=mcp-setup.js.map

package/dist/commands/test.d.ts

@@ -1,6 +0,0 @@
-interface TestOptions {
-    file?: string;
-}
-export declare function testCommand(options: TestOptions): Promise<void>;
-export {};
-//# sourceMappingURL=test.d.ts.map

package/dist/commands/test.js

@@ -1,72 +0,0 @@
-import * as fs from "node:fs";
-import * as path from "node:path";
-import { parseRequirementsFromFile, } from "../schema/index.js";
-export async function testCommand(options) {
-    console.log("Parsing and validating requirements...");
-    const requirementsDir = path.join(process.cwd(), ".requirements");
-    if (!fs.existsSync(requirementsDir)) {
-        console.error("Error: .requirements/ directory not found.");
-        console.log('Run "dotrequirements pull" first to sync requirements.');
-        process.exit(1);
-    }
-    // Get files to test
-    let files;
-    if (options.file) {
-        files = [options.file];
-    }
-    else {
-        files = fs
-            .readdirSync(requirementsDir)
-            .filter((f) => f.endsWith(".requirements.md"))
-            .map((f) => path.join(requirementsDir, f));
-    }
-    if (files.length === 0) {
-        console.log("No Markdown requirements files found to test.");
-        return;
-    }
-    let totalRequirements = 0;
-    let passCount = 0;
-    let failCount = 0;
-    for (const filePath of files) {
-        const fileName = path.basename(filePath);
-        console.log(`\nTesting: ${fileName}`);
-        try {
-            // Parse and validate using shared schema module
-            const { metadata, requirements } = parseRequirementsFromFile(filePath);
-            // Count total requirements (root + all descendants)
-            let count = 0;
-            for (const req of requirements) {
-                count += countRequirementsInTree(req);
-            }
-            totalRequirements += count;
-            console.log(`  ✓ Valid structure (${count} requirement(s))`);
-            console.log(`  ✓ Version: ${metadata.version}`);
-            console.log(`  ✓ Last sync: ${metadata.pulledAt}`);
-            passCount++;
-        }
-        catch (error) {
-            console.error(`  ✗ Validation failed:`, error);
-            failCount++;
-        }
-    }
-    console.log(`\n${"=".repeat(50)}`);
-    console.log(`Total files: ${files.length}`);
-    console.log(`Passed: ${passCount}`);
-    console.log(`Failed: ${failCount}`);
-    console.log(`Total requirements: ${totalRequirements}`);
-    if (failCount > 0) {
-        process.exit(1);
-    }
-}
-/**
- * Recursively count requirements in a tree (1 for root + all descendants)
- */
-function countRequirementsInTree(node) {
-    let count = 1; // Count this node
-    // Count all children
-    for (const child of node.children) {
-        count += countRequirementsInTree(child);
-    }
-    return count;
-}
-//# sourceMappingURL=test.js.map

package/dist/mcp/grep.d.ts

@@ -1,24 +0,0 @@
-import type { TestReference } from "./types.js";
-/**
- * Find all test files that reference a specific requirement ID
- *
- * Uses execFile with array arguments to avoid command injection vulnerabilities.
- */
-export declare function findTestsForRequirement(workspaceRoot: string, requirementId: string): Promise<TestReference[]>;
-/**
- * Find all requirement references in a specific file using AST parsing
- */
-export declare function findRequirementsInFile(filePath: string): Promise<TestReference[]>;
-/**
- * Find all requirement references in the entire workspace
- *
- * Uses execFile with array arguments to avoid command injection vulnerabilities.
- */
-export declare function findAllTestReferences(workspaceRoot: string): Promise<TestReference[]>;
-/**
- * Get all unique requirement IDs referenced in tests
- * Normalizes child IDs (e.g., AUTH-VALID-LOGIN.0) to root IDs (e.g., AUTH-VALID-LOGIN)
- * Uses AST parsing instead of grep for reliability across environments
- */
-export declare function getReferencedRequirementIds(workspaceRoot: string): Promise<Set<string>>;
-//# sourceMappingURL=grep.d.ts.map