@vertaaux/cli 0.2.0

package/dist/interactive/fix-wizard.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Interactive fix wizard for stepping through issues one by one.
+ *
+ * Provides a guided workflow to:
+ * - Review issues sorted by severity
+ * - Accept fix suggestions with diff preview
+ * - Skip issues
+ * - Add issues to baseline
+ * - Get detailed explanations
+ *
+ * CLI-09: vertaa audit --interactive steps through fixes
+ */
+import { type EvidenceIssue } from "../commands/explain.js";
+import type { Issue } from "../baseline/hash.js";
+import type { VertaauxConfig } from "../config/schema.js";
+/**
+ * Options for running the fix wizard.
+ */
+export interface FixWizardOptions {
+    /** Audit job ID for fetching patches */
+    jobId?: string;
+    /** URL that was audited (for baseline) */
+    url: string;
+    /** API base URL override */
+    base?: string;
+    /** Config for API key */
+    config?: VertaauxConfig;
+}
+/**
+ * Run the interactive fix wizard.
+ *
+ * Steps through issues one by one, offering:
+ * - Accept fix suggestion
+ * - Skip this issue
+ * - Explain in detail
+ * - Add to baseline
+ * - Quit wizard
+ *
+ * @param issues - Issues from audit results
+ * @param options - Wizard options
+ * @returns Promise that resolves when wizard completes
+ */
+export declare function runFixWizard(issues: (Issue | EvidenceIssue)[], options: FixWizardOptions): Promise<void>;
+//# sourceMappingURL=fix-wizard.d.ts.map

package/dist/interactive/fix-wizard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fix-wizard.d.ts","sourceRoot":"","sources":["../../src/interactive/fix-wizard.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAIH,OAAO,EAAgB,KAAK,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAS1E,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAOjD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAqB1D;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,wCAAwC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,0CAA0C;IAC1C,GAAG,EAAE,MAAM,CAAC;IACZ,4BAA4B;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,yBAAyB;IACzB,MAAM,CAAC,EAAE,cAAc,CAAC;CACzB;AAwHD;;;;;;;;;;;;;GAaG;AACH,wBAAsB,YAAY,CAChC,MAAM,EAAE,CAAC,KAAK,GAAG,aAAa,CAAC,EAAE,EACjC,OAAO,EAAE,gBAAgB,GACxB,OAAO,CAAC,IAAI,CAAC,CA4Mf"}

package/dist/interactive/fix-wizard.js

