agent-gauntlet 0.10.0 → 0.11.0

package/src/config/loader.ts

@@ -1,301 +0,0 @@
-import fs from "node:fs/promises";
-import path from "node:path";
-import matter from "gray-matter";
-import YAML from "yaml";
-import {
-	isBuiltInReview,
-	loadBuiltInReview,
-} from "../built-in-reviews/index.js";
-import {
-	checkGateSchema,
-	gauntletConfigSchema,
-	reviewPromptFrontmatterSchema,
-	reviewYamlSchema,
-} from "./schema.js";
-import type {
-	CheckGateConfig,
-	LoadedCheckGateConfig,
-	LoadedConfig,
-	LoadedReviewGateConfig,
-} from "./types.js";
-
-const GAUNTLET_DIR = ".gauntlet";
-const CONFIG_FILE = "config.yml";
-const CHECKS_DIR = "checks";
-const REVIEWS_DIR = "reviews";
-
-export async function loadConfig(
-	rootDir: string = process.cwd(),
-): Promise<LoadedConfig> {
-	const gauntletPath = path.join(rootDir, GAUNTLET_DIR);
-	const configPath = path.join(gauntletPath, CONFIG_FILE);
-
-	// 1. Load project config
-	if (!(await fileExists(configPath))) {
-		throw new Error(`Configuration file not found at ${configPath}`);
-	}
-
-	const configContent = await fs.readFile(configPath, "utf-8");
-	const projectConfigRaw = YAML.parse(configContent);
-	const projectConfig = gauntletConfigSchema.parse(projectConfigRaw);
-
-	// 2. Load checks
-	const checksPath = path.join(gauntletPath, CHECKS_DIR);
-	const checks: Record<string, LoadedCheckGateConfig> = {};
-
-	if (await dirExists(checksPath)) {
-		const checkFiles = await fs.readdir(checksPath);
-		for (const file of checkFiles) {
-			if (file.endsWith(".yml") || file.endsWith(".yaml")) {
-				const filePath = path.join(checksPath, file);
-				const content = await fs.readFile(filePath, "utf-8");
-				const raw = YAML.parse(content);
-				const name = path.basename(file, path.extname(file));
-				const parsed: CheckGateConfig = checkGateSchema.parse(raw);
-
-				// Normalize deprecated alias in loader (not schema) for reliability
-				const fixFile = parsed.fix_instructions_file || parsed.fix_instructions;
-
-				const loadedCheck: LoadedCheckGateConfig = {
-					...parsed,
-					name,
-				};
-
-				// Load fix instructions file if specified
-				if (fixFile) {
-					loadedCheck.fixInstructionsContent = await loadPromptFile(
-						fixFile,
-						gauntletPath,
-						`check "${name}"`,
-					);
-				}
-
-				// Store fix_with_skill if specified
-				if (parsed.fix_with_skill) {
-					loadedCheck.fixWithSkill = parsed.fix_with_skill;
-				}
-
-				checks[name] = loadedCheck;
-			}
-		}
-	}
-
-	// 3. Load reviews (prompts + frontmatter from .md, or .yml/.yaml configs)
-	const reviewsPath = path.join(gauntletPath, REVIEWS_DIR);
-	const reviews: LoadedConfig["reviews"] = {};
-
-	if (await dirExists(reviewsPath)) {
-		const reviewFiles = await fs.readdir(reviewsPath);
-
-		// Detect duplicate names across formats
-		const reviewNameSources = new Map<string, string[]>();
-		for (const file of reviewFiles) {
-			if (
-				file.endsWith(".md") ||
-				file.endsWith(".yml") ||
-				file.endsWith(".yaml")
-			) {
-				const name = path.basename(file, path.extname(file));
-
-				// Reject user-defined review files with the reserved built-in: prefix
-				if (isBuiltInReview(name)) {
-					throw new Error(
-						`Review file "${file}" uses the reserved "built-in:" prefix. Rename the file to avoid conflicts with built-in reviews.`,
-					);
-				}
-
-				const sources = reviewNameSources.get(name) || [];
-				sources.push(file);
-				reviewNameSources.set(name, sources);
-			}
-		}
-		for (const [name, sources] of reviewNameSources) {
-			if (sources.length > 1) {
-				throw new Error(
-					`Duplicate review name "${name}" found across files: ${sources.join(", ")}. Each review name must be unique.`,
-				);
-			}
-		}
-
-		for (const file of reviewFiles) {
-			if (file.endsWith(".md")) {
-				// Markdown review file
-				const filePath = path.join(reviewsPath, file);
-				const content = await fs.readFile(filePath, "utf-8");
-				const { data: frontmatter, content: promptBody } = matter(content);
-
-				const parsedFrontmatter =
-					reviewPromptFrontmatterSchema.parse(frontmatter);
-				const name = path.basename(file, ".md");
-
-				const review: LoadedReviewGateConfig = {
-					name,
-					prompt: file,
-					promptContent: promptBody,
-					model: parsedFrontmatter.model,
-					cli_preference: parsedFrontmatter.cli_preference,
-					num_reviews: parsedFrontmatter.num_reviews,
-					parallel: parsedFrontmatter.parallel,
-					run_in_ci: parsedFrontmatter.run_in_ci,
-					run_locally: parsedFrontmatter.run_locally,
-					timeout: parsedFrontmatter.timeout,
-				};
-
-				// If prompt_file is specified, override the markdown body
-				if (parsedFrontmatter.prompt_file) {
-					review.promptContent = await loadPromptFile(
-						parsedFrontmatter.prompt_file,
-						gauntletPath,
-						`review "${name}"`,
-					);
-				}
-
-				// If skill_name is specified, ignore body and set skillName
-				if (parsedFrontmatter.skill_name) {
-					review.promptContent = undefined;
-					review.skillName = parsedFrontmatter.skill_name;
-				}
-
-				reviews[name] = review;
-			} else if (file.endsWith(".yml") || file.endsWith(".yaml")) {
-				// YAML review file
-				const filePath = path.join(reviewsPath, file);
-				const content = await fs.readFile(filePath, "utf-8");
-				const raw = YAML.parse(content);
-				const parsed = reviewYamlSchema.parse(raw);
-				const name = path.basename(file, path.extname(file));
-
-				const review: LoadedReviewGateConfig = {
-					name,
-					prompt: file,
-					model: parsed.model,
-					cli_preference: parsed.cli_preference,
-					num_reviews: parsed.num_reviews,
-					parallel: parsed.parallel,
-					run_in_ci: parsed.run_in_ci,
-					run_locally: parsed.run_locally,
-					timeout: parsed.timeout,
-				};
-
-				if (parsed.prompt_file) {
-					review.promptContent = await loadPromptFile(
-						parsed.prompt_file,
-						gauntletPath,
-						`review "${name}"`,
-					);
-				}
-
-				if (parsed.skill_name) {
-					review.skillName = parsed.skill_name;
-				}
-
-				if (parsed.builtin) {
-					review.promptContent = loadBuiltInReview(parsed.builtin);
-				}
-
-				reviews[name] = review;
-			}
-		}
-	}
-
-	// 3b. Merge default CLI preference if not specified (applies to all reviews)
-	for (const [name, review] of Object.entries(reviews)) {
-		if (!review.cli_preference) {
-			review.cli_preference = projectConfig.cli.default_preference;
-		} else {
-			const allowedTools = new Set(projectConfig.cli.default_preference);
-			for (const tool of review.cli_preference) {
-				if (!allowedTools.has(tool)) {
-					throw new Error(
-						`Review "${name}" uses CLI tool "${tool}" which is not in the project-level allowed list (cli.default_preference).`,
-					);
-				}
-			}
-		}
-	}
-
-	// 4. Validate entry point references
-	const checkNames = new Set(Object.keys(checks));
-	const reviewNames = new Set(Object.keys(reviews));
-
-	for (const entryPoint of projectConfig.entry_points) {
-		if (entryPoint.checks) {
-			for (const checkName of entryPoint.checks) {
-				if (!checkNames.has(checkName)) {
-					throw new Error(
-						`Entry point "${entryPoint.path}" references non-existent check gate: "${checkName}"`,
-					);
-				}
-			}
-		}
-		if (entryPoint.reviews) {
-			for (const reviewName of entryPoint.reviews) {
-				if (!reviewNames.has(reviewName)) {
-					throw new Error(
-						`Entry point "${entryPoint.path}" references non-existent review gate: "${reviewName}"`,
-					);
-				}
-			}
-		}
-	}
-
-	return {
-		project: projectConfig,
-		checks,
-		reviews,
-	};
-}
-
-async function loadPromptFile(
-	filePath: string,
-	gauntletPath: string,
-	source: string,
-): Promise<string> {
-	let resolvedPath: string;
-	if (path.isAbsolute(filePath)) {
-		console.warn(
-			`Warning: ${source} uses absolute path "${filePath}". Prefer relative paths for portability.`,
-		);
-		resolvedPath = filePath;
-	} else {
-		resolvedPath = path.resolve(gauntletPath, filePath);
-	}
-	// Warn if resolved path escapes the .gauntlet/ directory (including via relative traversal)
-	const normalizedGauntletPath = path.resolve(gauntletPath);
-	const relativeToDotGauntlet = path.relative(
-		normalizedGauntletPath,
-		resolvedPath,
-	);
-	if (
-		relativeToDotGauntlet.startsWith("..") ||
-		path.isAbsolute(relativeToDotGauntlet)
-	) {
-		console.warn(
-			`Warning: ${source} references file outside .gauntlet/ directory: "${filePath}" (resolves to ${resolvedPath}). Review .gauntlet/ config changes carefully in PRs.`,
-		);
-	}
-	if (!(await fileExists(resolvedPath))) {
-		throw new Error(
-			`File not found: ${resolvedPath} (referenced by ${source})`,
-		);
-	}
-	return fs.readFile(resolvedPath, "utf-8");
-}
-
-async function fileExists(path: string): Promise<boolean> {
-	try {
-		const stat = await fs.stat(path);
-		return stat.isFile();
-	} catch {
-		return false;
-	}
-}
-
-async function dirExists(path: string): Promise<boolean> {
-	try {
-		const stat = await fs.stat(path);
-		return stat.isDirectory();
-	} catch {
-		return false;
-	}
-}

