@agent-scope/cli 1.13.0 → 1.15.0

package/dist/index.d.cts

@@ -1,6 +1,121 @@
 import { Command } from 'commander';
 import { ComplexityClass } from '@agent-scope/manifest';
 
+/**
+ * @agent-scope/cli — `scope ci` command
+ *
+ * Runs a non-interactive CI pipeline over the component library and exits
+ * with a structured exit code so the result can be consumed by CI systems.
+ *
+ * ## Pipeline steps (in order)
+ *
+ *   1. Generate the component manifest (discover all components)
+ *   2. Render all discovered components
+ *   3. Run token-compliance checks
+ *   4. Compare against baseline snapshot (if `--baseline` provided)
+ *
+ * ## Exit codes
+ *
+ *   0 — All checks passed
+ *   1 — Compliance below threshold
+ *   2 — Accessibility violations found (reserved; currently surfaced as info)
+ *   3 — Console errors during render
+ *   4 — Visual regression detected (pixel diff above threshold)
+ *   5 — Component render failures
+ *
+ * ## Usage
+ *
+ * ```bash
+ * scope ci
+ * scope ci --baseline .reactscope/baseline
+ * scope ci --checks compliance,console-errors
+ * scope ci --threshold 0.90 --json
+ * ```
+ */
+
+declare const CI_EXIT: {
+    /** All checks passed */
+    readonly OK: 0;
+    /** Compliance score below threshold */
+    readonly COMPLIANCE_BELOW_THRESHOLD: 1;
+    /** Accessibility violations found */
+    readonly A11Y_VIOLATIONS: 2;
+    /** Console errors detected during render */
+    readonly CONSOLE_ERRORS: 3;
+    /** Visual regression detected against baseline */
+    readonly VISUAL_REGRESSION: 4;
+    /** One or more components failed to render */
+    readonly RENDER_FAILURES: 5;
+};
+type CiExitCode = (typeof CI_EXIT)[keyof typeof CI_EXIT];
+type CiCheckName = "compliance" | "a11y" | "console-errors" | "visual-regression";
+interface CiCheckResult {
+    /** Which check this is */
+    check: CiCheckName;
+    /** Whether the check passed */
+    passed: boolean;
+    /** Human-readable summary */
+    message: string;
+    /** Numeric value for threshold-based checks */
+    value?: number;
+    /** Threshold that was applied */
+    threshold?: number;
+}
+interface CiResult {
+    /** ISO timestamp */
+    ranAt: string;
+    /** Whether the overall CI run passed (exit code 0) */
+    passed: boolean;
+    /** The resolved exit code */
+    exitCode: CiExitCode;
+    /** Per-check results */
+    checks: CiCheckResult[];
+    /** Component counts */
+    components: {
+        total: number;
+        rendered: number;
+        failed: number;
+    };
+    /** Aggregate compliance score (0–1) */
+    complianceScore: number;
+    /** Compliance threshold that was applied */
+    complianceThreshold: number;
+    /** Whether baseline comparison was performed */
+    baselineCompared: boolean;
+    /** Wall-clock duration in ms */
+    wallClockMs: number;
+}
+interface CiOptions {
+    /** Baseline directory to compare against. Omit to skip visual regression check. */
+    baselineDir?: string;
+    /** Which checks to run. Default: all */
+    checks?: CiCheckName[];
+    /** Compliance pass threshold (0–1). Default: 0.90 */
+    complianceThreshold?: number;
+    /** Viewport width. Default: 375 */
+    viewportWidth?: number;
+    /** Viewport height. Default: 812 */
+    viewportHeight?: number;
+}
+/**
+ * Run the full CI pipeline and return a structured CiResult.
+ *
+ * Does not call `process.exit` — callers are responsible for that so the
+ * function remains testable without side effects.
+ */
+declare function runCi(options?: CiOptions): Promise<CiResult>;
+/**
+ * Format a CiResult as the CI stdout summary (spec §4.2).
+ */
+declare function formatCiReport(result: CiResult): string;
+/**
+ * Build and return the `scope ci` command.
+ *
+ * The command runs the full pipeline, writes output,
+ * and calls `process.exit` with the appropriate exit code.
+ */
+declare function createCiCommand(): Command;
+
 /**
  * @agent-scope/cli — `scope init` command implementation
  *
@@ -418,4 +533,4 @@ declare function resolveTokenFilePath(fileFlag?: string): string;
  */
 declare function createTokensExportCommand(): Command;
 