@@ -0,0 +1,286 @@
+/**
+ * Interactive fix wizard for stepping through issues one by one.
+ *
+ * Provides a guided workflow to:
+ * - Review issues sorted by severity
+ * - Accept fix suggestions with diff preview
+ * - Skip issues
+ * - Add issues to baseline
+ * - Get detailed explanations
+ *
+ * CLI-09: vertaa audit --interactive steps through fixes
+ */
+import { select, confirm, input } from "@inquirer/prompts";
+import chalk from "chalk";
+import { explainIssue } from "../commands/explain.js";
+import { loadBaseline, saveBaseline, createBaseline, addToBaseline, DEFAULT_BASELINE_PATH, } from "../baseline/manager.js";
+import { requireInteractive } from "./prompts.js";
+import { resolveApiBase, getApiKey, apiRequest, } from "../utils/client.js";
+/**
+ * Get severity display with color.
+ */
+function coloredSeverity(severity) {
+    const sev = (severity || "info").toLowerCase();
+    switch (sev) {
+        case "critical":
+        case "error":
+            return chalk.red.bold(sev.toUpperCase());
+        case "serious":
+        case "warning":
+            return chalk.yellow.bold(sev.toUpperCase());
+        case "moderate":
+        case "minor":
+            return chalk.cyan(sev.toUpperCase());
+        default:
+            return chalk.dim(sev.toUpperCase());
+    }
+}
+/**
+ * Get severity rank for sorting (higher = more severe).
+ */
+function severityRank(severity) {
+    const sev = (severity || "info").toLowerCase();
+    switch (sev) {
+        case "critical":
+        case "error":
+            return 4;
+        case "serious":
+        case "warning":
+            return 3;
+        case "moderate":
+        case "minor":
+            return 2;
+        default:
+            return 1;
+    }
+}
+/**
+ * Get rule ID from issue.
+ */
+function getRuleId(issue) {
+    return issue.ruleId || issue.rule_id || issue.id || "unknown";
+}
+/**
+ * Format a diff for display.
+ */
+function formatDiff(search, replace) {
+    const lines = [];
+    lines.push(chalk.dim("--- before"));
+    lines.push(chalk.dim("+++ after"));
+    lines.push(chalk.dim("@@ -1,1 +1,1 @@"));
+    lines.push(chalk.red(`-${search}`));
+    lines.push(chalk.green(`+${replace}`));
+    return lines.join("\n");
+}
+/**
+ * Display issue summary for wizard.
+ */
+function displayIssueSummary(issue, index, total) {
+    const ruleId = getRuleId(issue);
+    const severity = coloredSeverity(issue.severity);
+    console.log("");
+    console.log(chalk.bold(`[${index + 1}/${total}] ${severity}: ${ruleId}`));
+    console.log(issue.description || issue.title || "No description");
+    console.log(chalk.dim(`Selector: ${issue.selector || "N/A"}`));
+    if (issue.wcag_reference) {
+        console.log(chalk.dim(`WCAG: ${issue.wcag_reference}`));
+    }
+    console.log("");
+}
+/**
+ * Fetch patch suggestion from API.
+ */
+async function fetchPatchSuggestion(jobId, issueId, base, apiKey) {
+    try {
+        const response = await apiRequest(base, "/patch", {
+            method: "POST",
+            body: {
+                job_id: jobId,
+                issue_id: issueId,
+                // Note: file_content not required for suggestion preview
+            },
+        }, apiKey);
+        if (response.success && response.patch) {
+            return response.patch;
+        }
+        return null;
+    }
+    catch {
+        return null;
+    }
+}
+/**
+ * Run the interactive fix wizard.
+ *
+ * Steps through issues one by one, offering:
+ * - Accept fix suggestion
+ * - Skip this issue
+ * - Explain in detail
+ * - Add to baseline
+ * - Quit wizard
+ *
+ * @param issues - Issues from audit results
+ * @param options - Wizard options
+ * @returns Promise that resolves when wizard completes
+ */
+export async function runFixWizard(issues, options) {
+    // Require interactive TTY
+    requireInteractive();
+    if (issues.length === 0) {
+        console.log(chalk.green("\nNo issues to review. Great job!"));
+        return;
+    }
+    // Sort issues by severity (critical first)
+    const sortedIssues = [...issues].sort((a, b) => severityRank(b.severity) - severityRank(a.severity));
+    console.log(chalk.bold(`\nFound ${sortedIssues.length} issues to review:\n`));
+    // Load or create baseline
+    let baseline = await loadBaseline();
+    if (!baseline) {
+        baseline = createBaseline([], options.url);
+    }
+    // Track stats
+    let accepted = 0;
+    let skipped = 0;
+    let baselined = 0;
+    // Resolve API settings
+    const base = resolveApiBase(options.base);
+    let apiKey = null;
+    try {
+        apiKey = getApiKey(options.config?.apiKey);
+    }
+    catch {
+        // API key not available - patches won't work but other actions will
+    }
+    // Process each issue
+    let i = 0;
+    while (i < sortedIssues.length) {
+        const issue = sortedIssues[i];
+        displayIssueSummary(issue, i, sortedIssues.length);
+        const action = await select({
+            message: "Action:",
+            choices: [
+                {
+                    name: "Accept fix suggestion",
+                    value: "accept",
+                    description: "View and apply the suggested fix",
+                },
+                {
+                    name: "Skip this issue",
+                    value: "skip",
+                    description: "Move to the next issue",
+                },
+                {
+                    name: "Explain in detail",
+                    value: "explain",
+                    description: "Show full evidence bundle",
+                },
+                {
+                    name: "Add to baseline",
+                    value: "baseline",
+                    description: "Mark as accepted technical debt",
+                },
+                {
+                    name: "Quit wizard",
+                    value: "quit",
+                    description: "Exit without processing remaining issues",
+                },
+            ],
+        });
+        switch (action) {
+            case "accept": {
+                // Try to fetch and show patch suggestion
+                if (options.jobId && apiKey) {
+                    console.log(chalk.dim("\nFetching fix suggestion..."));
+                    const patch = await fetchPatchSuggestion(options.jobId, getRuleId(issue), base, apiKey);
+                    if (patch) {
+                        console.log("");
+                        console.log(chalk.bold(`SUGGESTED FIX (Confidence: ${patch.confidence.label} ${patch.confidence.percentage}%)`));
+                        console.log("");
+                        console.log(formatDiff(patch.search, patch.replace));
+                        console.log("");
+                        if (patch.explanation) {
+                            console.log(chalk.dim(patch.explanation));
+                            console.log("");
+                        }
+                        const applyFix = await confirm({
+                            message: "Apply this fix?",
+                            default: true,
+                        });
+                        if (applyFix) {
+                            // Note: Actual file modification is deferred to future version
+                            console.log(chalk.green("Fix accepted (would apply in future version)"));
+                            accepted++;
+                        }
+                        else {
+                            console.log(chalk.dim("Fix declined, moving to next issue"));
+                        }
+                    }
+                    else {
+                        console.log(chalk.yellow("\nNo fix suggestion available for this issue."));
+                        const skipOrBaseline = await select({
+                            message: "What would you like to do?",
+                            choices: [
+                                { name: "Skip to next issue", value: "skip" },
+                                { name: "Add to baseline", value: "baseline" },
+                            ],
+                        });
+                        if (skipOrBaseline === "baseline") {
+                            const reason = await input({
+                                message: "Reason for baseline (optional):",
+                            });
+                            baseline = addToBaseline(baseline, issue, reason || undefined);
+                            await saveBaseline(baseline, DEFAULT_BASELINE_PATH);
+                            console.log(chalk.dim("Added to baseline"));
+                            baselined++;
+                        }
+                    }
+                }
+                else {
+                    console.log(chalk.yellow("\nFix suggestions require a job ID and API key."));
+                    console.log(chalk.dim("Run with `vertaa audit <url> --wait --interactive` for full functionality."));
+                }
+                i++;
+                break;
+            }
+            case "skip":
+                skipped++;
+                i++;
+                break;
+            case "explain": {
+                // Show full evidence bundle
+                console.log("");
+                console.log(explainIssue(issue));
+                console.log("");
+                // Don't increment i - stay on same issue to pick another action
+                break;
+            }
+            case "baseline": {
+                const reason = await input({
+                    message: "Reason for baseline (optional):",
+                });
+                baseline = addToBaseline(baseline, issue, reason || undefined);
+                await saveBaseline(baseline, DEFAULT_BASELINE_PATH);
+                console.log(chalk.dim("Added to baseline"));
+                baselined++;
+                i++;
+                break;
+            }
+            case "quit":
+                console.log("");
+                console.log(chalk.bold("Wizard Summary:"));
+                console.log(`  Accepted: ${accepted}`);
+                console.log(`  Skipped: ${skipped}`);
+                console.log(`  Baselined: ${baselined}`);
+                console.log(`  Remaining: ${sortedIssues.length - i}`);
+                return;
+        }
+    }
+    // Summary
+    console.log("");
+    console.log(chalk.bold.green("All issues reviewed!"));
+    console.log("");
+    console.log(chalk.bold("Summary:"));
+    console.log(`  Accepted: ${accepted}`);
+    console.log(`  Skipped: ${skipped}`);
+    console.log(`  Baselined: ${baselined}`);
+}