package/src/config/schema.ts

@@ -1,165 +0,0 @@
-import { z } from "zod";
-
-export const adapterConfigSchema = z.object({
-	allow_tool_use: z.boolean().default(true),
-	thinking_budget: z.enum(["off", "low", "medium", "high"]).optional(),
-});
-
-export const cliConfigSchema = z.object({
-	default_preference: z.array(z.string().min(1)).min(1),
-	adapters: z.record(z.string(), adapterConfigSchema).optional(),
-});
-
-export const checkGateSchema = z
-	.object({
-		command: z.string().min(1),
-		rerun_command: z.string().min(1).optional(),
-		working_directory: z.string().optional(),
-		parallel: z.boolean().default(false),
-		run_in_ci: z.boolean().default(true),
-		run_locally: z.boolean().default(true),
-		timeout: z.number().optional(),
-		fail_fast: z.boolean().optional(),
-		fix_instructions: z.string().optional(), // Deprecated alias for fix_instructions_file
-		fix_instructions_file: z.string().optional(),
-		fix_with_skill: z.string().optional(),
-	})
-	.superRefine((data, ctx) => {
-		// fail_fast can only be used when parallel is false
-		if (data.fail_fast === true && data.parallel === true) {
-			ctx.addIssue({
-				code: z.ZodIssueCode.custom,
-				message: "fail_fast can only be used when parallel is false",
-			});
-		}
-		// Cannot specify both deprecated fix_instructions and fix_instructions_file
-		if (data.fix_instructions && data.fix_instructions_file) {
-			ctx.addIssue({
-				code: z.ZodIssueCode.custom,
-				message:
-					"Cannot specify both 'fix_instructions' (deprecated) and 'fix_instructions_file'. Use only 'fix_instructions_file'.",
-			});
-		}
-		// fix_instructions_file (or its deprecated alias) and fix_with_skill are mutually exclusive
-		const effectiveFixFile =
-			data.fix_instructions_file || data.fix_instructions;
-		if (effectiveFixFile && data.fix_with_skill) {
-			ctx.addIssue({
-				code: z.ZodIssueCode.custom,
-				message:
-					"'fix_instructions_file' and 'fix_with_skill' are mutually exclusive. Specify only one.",
-			});
-		}
-	});
-
-export const reviewGateSchema = z.object({
-	name: z.string().min(1),
-	prompt: z.string().min(1), // Path relative to .gauntlet/reviews/
-	cli_preference: z.array(z.string().min(1)).optional(),
-	num_reviews: z.number().default(1),
-	parallel: z.boolean().default(true),
-	run_in_ci: z.boolean().default(true),
-	run_locally: z.boolean().default(true),
-	timeout: z.number().optional(),
-});
-
-export const reviewPromptFrontmatterSchema = z
-	.object({
-		model: z.string().optional(),
-		cli_preference: z.array(z.string().min(1)).optional(),
-		num_reviews: z.number().default(1),
-		parallel: z.boolean().default(true),
-		run_in_ci: z.boolean().default(true),
-		run_locally: z.boolean().default(true),
-		timeout: z.number().optional(),
-		prompt_file: z.string().optional(),
-		skill_name: z.string().optional(),
-	})
-	.refine((data) => !(data.prompt_file && data.skill_name), {
-		message:
-			"'prompt_file' and 'skill_name' are mutually exclusive. Specify only one.",
-	});
-
-export const reviewYamlSchema = z
-	.object({
-		model: z.string().optional(),
-		cli_preference: z.array(z.string().min(1)).optional(),
-		num_reviews: z.number().default(1),
-		parallel: z.boolean().default(true),
-		run_in_ci: z.boolean().default(true),
-		run_locally: z.boolean().default(true),
-		timeout: z.number().optional(),
-		prompt_file: z.string().optional(),
-		skill_name: z.string().optional(),
-		builtin: z.string().optional(),
-	})
-	.superRefine((data, ctx) => {
-		const sources = [data.prompt_file, data.skill_name, data.builtin].filter(
-			Boolean,
-		);
-		if (sources.length > 1) {
-			ctx.addIssue({
-				code: z.ZodIssueCode.custom,
-				message:
-					"'prompt_file', 'skill_name', and 'builtin' are mutually exclusive. Specify only one.",
-			});
-		}
-		if (sources.length === 0) {
-			ctx.addIssue({
-				code: z.ZodIssueCode.custom,
-				message:
-					"YAML review files must specify exactly one of 'prompt_file', 'skill_name', or 'builtin'.",
-			});
-		}
-	});
-
-export const entryPointSchema = z.object({
-	path: z.string().min(1),
-	exclude: z.array(z.string().min(1)).optional(),
-	checks: z.array(z.string().min(1)).optional(),
-	reviews: z.array(z.string().min(1)).optional(),
-});
-
-export const debugLogConfigSchema = z.object({
-	enabled: z.boolean().default(false),
-	max_size_mb: z.number().default(10),
-});
-
-export const loggingConsoleConfigSchema = z.object({
-	enabled: z.boolean().default(true),
-	format: z.enum(["pretty", "json"]).default("pretty"),
-});
-
-export const loggingFileConfigSchema = z.object({
-	enabled: z.boolean().default(true),
-	format: z.enum(["text", "json"]).default("text"),
-});
-
-export const loggingConfigSchema = z.object({
-	level: z.enum(["debug", "info", "warning", "error"]).default("debug"),
-	console: loggingConsoleConfigSchema.optional(),
-	file: loggingFileConfigSchema.optional(),
-});
-
-export const stopHookConfigSchema = z.object({
-	enabled: z.boolean().optional(),
-	run_interval_minutes: z.number().int().min(0).optional(),
-	auto_push_pr: z.boolean().optional(),
-	auto_fix_pr: z.boolean().optional(),
-});
-
-export const gauntletConfigSchema = z.object({
-	base_branch: z.string().min(1).default("origin/main"),
-	log_dir: z.string().min(1).default("gauntlet_logs"),
-	allow_parallel: z.boolean().default(true),
-	max_retries: z.number().default(3),
-	max_previous_logs: z.number().int().min(0).default(3),
-	rerun_new_issue_threshold: z
-		.enum(["critical", "high", "medium", "low"])
-		.default("medium"),
-	cli: cliConfigSchema,
-	entry_points: z.array(entryPointSchema).min(1),
-	debug_log: debugLogConfigSchema.optional(),
-	logging: loggingConfigSchema.optional(),
-	stop_hook: stopHookConfigSchema.optional(),
-});

