@curl-runner/cli 1.9.0 → 1.11.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@curl-runner/cli",
-  "version": "1.9.0",
+  "version": "1.11.0",
   "description": "A powerful CLI tool for HTTP request management using YAML configuration",
   "type": "module",
   "main": "./dist/cli.js",

package/src/cli.ts

@@ -3,10 +3,17 @@
 import { Glob } from 'bun';
 import { RequestExecutor } from './executor/request-executor';
 import { YamlParser } from './parser/yaml';
-import type { ExecutionSummary, GlobalConfig, RequestConfig } from './types/config';
+import type {
+  ExecutionResult,
+  ExecutionSummary,
+  GlobalConfig,
+  RequestConfig,
+  WatchConfig,
+} from './types/config';
 import { Logger } from './utils/logger';
 import { VersionChecker } from './utils/version-checker';
 import { getVersion } from './version';
+import { FileWatcher } from './watcher/file-watcher';
 
 class CurlRunnerCLI {
   private logger = new Logger();
@@ -137,6 +144,60 @@ class CurlRunnerCLI {
       }
     }
 
+    // Watch mode configuration
+    if (process.env.CURL_RUNNER_WATCH) {
+      envConfig.watch = {
+        ...envConfig.watch,
+        enabled: process.env.CURL_RUNNER_WATCH.toLowerCase() === 'true',
+      };
+    }
+
+    if (process.env.CURL_RUNNER_WATCH_DEBOUNCE) {
+      envConfig.watch = {
+        ...envConfig.watch,
+        debounce: Number.parseInt(process.env.CURL_RUNNER_WATCH_DEBOUNCE, 10),
+      };
+    }
+
+    if (process.env.CURL_RUNNER_WATCH_CLEAR) {
+      envConfig.watch = {
+        ...envConfig.watch,
+        clear: process.env.CURL_RUNNER_WATCH_CLEAR.toLowerCase() !== 'false',
+      };
+    }
+
+    // Snapshot configuration
+    if (process.env.CURL_RUNNER_SNAPSHOT) {
+      envConfig.snapshot = {
+        ...envConfig.snapshot,
+        enabled: process.env.CURL_RUNNER_SNAPSHOT.toLowerCase() === 'true',
+      };
+    }
+
+    if (process.env.CURL_RUNNER_SNAPSHOT_UPDATE) {
+      const mode = process.env.CURL_RUNNER_SNAPSHOT_UPDATE.toLowerCase();
+      if (['none', 'all', 'failing'].includes(mode)) {
+        envConfig.snapshot = {
+          ...envConfig.snapshot,
+          updateMode: mode as 'none' | 'all' | 'failing',
+        };
+      }
+    }
+
+    if (process.env.CURL_RUNNER_SNAPSHOT_DIR) {
+      envConfig.snapshot = {
+        ...envConfig.snapshot,
+        dir: process.env.CURL_RUNNER_SNAPSHOT_DIR,
+      };
+    }
+
+    if (process.env.CURL_RUNNER_SNAPSHOT_CI) {
+      envConfig.snapshot = {
+        ...envConfig.snapshot,
+        ci: process.env.CURL_RUNNER_SNAPSHOT_CI.toLowerCase() === 'true',
+      };
+    }
+
     return envConfig;
   }
 
@@ -282,63 +343,139 @@ class CurlRunnerCLI {
         };
       }
 
+      // Apply snapshot options
+      if (options.snapshot !== undefined) {
+        globalConfig.snapshot = {
+          ...globalConfig.snapshot,
+          enabled: options.snapshot as boolean,
+        };
+      }
+      if (options.snapshotUpdate !== undefined) {
+        globalConfig.snapshot = {
+          ...globalConfig.snapshot,
+          enabled: true,
+          updateMode: options.snapshotUpdate as 'none' | 'all' | 'failing',
+        };
+      }
+      if (options.snapshotDir !== undefined) {
+        globalConfig.snapshot = {
+          ...globalConfig.snapshot,
+          dir: options.snapshotDir as string,
+        };
+      }
+      if (options.snapshotCi !== undefined) {
+        globalConfig.snapshot = {
+          ...globalConfig.snapshot,
+          ci: options.snapshotCi as boolean,
+        };
+      }
+
       if (allRequests.length === 0) {
         this.logger.logError('No requests found in YAML files');
         process.exit(1);
       }
 