package/dist/interactive/init-wizard.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Interactive wizard for `vertaa init` command.
+ *
+ * Guides users through project setup with sensible defaults.
+ */
+import type { AuditMode, FailOnSeverity, CITemplate } from "../config/schema.js";
+/**
+ * Configuration generated by the init wizard.
+ */
+export interface InitConfig {
+    /** Default URL to audit */
+    defaultUrl?: string;
+    /** Audit mode */
+    mode: AuditMode;
+    /** Fail on severity level */
+    failOn: FailOnSeverity | "none";
+    /** Minimum score threshold (0 = disabled) */
+    threshold: number;
+    /** Auto-update baseline on main branch */
+    autoUpdateBaseline: boolean;
+    /** CI provider for template generation */
+    ciProvider: CITemplate;
+}
+/**
+ * Run the interactive init wizard.
+ *
+ * Guides user through configuration options and returns the chosen settings.
+ *
+ * @returns Configuration object for writing to file
+ */
+export declare function runInitWizard(): Promise<InitConfig>;
+//# sourceMappingURL=init-wizard.d.ts.map

package/dist/interactive/init-wizard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"init-wizard.d.ts","sourceRoot":"","sources":["../../src/interactive/init-wizard.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,KAAK,EAAE,SAAS,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjF;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,2BAA2B;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iBAAiB;IACjB,IAAI,EAAE,SAAS,CAAC;IAChB,6BAA6B;IAC7B,MAAM,EAAE,cAAc,GAAG,MAAM,CAAC;IAChC,6CAA6C;IAC7C,SAAS,EAAE,MAAM,CAAC;IAClB,0CAA0C;IAC1C,kBAAkB,EAAE,OAAO,CAAC;IAC5B,0CAA0C;IAC1C,UAAU,EAAE,UAAU,CAAC;CACxB;AAED;;;;;;GAMG;AACH,wBAAsB,aAAa,IAAI,OAAO,CAAC,UAAU,CAAC,CAgMzD"}

package/dist/interactive/init-wizard.js

