git-shots-cli 0.1.2 → 0.2.0

package/src/index.ts

@@ -1,121 +1,140 @@
-#!/usr/bin/env node
-import { Command } from 'commander';
-import { loadConfig } from './config.js';
-import { upload } from './upload.js';
-import { compare } from './compare.js';
-import { status } from './status.js';
-import { pullBaselines } from './pull-baselines.js';
-import { review } from './review.js';
-
-const program = new Command();
-
-program
-	.name('git-shots')
-	.description('CLI for git-shots visual regression platform')
-	.version('0.1.0');
-
-program
-	.command('upload')
-	.description('Upload screenshots to git-shots')
-	.option('-p, --project <slug>', 'Project slug')
-	.option('-s, --server <url>', 'Server URL')
-	.option('-d, --directory <path>', 'Screenshots directory')
-	.option('-b, --branch <name>', 'Git branch (auto-detected)')
-	.option('--sha <hash>', 'Git SHA (auto-detected)')
-	.action(async (options) => {
-		const config = loadConfig();
-		if (options.project) config.project = options.project;
-		if (options.server) config.server = options.server;
-		if (options.directory) config.directory = options.directory;
-		if (!config.project) {
-			console.error('Error: project slug required. Use --project or .git-shots.json');
-			process.exit(1);
-		}
-		await upload(config, { branch: options.branch, sha: options.sha });
-	});
-
-program
-	.command('compare')
-	.description('Compare screenshots between branches')
-	.requiredOption('--head <branch>', 'Head branch to compare')
-	.option('-p, --project <slug>', 'Project slug')
-	.option('-s, --server <url>', 'Server URL')
-	.option('--base <branch>', 'Base branch (default: main)')
-	.option('-t, --threshold <number>', 'Mismatch threshold 0-1', parseFloat)
-	.action(async (options) => {
-		const config = loadConfig();
-		if (options.project) config.project = options.project;
-		if (options.server) config.server = options.server;
-		if (!config.project) {
-			console.error('Error: project slug required. Use --project or .git-shots.json');
-			process.exit(1);
-		}
-		await compare(config, { base: options.base, head: options.head, threshold: options.threshold });
-	});
-
-program
-	.command('status')
-	.description('Show current diff status')
-	.option('-p, --project <slug>', 'Project slug')
-	.option('-s, --server <url>', 'Server URL')
-	.action(async (options) => {
-		const config = loadConfig();
-		if (options.project) config.project = options.project;
-		if (options.server) config.server = options.server;
-		if (!config.project) {
-			console.error('Error: project slug required. Use --project or .git-shots.json');
-			process.exit(1);
-		}
-		await status(config);
-	});
-
-program
-	.command('pull-baselines')
-	.description('Download baseline screenshots from git-shots')
-	.option('-p, --project <slug>', 'Project slug')
-	.option('-s, --server <url>', 'Server URL')
-	.option('-o, --output <path>', 'Output directory')
-	.option('-b, --branch <name>', 'Branch to pull baselines from (default: main)')
-	.action(async (options) => {
-		const config = loadConfig();
-		if (options.project) config.project = options.project;
-		if (options.server) config.server = options.server;
-		if (!config.project) {
-			console.error('Error: project slug required. Use --project or .git-shots.json');
-			process.exit(1);
-		}
-		await pullBaselines(config, { branch: options.branch, output: options.output });
-	});
-
-program
-	.command('review')
-	.description('Upload screenshots, create review session, and poll for verdict')
-	.option('-p, --project <slug>', 'Project slug')
-	.option('-s, --server <url>', 'Server URL')
-	.option('-d, --directory <path>', 'Screenshots directory')
-	.option('-b, --branch <name>', 'Git branch (auto-detected)')
-	.option('--sha <hash>', 'Git SHA (auto-detected)')
-	.option('--open', 'Open review URL in browser', true)
-	.option('--no-open', 'Do not open review URL in browser')
-	.option('--poll', 'Poll for verdict and exit with code', true)
-	.option('--no-poll', 'Do not poll for verdict')
-	.option('--timeout <seconds>', 'Polling timeout in seconds', parseInt, 300)
-	.action(async (options) => {
-		const config = loadConfig();
-		if (options.project) config.project = options.project;
-		if (options.server) config.server = options.server;
-		if (options.directory) config.directory = options.directory;
-		if (!config.project) {
-			console.error('Error: project slug required. Use --project or .git-shots.json');
-			process.exit(1);
-		}
-		await review(config, {
-			branch: options.branch,
-			sha: options.sha,
-			open: options.open,
-			poll: options.poll,
-			timeout: options.timeout
-		});
-	});
-
-program.parse();
+#!/usr/bin/env node
+import { Command } from 'commander';
+import { loadConfig } from './config.js';
+import { upload } from './upload.js';
+import { compare } from './compare.js';
+import { status } from './status.js';
+import { pullBaselines } from './pull-baselines.js';
+import { review } from './review.js';
+import { hookInstall, hookUninstall } from './hook.js';
+
+const program = new Command();
+
+program
+	.name('git-shots')
+	.description('CLI for git-shots visual regression platform')
+	.version('0.1.0');
+
+program
+	.command('upload')
+	.description('Upload screenshots to git-shots')
+	.option('-p, --project <slug>', 'Project slug')
+	.option('-s, --server <url>', 'Server URL')
+	.option('-d, --directory <path>', 'Screenshots directory')
+	.option('-b, --branch <name>', 'Git branch (auto-detected)')
+	.option('--sha <hash>', 'Git SHA (auto-detected)')
+	.action(async (options) => {
+		const config = loadConfig();
+		if (options.project) config.project = options.project;
+		if (options.server) config.server = options.server;
+		if (options.directory) config.directory = options.directory;
+		if (!config.project) {
+			console.error('Error: project slug required. Use --project or .git-shots.json');
+			process.exit(1);
+		}
+		await upload(config, { branch: options.branch, sha: options.sha });
+	});
+
+program
+	.command('compare')
+	.description('Compare screenshots between branches')
+	.requiredOption('--head <branch>', 'Head branch to compare')
+	.option('-p, --project <slug>', 'Project slug')
+	.option('-s, --server <url>', 'Server URL')
+	.option('--base <branch>', 'Base branch (default: main)')
+	.option('-t, --threshold <number>', 'Mismatch threshold 0-1', parseFloat)
+	.action(async (options) => {
+		const config = loadConfig();
+		if (options.project) config.project = options.project;
+		if (options.server) config.server = options.server;
+		if (!config.project) {
+			console.error('Error: project slug required. Use --project or .git-shots.json');
+			process.exit(1);
+		}
+		await compare(config, { base: options.base, head: options.head, threshold: options.threshold });
+	});
+
+program
+	.command('status')
+	.description('Show current diff status')
+	.option('-p, --project <slug>', 'Project slug')
+	.option('-s, --server <url>', 'Server URL')
+	.action(async (options) => {
+		const config = loadConfig();
+		if (options.project) config.project = options.project;
+		if (options.server) config.server = options.server;
+		if (!config.project) {
+			console.error('Error: project slug required. Use --project or .git-shots.json');
+			process.exit(1);
+		}
+		await status(config);
+	});
+
+program
+	.command('pull-baselines')
+	.description('Download baseline screenshots from git-shots')
+	.option('-p, --project <slug>', 'Project slug')
+	.option('-s, --server <url>', 'Server URL')
+	.option('-o, --output <path>', 'Output directory')
+	.option('-b, --branch <name>', 'Branch to pull baselines from (default: main)')
+	.action(async (options) => {
+		const config = loadConfig();
+		if (options.project) config.project = options.project;
+		if (options.server) config.server = options.server;
+		if (!config.project) {
+			console.error('Error: project slug required. Use --project or .git-shots.json');
+			process.exit(1);
+		}
+		await pullBaselines(config, { branch: options.branch, output: options.output });
+	});
+
+program
+	.command('review')
+	.description('Upload screenshots, create review session, and poll for verdict')
+	.option('-p, --project <slug>', 'Project slug')
+	.option('-s, --server <url>', 'Server URL')
+	.option('-d, --directory <path>', 'Screenshots directory')
+	.option('-b, --branch <name>', 'Git branch (auto-detected)')
+	.option('--sha <hash>', 'Git SHA (auto-detected)')
+	.option('--open', 'Open review URL in browser', true)
+	.option('--no-open', 'Do not open review URL in browser')
+	.option('--poll', 'Poll for verdict and exit with code', true)
+	.option('--no-poll', 'Do not poll for verdict')
+	.option('--timeout <seconds>', 'Polling timeout in seconds', parseInt, 300)
+	.action(async (options) => {
+		const config = loadConfig();
+		if (options.project) config.project = options.project;
+		if (options.server) config.server = options.server;
+		if (options.directory) config.directory = options.directory;
+		if (!config.project) {
+			console.error('Error: project slug required. Use --project or .git-shots.json');
+			process.exit(1);
+		}
+		await review(config, {
+			branch: options.branch,
+			sha: options.sha,
+			open: options.open,
+			poll: options.poll,
+			timeout: options.timeout
+		});
+	});
+
+const hook = program
+	.command('hook')
+	.description('Manage git hooks for automatic visual review');
+
+hook
+	.command('install')
+	.description('Install a pre-push hook that runs git-shots review before each push')
+	.action(async () => {
+		await hookInstall();
+	});
+
+hook
+	.command('uninstall')
+	.description('Remove the git-shots pre-push hook')
+	.action(async () => {
+		await hookUninstall();
+	});
+
+program.parse();