-      const executor = new RequestExecutor(globalConfig);
-      let summary: ExecutionSummary;
+      // Check if watch mode is enabled
+      const watchEnabled = options.watch || globalConfig.watch?.enabled;
+
+      if (watchEnabled) {
+        // Build watch config from options and global config
+        const watchConfig: WatchConfig = {
+          enabled: true,
+          debounce:
+            (options.watchDebounce as number | undefined) ?? globalConfig.watch?.debounce ?? 300,
+          clear: (options.watchClear as boolean | undefined) ?? globalConfig.watch?.clear ?? true,
+        };
 
-      // If multiple files, execute them with file separators for clarity
-      if (fileGroups.length > 1) {
-        const allResults: ExecutionResult[] = [];
-        let totalDuration = 0;
+        const watcher = new FileWatcher({
+          files: yamlFiles,
+          config: watchConfig,
+          logger: this.logger,
+          onRun: async () => {
+            await this.executeRequests(yamlFiles, globalConfig);
+          },
+        });
 
-        for (let i = 0; i < fileGroups.length; i++) {
-          const group = fileGroups[i];
+        await watcher.start();
+      } else {
+        // Normal execution mode
+        const summary = await this.executeRequests(yamlFiles, globalConfig);
+        const exitCode = this.determineExitCode(summary, globalConfig);
+        process.exit(exitCode);
+      }
+    } catch (error) {
+      this.logger.logError(error instanceof Error ? error.message : String(error));
+      process.exit(1);
+    }
+  }
 
-          // Show file header for better organization
-          this.logger.logFileHeader(group.file, group.requests.length);
+  private async executeRequests(
+    yamlFiles: string[],
+    globalConfig: GlobalConfig,
+  ): Promise<ExecutionSummary> {
+    // Process YAML files and collect requests
+    const fileGroups: Array<{ file: string; requests: RequestConfig[]; config?: GlobalConfig }> =
+      [];
+    const allRequests: RequestConfig[] = [];
+
+    for (const file of yamlFiles) {
+      const { requests, config } = await this.processYamlFile(file);
+
+      const fileOutputConfig = config?.output || {};
+      const requestsWithSourceConfig = requests.map((request) => ({
+        ...request,
+        sourceOutputConfig: fileOutputConfig,
+        sourceFile: file,
+      }));
+
+      fileGroups.push({ file, requests: requestsWithSourceConfig, config });
+      allRequests.push(...requestsWithSourceConfig);
+    }
 
-          const fileSummary = await executor.execute(group.requests);
-          allResults.push(...fileSummary.results);
-          totalDuration += fileSummary.duration;
+    const executor = new RequestExecutor(globalConfig);
+    let summary: ExecutionSummary;
 
-          // Don't show individual file summaries for cleaner output
+    // If multiple files, execute them with file separators for clarity
+    if (fileGroups.length > 1) {
+      const allResults: ExecutionResult[] = [];
+      let totalDuration = 0;
 
-          // Add spacing between files (except for the last one)
-          if (i < fileGroups.length - 1) {
-            console.log();
-          }
-        }
+      for (let i = 0; i < fileGroups.length; i++) {
+        const group = fileGroups[i];
 
-        // Create combined summary
-        const successful = allResults.filter((r) => r.success).length;
-        const failed = allResults.filter((r) => !r.success).length;
+        // Show file header for better organization
+        this.logger.logFileHeader(group.file, group.requests.length);
 
-        summary = {
-          total: allResults.length,
-          successful,
-          failed,
-          duration: totalDuration,
-          results: allResults,
-        };
+        const fileSummary = await executor.execute(group.requests);
+        allResults.push(...fileSummary.results);
+        totalDuration += fileSummary.duration;
 
-        // Show final summary
-        executor.logger.logSummary(summary, true);
-      } else {
-        // Single file - use normal execution
-        summary = await executor.execute(allRequests);
+        // Add spacing between files (except for the last one)
+        if (i < fileGroups.length - 1) {
+          console.log();
+        }
       }
 
-      // Determine exit code based on CI configuration
-      const exitCode = this.determineExitCode(summary, globalConfig);
-      process.exit(exitCode);
-    } catch (error) {
-      this.logger.logError(error instanceof Error ? error.message : String(error));
-      process.exit(1);
+      // Create combined summary
+      const successful = allResults.filter((r) => r.success).length;
+      const failed = allResults.filter((r) => !r.success).length;
+
+      summary = {
+        total: allResults.length,
+        successful,
+        failed,
+        duration: totalDuration,
+        results: allResults,
+      };
+
+      // Show final summary
+      this.logger.logSummary(summary, true);
+    } else {
+      // Single file - use normal execution
+      summary = await executor.execute(allRequests);
     }