-export { type CausalityLink, type ComponentHookProfile, type HookHeuristicFlag, type HookProfile, type HooksProfilingResult, type InitOptions, type InitResult, type InteractionProfile, type InteractionStep$1 as InteractionStep, type InteractionTiming, type LayoutShiftData, type ListRow, type ProfileHeuristicFlag, type QueryRow, type ReactScopeConfig, type RenderEvent, type RenderTrigger, type RendersAnalysisResult, type ScopeCLIOptions, createInitCommand, createInstrumentCommand, createManifestCommand, createProgram, createTokensCommand, createTokensExportCommand, isTTY, matchGlob, resolveTokenFilePath, runInit };
+export { CI_EXIT, type CausalityLink, type CiCheckName, type CiCheckResult, type CiExitCode, type CiOptions, type CiResult, type ComponentHookProfile, type HookHeuristicFlag, type HookProfile, type HooksProfilingResult, type InitOptions, type InitResult, type InteractionProfile, type InteractionStep$1 as InteractionStep, type InteractionTiming, type LayoutShiftData, type ListRow, type ProfileHeuristicFlag, type QueryRow, type ReactScopeConfig, type RenderEvent, type RenderTrigger, type RendersAnalysisResult, type ScopeCLIOptions, createCiCommand, createInitCommand, createInstrumentCommand, createManifestCommand, createProgram, createTokensCommand, createTokensExportCommand, formatCiReport, isTTY, matchGlob, resolveTokenFilePath, runCi, runInit };

package/dist/index.d.ts

@@ -1,6 +1,121 @@
 import { Command } from 'commander';
 import { ComplexityClass } from '@agent-scope/manifest';
 