package/src/pull-baselines.ts

@@ -1,87 +1,87 @@
-import { mkdirSync, writeFileSync } from 'node:fs';
-import { resolve, dirname } from 'node:path';
-import chalk from 'chalk';
-import type { GitShotsConfig } from './config.js';
-
-interface Snapshot {
-	screen_slug: string;
-	category: string | null;
-	r2_key: string;
-	git_sha: string;
-	width: number;
-	height: number;
-}
-
-export async function pullBaselines(
-	config: GitShotsConfig,
-	options: { branch?: string; output?: string }
-) {
-	const branch = options.branch ?? 'main';
-	const outputDir = resolve(process.cwd(), options.output ?? config.directory);
-
-	console.log(chalk.dim(`Project: ${config.project}`));
-	console.log(chalk.dim(`Branch:  ${branch}`));
-	console.log(chalk.dim(`Output:  ${outputDir}`));
-	console.log();
-
-	// Fetch manifest
-	const manifestUrl = `${config.server}/api/projects/${encodeURIComponent(config.project)}/snapshots?branch=${encodeURIComponent(branch)}`;
-	let snapshots: Snapshot[];
-
-	try {
-		const res = await fetch(manifestUrl);
-		const data = await res.json();
-
-		if (!res.ok) {
-			console.error(chalk.red(`Failed to fetch snapshots: ${JSON.stringify(data)}`));
-			process.exit(1);
-		}
-
-		snapshots = data.snapshots;
-	} catch (err) {
-		console.error(chalk.red(`Request failed: ${err}`));
-		process.exit(1);
-	}
-
-	if (snapshots.length === 0) {
-		console.log(chalk.yellow('No baseline snapshots found.'));
-		return;
-	}
-
-	console.log(chalk.dim(`Found ${snapshots.length} baselines to download`));
-	console.log();
-
-	// Download in batches of 5
-	const batchSize = 5;
-	let downloaded = 0;
-
-	for (let i = 0; i < snapshots.length; i += batchSize) {
-		const batch = snapshots.slice(i, i + batchSize);
-		await Promise.all(
-			batch.map(async (snap) => {
-				const imageUrl = `${config.server}/api/images/${snap.r2_key}`;
-				const res = await fetch(imageUrl);
-				if (!res.ok) {
-					console.error(chalk.red(`  Failed to download ${snap.screen_slug}: ${res.status}`));
-					return;
-				}
-
-				const buffer = Buffer.from(await res.arrayBuffer());
-				const subDir = snap.category ?? '';
-				const filePath = resolve(outputDir, subDir, `${snap.screen_slug}.png`);
-
-				mkdirSync(dirname(filePath), { recursive: true });
-				writeFileSync(filePath, buffer);
-
-				downloaded++;
-				console.log(
-					chalk.green(`  [${downloaded}/${snapshots.length}]`) +
-						` ${subDir ? subDir + '/' : ''}${snap.screen_slug}.png`
-				);
-			})
-		);
-	}
-
-	console.log();
-	console.log(chalk.green(`Downloaded ${downloaded} baselines to ${outputDir}`));
-}
+import { mkdirSync, writeFileSync } from 'node:fs';
+import { resolve, dirname } from 'node:path';
+import chalk from 'chalk';
+import type { GitShotsConfig } from './config.js';
+
+interface Snapshot {
+	screen_slug: string;
+	category: string | null;
+	r2_key: string;
+	git_sha: string;
+	width: number;
+	height: number;
+}
+
+export async function pullBaselines(
+	config: GitShotsConfig,
+	options: { branch?: string; output?: string }
+) {
+	const branch = options.branch ?? 'main';
+	const outputDir = resolve(process.cwd(), options.output ?? config.directory);
+
+	console.log(chalk.dim(`Project: ${config.project}`));
+	console.log(chalk.dim(`Branch:  ${branch}`));
+	console.log(chalk.dim(`Output:  ${outputDir}`));
+	console.log();
+
+	// Fetch manifest
+	const manifestUrl = `${config.server}/api/projects/${encodeURIComponent(config.project)}/snapshots?branch=${encodeURIComponent(branch)}`;
+	let snapshots: Snapshot[];
+
+	try {
+		const res = await fetch(manifestUrl);
+		const data = await res.json();
+
+		if (!res.ok) {
+			console.error(chalk.red(`Failed to fetch snapshots: ${JSON.stringify(data)}`));
+			process.exit(1);
+		}
+
+		snapshots = data.snapshots;
+	} catch (err) {
+		console.error(chalk.red(`Request failed: ${err}`));
+		process.exit(1);
+	}
+
+	if (snapshots.length === 0) {
+		console.log(chalk.yellow('No baseline snapshots found.'));
+		return;
+	}
+
+	console.log(chalk.dim(`Found ${snapshots.length} baselines to download`));
+	console.log();
+
+	// Download in batches of 5
+	const batchSize = 5;
+	let downloaded = 0;
+
+	for (let i = 0; i < snapshots.length; i += batchSize) {
+		const batch = snapshots.slice(i, i + batchSize);
+		await Promise.all(
+			batch.map(async (snap) => {
+				const imageUrl = `${config.server}/api/images/${snap.r2_key}`;
+				const res = await fetch(imageUrl);
+				if (!res.ok) {
+					console.error(chalk.red(`  Failed to download ${snap.screen_slug}: ${res.status}`));
+					return;
+				}
+
+				const buffer = Buffer.from(await res.arrayBuffer());
+				const subDir = snap.category ?? '';
+				const filePath = resolve(outputDir, subDir, `${snap.screen_slug}.png`);
+
+				mkdirSync(dirname(filePath), { recursive: true });
+				writeFileSync(filePath, buffer);
+
+				downloaded++;
+				console.log(
+					chalk.green(`  [${downloaded}/${snapshots.length}]`) +
+						` ${subDir ? subDir + '/' : ''}${snap.screen_slug}.png`
+				);
+			})
+		);
+	}
+
+	console.log();
+	console.log(chalk.green(`Downloaded ${downloaded} baselines to ${outputDir}`));
+}