package/src/config/stop-hook-config.ts

@@ -1,130 +0,0 @@
-import type { z } from "zod";
-import type { GlobalConfig } from "./global.js";
-import type { stopHookConfigSchema } from "./schema.js";
-
-/**
- * Environment variable names for stop hook configuration.
- */
-export const GAUNTLET_STOP_HOOK_ENABLED = "GAUNTLET_STOP_HOOK_ENABLED";
-export const GAUNTLET_STOP_HOOK_INTERVAL_MINUTES =
-	"GAUNTLET_STOP_HOOK_INTERVAL_MINUTES";
-export const GAUNTLET_AUTO_PUSH_PR = "GAUNTLET_AUTO_PUSH_PR";
-export const GAUNTLET_AUTO_FIX_PR = "GAUNTLET_AUTO_FIX_PR";
-
-/**
- * Resolved stop hook configuration.
- */
-export interface StopHookConfig {
-	enabled: boolean;
-	run_interval_minutes: number;
-	auto_push_pr: boolean;
-	auto_fix_pr: boolean;
-}
-
-type ProjectStopHookConfig = z.infer<typeof stopHookConfigSchema> | undefined;
-
-/**
- * Parse a boolean environment variable (accepts "true", "1", "false", "0").
- * Returns undefined for unset or invalid values.
- */
-function parseBooleanEnv(envVar: string | undefined): boolean | undefined {
-	if (envVar === undefined) return undefined;
-	const normalized = envVar.toLowerCase().trim();
-	if (normalized === "true" || normalized === "1") return true;
-	if (normalized === "false" || normalized === "0") return false;
-	return undefined;
-}
-
-/**
- * Parse an integer environment variable (accepts non-negative integers only).
- * Returns undefined for unset or invalid values.
- */
-function parseIntegerEnv(envVar: string | undefined): number | undefined {
-	if (envVar === undefined) return undefined;
-	const normalized = envVar.trim();
-	const parsed = Number(normalized);
-	if (normalized.length > 0 && Number.isInteger(parsed) && parsed >= 0) {
-		return parsed;
-	}
-	return undefined;
-}
-
-/**
- * Parse environment variables for stop hook configuration.
- * Returns undefined for fields that are not set or have invalid values.
- */
-export function parseStopHookEnvVars(): {
-	enabled?: boolean;
-	run_interval_minutes?: number;
-	auto_push_pr?: boolean;
-	auto_fix_pr?: boolean;
-} {
-	return {
-		enabled: parseBooleanEnv(process.env[GAUNTLET_STOP_HOOK_ENABLED]),
-		run_interval_minutes: parseIntegerEnv(
-			process.env[GAUNTLET_STOP_HOOK_INTERVAL_MINUTES],
-		),
-		auto_push_pr: parseBooleanEnv(process.env[GAUNTLET_AUTO_PUSH_PR]),
-		auto_fix_pr: parseBooleanEnv(process.env[GAUNTLET_AUTO_FIX_PR]),
-	};
-}
-
-/**
- * Resolve a single config field with 3-tier precedence: env > project > global.
- */
-function resolveField<T>(
-	envValue: T | undefined,
-	projectValue: T | undefined,
-	globalValue: T,
-): T {
-	if (envValue !== undefined) return envValue;
-	if (projectValue !== undefined) return projectValue;
-	return globalValue;
-}
-
-/**
- * Resolve stop hook configuration from three sources with precedence:
- * 1. Environment variables (highest)
- * 2. Project config (.gauntlet/config.yml)
- * 3. Global config (~/.config/agent-gauntlet/config.yml) (lowest)
- *
- * Each field is resolved independently.
- */
-export function resolveStopHookConfig(
-	projectConfig: ProjectStopHookConfig,
-	globalConfig: GlobalConfig,
-): StopHookConfig {
-	const envVars = parseStopHookEnvVars();
-	const globalStop = globalConfig.stop_hook;
-
-	const enabled = resolveField(
-		envVars.enabled,
-		projectConfig?.enabled,
-		globalStop.enabled,
-	);
-	const run_interval_minutes = resolveField(
-		envVars.run_interval_minutes,
-		projectConfig?.run_interval_minutes,
-		globalStop.run_interval_minutes,
-	);
-	const auto_push_pr = resolveField(
-		envVars.auto_push_pr,
-		projectConfig?.auto_push_pr,
-		globalStop.auto_push_pr,
-	);
-	let auto_fix_pr = resolveField(
-		envVars.auto_fix_pr,
-		projectConfig?.auto_fix_pr,
-		globalStop.auto_fix_pr,
-	);
-
-	// Validation: auto_fix_pr requires auto_push_pr
-	if (auto_fix_pr && !auto_push_pr) {
-		console.error(
-			"[gauntlet] Warning: auto_fix_pr=true requires auto_push_pr=true. Treating auto_fix_pr as false.",
-		);
-		auto_fix_pr = false;
-	}
-
-	return { enabled, run_interval_minutes, auto_push_pr, auto_fix_pr };
-}