@@ -0,0 +1,193 @@
+/**
+ * Interactive wizard for `vertaa init` command.
+ *
+ * Guides users through project setup with sensible defaults.
+ */
+import { select, confirm, input } from "@inquirer/prompts";
+/**
+ * Run the interactive init wizard.
+ *
+ * Guides user through configuration options and returns the chosen settings.
+ *
+ * @returns Configuration object for writing to file
+ */
+export async function runInitWizard() {
+    console.log("\n  Welcome to VertaaUX!\n");
+    console.log("  This wizard will help you configure VertaaUX for your project.\n");
+    // Step 1: Default URL
+    const defaultUrl = await input({
+        message: "What URL would you like to audit? (optional)",
+        default: "",
+        validate: (value) => {
+            if (!value)
+                return true; // Optional
+            try {
+                new URL(value);
+                return true;
+            }
+            catch {
+                return "Please enter a valid URL (e.g., https://example.com)";
+            }
+        },
+    });
+    // Step 2: Audit mode
+    const mode = await select({
+        message: "Select audit mode:",
+        choices: [
+            {
+                name: "Basic - Quick scan for common issues",
+                value: "basic",
+                description: "Fastest, covers essential accessibility and UX checks",
+            },
+            {
+                name: "Standard - Comprehensive analysis",
+                value: "standard",
+                description: "Balanced depth and speed, recommended for most projects",
+            },
+            {
+                name: "Deep - Thorough multi-page audit",
+                value: "deep",
+                description: "Most thorough, includes page flow and cross-page issues",
+            },
+        ],
+        default: "standard",
+    });
+    // Step 3: Configure baseline rules
+    const configureBaseline = await confirm({
+        message: "Configure baseline rules? (controls CI failure conditions)",
+        default: true,
+    });
+    let failOn = "error";
+    let threshold = 0;
+    let autoUpdateBaseline = false;
+    if (configureBaseline) {
+        // Step 3a: Fail-on severity
+        failOn = await select({
+            message: "Fail CI build when issues of this severity are found:",
+            choices: [
+                {
+                    name: "Error - Only critical/error severity",
+                    value: "error",
+                    description: "Strictest, blocks on critical issues only",
+                },
+                {
+                    name: "Warning - Warnings and above",
+                    value: "warning",
+                    description: "Blocks on warning and error severity",
+                },
+                {
+                    name: "Info - Any issues",
+                    value: "info",
+                    description: "Most strict, blocks on all issues",
+                },
+                {
+                    name: "None - Never fail on issues",
+                    value: "none",
+                    description: "Report only, never fail CI",
+                },
+            ],
+            default: "error",
+        });
+        // Step 3b: Score threshold
+        const setThreshold = await confirm({
+            message: "Set a minimum score threshold?",
+            default: false,
+        });
+        if (setThreshold) {
+            const thresholdStr = await input({
+                message: "Minimum passing score (0-100):",
+                default: "70",
+                validate: (value) => {
+                    const num = parseInt(value, 10);
+                    if (isNaN(num) || num < 0 || num > 100) {
+                        return "Please enter a number between 0 and 100";
+                    }
+                    return true;
+                },
+            });
+            threshold = parseInt(thresholdStr, 10);
+        }
+        // Step 3c: Auto-update baseline
+        autoUpdateBaseline = await confirm({
+            message: "Auto-update baseline when issues are fixed on main branch?",
+            default: false,
+        });
+    }
+    // Step 4: CI integration
+    const configureCI = await confirm({
+        message: "Configure CI integration?",
+        default: true,
+    });
+    let ciProvider = "none";
+    if (configureCI) {
+        ciProvider = await select({
+            message: "Which CI provider?",
+            choices: [
+                {
+                    name: "GitHub Actions",
+                    value: "github",
+                    description: "Creates .github/workflows/vertaa.yml with SARIF upload",
+                },
+                {
+                    name: "GitLab CI",
+                    value: "gitlab",
+                    description: "Creates .gitlab-ci-vertaa.yml with JUnit and Code Quality reports",
+                },
+                {
+                    name: "CircleCI",
+                    value: "circleci",
+                    description: "Creates .circleci/config-vertaa.yml with test results",
+                },
+                {
+                    name: "Azure DevOps",
+                    value: "azure",
+                    description: "Creates azure-pipelines-vertaa.yml with Advanced Security",
+                },
+                {
+                    name: "Jenkins",
+                    value: "jenkins",
+                    description: "Creates Jenkinsfile-vertaa with Warnings NG plugin",
+                },
+                {
+                    name: "None - Skip CI setup",
+                    value: "none",
+                },
+            ],
+            default: "github",
+        });
+    }
+    // Step 5: Summary
+    console.log("\n  Configuration Summary:");
+    console.log("  ----------------------");
+    if (defaultUrl) {
+        console.log(`  URL:        ${defaultUrl}`);
+    }
+    console.log(`  Mode:       ${mode}`);
+    console.log(`  Fail on:    ${failOn}`);
+    if (threshold > 0) {
+        console.log(`  Threshold:  ${threshold}`);
+    }
+    if (autoUpdateBaseline) {
+        console.log(`  Auto-update: enabled`);
+    }
+    if (ciProvider !== "none") {
+        console.log(`  CI:         ${ciProvider}`);
+    }
+    console.log("");
+    // Step 6: Confirm
+    const create = await confirm({
+        message: "Create configuration?",
+        default: true,
+    });
+    if (!create) {
+        throw new Error("Configuration cancelled by user");
+    }
+    return {
+        defaultUrl: defaultUrl || undefined,
+        mode,
+        failOn,
+        threshold,
+        autoUpdateBaseline,
+        ciProvider,
+    };
+}