+
+    return summary;
   }
 
   private parseArguments(args: string[]): { files: string[]; options: Record<string, unknown> } {
@@ -366,6 +503,20 @@ class CurlRunnerCLI {
           options.showMetrics = true;
         } else if (key === 'strict-exit') {
           options.strictExit = true;
+        } else if (key === 'watch') {
+          options.watch = true;
+        } else if (key === 'watch-clear') {
+          options.watchClear = true;
+        } else if (key === 'no-watch-clear') {
+          options.watchClear = false;
+        } else if (key === 'snapshot') {
+          options.snapshot = true;
+        } else if (key === 'update-snapshots') {
+          options.snapshotUpdate = 'all';
+        } else if (key === 'update-failing') {
+          options.snapshotUpdate = 'failing';
+        } else if (key === 'ci-snapshot') {
+          options.snapshotCi = true;
         } else if (nextArg && !nextArg.startsWith('--')) {
           if (key === 'continue-on-error') {
             options.continueOnError = nextArg === 'true';
@@ -397,6 +548,10 @@ class CurlRunnerCLI {
             if (['minimal', 'standard', 'detailed'].includes(nextArg)) {
               options.prettyLevel = nextArg;
             }
+          } else if (key === 'watch-debounce') {
+            options.watchDebounce = Number.parseInt(nextArg, 10);
+          } else if (key === 'snapshot-dir') {
+            options.snapshotDir = nextArg;
           } else {
             options[key] = nextArg;
           }
@@ -423,6 +578,15 @@ class CurlRunnerCLI {
             case 'q':
               options.quiet = true;
               break;
+            case 'w':
+              options.watch = true;
+              break;
+            case 's':
+              options.snapshot = true;
+              break;
+            case 'u':
+              options.snapshotUpdate = 'all';
+              break;
             case 'o': {
               // Handle -o flag for output file
               const outputArg = args[i + 1];
@@ -551,6 +715,8 @@ class CurlRunnerCLI {
       output: { ...base.output, ...override.output },
       defaults: { ...base.defaults, ...override.defaults },
       ci: { ...base.ci, ...override.ci },
+      watch: { ...base.watch, ...override.watch },
+      snapshot: { ...base.snapshot, ...override.snapshot },
     };
   }
 
@@ -633,11 +799,23 @@ ${this.logger.color('OPTIONS:', 'yellow')}
   --show-metrics                Include performance metrics in output
   --version                     Show version
 
+${this.logger.color('WATCH MODE:', 'yellow')}
+  -w, --watch                   Watch files and re-run on changes
+  --watch-debounce <ms>         Debounce delay for watch mode (default: 300)
+  --no-watch-clear              Don't clear screen between watch runs
+
 ${this.logger.color('CI/CD OPTIONS:', 'yellow')}
   --strict-exit                 Exit with code 1 if any validation fails (for CI/CD)
   --fail-on <count>             Exit with code 1 if failures exceed this count
   --fail-on-percentage <pct>    Exit with code 1 if failure percentage exceeds this value
 
+${this.logger.color('SNAPSHOT OPTIONS:', 'yellow')}
+  -s, --snapshot                Enable snapshot testing
+  -u, --update-snapshots        Update all snapshots
+  --update-failing              Update only failing snapshots
+  --snapshot-dir <dir>          Custom snapshot directory (default: __snapshots__)
+  --ci-snapshot                 Fail if snapshot is missing (CI mode)
+
 ${this.logger.color('EXAMPLES:', 'yellow')}
   # Run all YAML files in current directory
   curl-runner
@@ -681,6 +859,21 @@ ${this.logger.color('EXAMPLES:', 'yellow')}
   # CI/CD: Allow up to 10% failures
   curl-runner tests/ --fail-on-percentage 10
 
+  # Watch mode - re-run on file changes
+  curl-runner api.yaml --watch
+
+  # Watch with custom debounce
+  curl-runner tests/ -w --watch-debounce 500
+
+  # Snapshot testing - save and compare responses
+  curl-runner api.yaml --snapshot
+
+  # Update all snapshots
+  curl-runner api.yaml -su
+
+  # CI mode - fail if snapshot missing
+  curl-runner api.yaml --snapshot --ci-snapshot
+
 ${this.logger.color('YAML STRUCTURE:', 'yellow')}
   Single request:
     request:

package/src/executor/request-executor.ts

@@ -1,4 +1,5 @@
 import { YamlParser } from '../parser/yaml';
+import { SnapshotManager } from '../snapshot/snapshot-manager';
 import type {
   ExecutionResult,
   ExecutionSummary,
@@ -8,6 +9,7 @@ import type {
   JsonValue,
   RequestConfig,
   ResponseStoreContext,
+  SnapshotConfig,
 } from '../types/config';
 import { CurlBuilder } from '../utils/curl-builder';
 import { Logger } from '../utils/logger';
@@ -16,10 +18,12 @@ import { createStoreContext, extractStoreValues } from '../utils/response-store'
 export class RequestExecutor {
   private logger: Logger;
   private globalConfig: GlobalConfig;
+  private snapshotManager: SnapshotManager;
 
   constructor(globalConfig: GlobalConfig = {}) {
     this.globalConfig = globalConfig;
     this.logger = new Logger(globalConfig.output);
+    this.snapshotManager = new SnapshotManager(globalConfig.snapshot);
   }
 
   private mergeOutputConfig(config: RequestConfig): GlobalConfig['output'] {
@@ -30,6 +34,13 @@ export class RequestExecutor {
     };
   }
 
+  /**
+   * Gets the effective snapshot config for a request.
+   */
+  private getSnapshotConfig(config: RequestConfig): SnapshotConfig | null {
+    return SnapshotManager.mergeConfig(this.globalConfig.snapshot, config.snapshot);
+  }
+
   /**
    * Checks if a form field value is a file attachment.
    */
@@ -102,7 +113,7 @@ export class RequestExecutor {
         requestLogger.logRetry(attempt, maxAttempts - 1);
         if (config.retry?.delay) {
           const backoff = config.retry.backoff ?? 1;
-          const delay = config.retry.delay * Math.pow(backoff, attempt - 1);
+          const delay = config.retry.delay * backoff ** (attempt - 1);
           await Bun.sleep(delay);
         }
       }
@@ -140,6 +151,25 @@ export class RequestExecutor {
           }
         }
 
+        // Snapshot testing
+        const snapshotConfig = this.getSnapshotConfig(config);
+        if (snapshotConfig && config.sourceFile) {
+          const snapshotResult = await this.snapshotManager.compareAndUpdate(
+            config.sourceFile,
+            config.name || 'Request',
+            executionResult,
+            snapshotConfig,
+          );
+          executionResult.snapshotResult = snapshotResult;
+
+          if (!snapshotResult.match && !snapshotResult.updated) {
+            executionResult.success = false;
+            if (!executionResult.error) {
+              executionResult.error = 'Snapshot mismatch';
+            }
+          }
+        }
+
         requestLogger.logRequestComplete(executionResult);
         return executionResult;
       }

package/src/snapshot/index.ts

@@ -0,0 +1,3 @@
+export { SnapshotDiffer } from './snapshot-differ';
+export { SnapshotFormatter, type SnapshotStats } from './snapshot-formatter';
+export { filterSnapshotBody, SnapshotManager } from './snapshot-manager';