+/**
+ * @agent-scope/cli — `scope ci` command
+ *
+ * Runs a non-interactive CI pipeline over the component library and exits
+ * with a structured exit code so the result can be consumed by CI systems.
+ *
+ * ## Pipeline steps (in order)
+ *
+ *   1. Generate the component manifest (discover all components)
+ *   2. Render all discovered components
+ *   3. Run token-compliance checks
+ *   4. Compare against baseline snapshot (if `--baseline` provided)
+ *
+ * ## Exit codes
+ *
+ *   0 — All checks passed
+ *   1 — Compliance below threshold
+ *   2 — Accessibility violations found (reserved; currently surfaced as info)
+ *   3 — Console errors during render
+ *   4 — Visual regression detected (pixel diff above threshold)
+ *   5 — Component render failures
+ *
+ * ## Usage
+ *
+ * ```bash
+ * scope ci
+ * scope ci --baseline .reactscope/baseline
+ * scope ci --checks compliance,console-errors
+ * scope ci --threshold 0.90 --json
+ * ```
+ */
+
+declare const CI_EXIT: {
+    /** All checks passed */
+    readonly OK: 0;
+    /** Compliance score below threshold */
+    readonly COMPLIANCE_BELOW_THRESHOLD: 1;
+    /** Accessibility violations found */
+    readonly A11Y_VIOLATIONS: 2;
+    /** Console errors detected during render */
+    readonly CONSOLE_ERRORS: 3;
+    /** Visual regression detected against baseline */
+    readonly VISUAL_REGRESSION: 4;
+    /** One or more components failed to render */
+    readonly RENDER_FAILURES: 5;
+};
+type CiExitCode = (typeof CI_EXIT)[keyof typeof CI_EXIT];
+type CiCheckName = "compliance" | "a11y" | "console-errors" | "visual-regression";
+interface CiCheckResult {
+    /** Which check this is */
+    check: CiCheckName;
+    /** Whether the check passed */
+    passed: boolean;
+    /** Human-readable summary */
+    message: string;
+    /** Numeric value for threshold-based checks */
+    value?: number;
+    /** Threshold that was applied */
+    threshold?: number;
+}
+interface CiResult {
+    /** ISO timestamp */
+    ranAt: string;
+    /** Whether the overall CI run passed (exit code 0) */
+    passed: boolean;
+    /** The resolved exit code */
+    exitCode: CiExitCode;
+    /** Per-check results */
+    checks: CiCheckResult[];
+    /** Component counts */
+    components: {
+        total: number;
+        rendered: number;
+        failed: number;
+    };
+    /** Aggregate compliance score (0–1) */
+    complianceScore: number;
+    /** Compliance threshold that was applied */
+    complianceThreshold: number;
+    /** Whether baseline comparison was performed */
+    baselineCompared: boolean;
+    /** Wall-clock duration in ms */
+    wallClockMs: number;
+}
+interface CiOptions {
+    /** Baseline directory to compare against. Omit to skip visual regression check. */
+    baselineDir?: string;
+    /** Which checks to run. Default: all */
+    checks?: CiCheckName[];
+    /** Compliance pass threshold (0–1). Default: 0.90 */
+    complianceThreshold?: number;
+    /** Viewport width. Default: 375 */
+    viewportWidth?: number;
+    /** Viewport height. Default: 812 */
+    viewportHeight?: number;
+}
+/**
+ * Run the full CI pipeline and return a structured CiResult.
+ *
+ * Does not call `process.exit` — callers are responsible for that so the
+ * function remains testable without side effects.
+ */
+declare function runCi(options?: CiOptions): Promise<CiResult>;
+/**
+ * Format a CiResult as the CI stdout summary (spec §4.2).
+ */
+declare function formatCiReport(result: CiResult): string;
+/**
+ * Build and return the `scope ci` command.
+ *
+ * The command runs the full pipeline, writes output,
+ * and calls `process.exit` with the appropriate exit code.
+ */
+declare function createCiCommand(): Command;
+
 /**
  * @agent-scope/cli — `scope init` command implementation
  *
@@ -418,4 +533,4 @@ declare function resolveTokenFilePath(fileFlag?: string): string;
  */
 declare function createTokensExportCommand(): Command;
 
-export { type CausalityLink, type ComponentHookProfile, type HookHeuristicFlag, type HookProfile, type HooksProfilingResult, type InitOptions, type InitResult, type InteractionProfile, type InteractionStep$1 as InteractionStep, type InteractionTiming, type LayoutShiftData, type ListRow, type ProfileHeuristicFlag, type QueryRow, type ReactScopeConfig, type RenderEvent, type RenderTrigger, type RendersAnalysisResult, type ScopeCLIOptions, createInitCommand, createInstrumentCommand, createManifestCommand, createProgram, createTokensCommand, createTokensExportCommand, isTTY, matchGlob, resolveTokenFilePath, runInit };
+export { CI_EXIT, type CausalityLink, type CiCheckName, type CiCheckResult, type CiExitCode, type CiOptions, type CiResult, type ComponentHookProfile, type HookHeuristicFlag, type HookProfile, type HooksProfilingResult, type InitOptions, type InitResult, type InteractionProfile, type InteractionStep$1 as InteractionStep, type InteractionTiming, type LayoutShiftData, type ListRow, type ProfileHeuristicFlag, type QueryRow, type ReactScopeConfig, type RenderEvent, type RenderTrigger, type RendersAnalysisResult, type ScopeCLIOptions, createCiCommand, createInitCommand, createInstrumentCommand, createManifestCommand, createProgram, createTokensCommand, createTokensExportCommand, formatCiReport, isTTY, matchGlob, resolveTokenFilePath, runCi, runInit };