package/dist/interactive/prompts.d.ts

@@ -0,0 +1,62 @@
+/**
+ * Reusable prompt patterns for interactive CLI mode.
+ *
+ * Wraps @inquirer/prompts with consistent styling.
+ * Keyboard navigation is handled natively by @inquirer/prompts:
+ * - Arrow keys for navigation
+ * - Enter to confirm
+ * - Space to select (multi-select)
+ */
+/**
+ * Choice option for select prompts.
+ */
+export interface SelectChoice<T = string> {
+    /** Display name */
+    name: string;
+    /** Return value when selected */
+    value: T;
+    /** Optional description shown below the choice */
+    description?: string;
+    /** Mark as disabled (shows but can't select) */
+    disabled?: boolean | string;
+}
+/**
+ * Prompt user to select from a list of options.
+ *
+ * Uses arrow keys for navigation, Enter to confirm.
+ *
+ * @param message - Prompt message
+ * @param choices - List of options
+ * @returns Selected value
+ */
+export declare function selectAction<T = string>(message: string, choices: SelectChoice<T>[]): Promise<T>;
+/**
+ * Prompt user for yes/no confirmation.
+ *
+ * @param message - Question to confirm
+ * @param defaultValue - Default value if user just presses Enter
+ * @returns true for yes, false for no
+ */
+export declare function confirmAction(message: string, defaultValue?: boolean): Promise<boolean>;
+/**
+ * Prompt user for text input.
+ *
+ * @param message - Prompt message
+ * @param defaultValue - Optional default value
+ * @param required - Whether input is required (default: false)
+ * @returns User input string
+ */
+export declare function inputText(message: string, defaultValue?: string, required?: boolean): Promise<string>;
+/**
+ * Check if running in an interactive TTY environment.
+ *
+ * @returns true if stdin/stdout are TTY
+ */
+export declare function isInteractive(): boolean;
+/**
+ * Assert that the environment is interactive, throwing if not.
+ *
+ * @throws Error if not in interactive TTY mode
+ */
+export declare function requireInteractive(): void;
+//# sourceMappingURL=prompts.d.ts.map

package/dist/interactive/prompts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prompts.d.ts","sourceRoot":"","sources":["../../src/interactive/prompts.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAIH;;GAEG;AACH,MAAM,WAAW,YAAY,CAAC,CAAC,GAAG,MAAM;IACtC,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,iCAAiC;IACjC,KAAK,EAAE,CAAC,CAAC;IACT,kDAAkD;IAClD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gDAAgD;IAChD,QAAQ,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;CAC7B;AAED;;;;;;;;GAQG;AACH,wBAAsB,YAAY,CAAC,CAAC,GAAG,MAAM,EAC3C,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,EAAE,GACzB,OAAO,CAAC,CAAC,CAAC,CAUZ;AAED;;;;;;GAMG;AACH,wBAAsB,aAAa,CACjC,OAAO,EAAE,MAAM,EACf,YAAY,GAAE,OAAc,GAC3B,OAAO,CAAC,OAAO,CAAC,CAKlB;AAED;;;;;;;GAOG;AACH,wBAAsB,SAAS,CAC7B,OAAO,EAAE,MAAM,EACf,YAAY,CAAC,EAAE,MAAM,EACrB,QAAQ,GAAE,OAAe,GACxB,OAAO,CAAC,MAAM,CAAC,CAQjB;AAED;;;;GAIG;AACH,wBAAgB,aAAa,IAAI,OAAO,CAEvC;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,IAAI,IAAI,CAMzC"}