package/src/config/types.ts

@@ -1,65 +0,0 @@
-import type { z } from "zod";
-import type {
-	ciCheckConfigSchema,
-	ciConfigSchema,
-	ciSetupStepSchema,
-	runtimeConfigSchema,
-	serviceConfigSchema,
-} from "./ci-schema.js";
-import type {
-	adapterConfigSchema,
-	checkGateSchema,
-	cliConfigSchema,
-	entryPointSchema,
-	gauntletConfigSchema,
-	reviewGateSchema,
-	reviewPromptFrontmatterSchema,
-	reviewYamlSchema,
-} from "./schema.js";
-
-export type CheckGateConfig = z.infer<typeof checkGateSchema>;
-export type ReviewGateConfig = z.infer<typeof reviewGateSchema>;
-export type ReviewPromptFrontmatter = z.infer<
-	typeof reviewPromptFrontmatterSchema
->;
-export type EntryPointConfig = z.infer<typeof entryPointSchema>;
-export type GauntletConfig = z.infer<typeof gauntletConfigSchema>;
-export type CLIConfig = z.infer<typeof cliConfigSchema>;
-export type AdapterConfig = z.infer<typeof adapterConfigSchema>;
-
-export type CIConfig = z.infer<typeof ciConfigSchema>;
-export type CICheckConfig = z.infer<typeof ciCheckConfigSchema>;
-export type CISetupStep = z.infer<typeof ciSetupStepSchema>;
-export type RuntimeConfig = z.infer<typeof runtimeConfigSchema>;
-export type ServiceConfig = z.infer<typeof serviceConfigSchema>;
-
-export type ReviewYamlConfig = z.infer<typeof reviewYamlSchema>;
-
-// Extended check config with loaded content
-export interface LoadedCheckGateConfig extends CheckGateConfig {
-	name: string;
-	fixInstructionsContent?: string;
-	fixWithSkill?: string;
-}
-
-// Extended review config with loaded content
-export interface LoadedReviewGateConfig {
-	name: string;
-	prompt: string; // filename or source identifier
-	promptContent?: string; // loaded prompt content (undefined when skill_name is used)
-	skillName?: string; // CLI skill name for prompt delegation
-	model?: string;
-	cli_preference?: string[];
-	num_reviews: number;
-	parallel: boolean;
-	run_in_ci: boolean;
-	run_locally: boolean;
-	timeout?: number;
-}
-
-// Combined type for the fully loaded configuration
-export interface LoadedConfig {
-	project: GauntletConfig;
-	checks: Record<string, LoadedCheckGateConfig>;
-	reviews: Record<string, LoadedReviewGateConfig>;
-}