git-shots-cli 0.1.2 → 0.2.0

package/dist/index.js

@@ -235,7 +235,7 @@ function openBrowser(url) {
   }
 }
 function sleep(ms) {
-  return new Promise((resolve4) => setTimeout(resolve4, ms));
+  return new Promise((resolve5) => setTimeout(resolve5, ms));
 }
 async function review(config, options) {
   const shouldOpen = options.open ?? true;
@@ -334,6 +334,115 @@ async function review(config, options) {
   process.exit(2);
 }
 
+// src/hook.ts
+import { existsSync as existsSync3, writeFileSync as writeFileSync2, unlinkSync, chmodSync, readFileSync as readFileSync3 } from "fs";
+import { resolve as resolve4, join } from "path";
+import { execSync as execSync3 } from "child_process";
+import chalk6 from "chalk";
+var HOOK_MARKER = "# git-shots-hook";
+var HOOK_SCRIPT = `#!/bin/sh
+${HOOK_MARKER}
+# Pre-push hook: runs git-shots visual review before pushing.
+# Installed by: git-shots hook install
+
+# Skip if no .git-shots.json config
+if [ ! -f ".git-shots.json" ]; then
+  exit 0
+fi
+
+# Read screenshots directory from config (default: docs/screenshots/current)
+SCREENSHOTS_DIR=$(node -e "try{const c=JSON.parse(require('fs').readFileSync('.git-shots.json','utf-8'));console.log(c.directory||'docs/screenshots/current')}catch{console.log('docs/screenshots/current')}" 2>/dev/null)
+
+# Skip if no screenshots directory or no PNGs
+if [ ! -d "$SCREENSHOTS_DIR" ]; then
+  exit 0
+fi
+
+PNG_COUNT=$(find "$SCREENSHOTS_DIR" -name "*.png" 2>/dev/null | head -1)
+if [ -z "$PNG_COUNT" ]; then
+  exit 0
+fi
+
+# Skip on main/master \u2014 no base to diff against
+BRANCH=$(git rev-parse --abbrev-ref HEAD)
+if [ "$BRANCH" = "main" ] || [ "$BRANCH" = "master" ]; then
+  exit 0
+fi
+
+echo ""
+echo "git-shots: Running visual review before push..."
+echo ""
+
+git-shots review
+EXIT_CODE=$?
+
+if [ $EXIT_CODE -eq 1 ]; then
+  echo ""
+  echo "git-shots: Visual review rejected. Push blocked."
+  exit 1
+fi
+
+if [ $EXIT_CODE -eq 2 ]; then
+  echo ""
+  echo "git-shots: Visual review timed out. Push allowed (review pending)."
+  exit 0
+fi
+
+exit 0
+`;
+function getGitDir(cwd) {
+  try {
+    return execSync3("git rev-parse --git-dir", { cwd, encoding: "utf-8" }).trim();
+  } catch {
+    throw new Error("Not a git repository");
+  }
+}
+async function hookInstall(cwd = process.cwd()) {
+  const gitDir = getGitDir(cwd);
+  const hooksDir = resolve4(cwd, gitDir, "hooks");
+  const hookPath = join(hooksDir, "pre-push");
+  if (existsSync3(hookPath)) {
+    const existing = readFileSync3(hookPath, "utf-8");
+    if (existing.includes(HOOK_MARKER)) {
+      console.log(chalk6.yellow("git-shots pre-push hook is already installed."));
+      return;
+    }
+    console.error(
+      chalk6.red("A pre-push hook already exists at ") + chalk6.dim(hookPath)
+    );
+    console.error(
+      chalk6.dim("Remove or rename it first, then re-run this command.")
+    );
+    process.exit(1);
+  }
+  writeFileSync2(hookPath, HOOK_SCRIPT, { mode: 493 });
+  try {
+    chmodSync(hookPath, 493);
+  } catch {
+  }
+  console.log(chalk6.green("Installed pre-push hook at ") + chalk6.dim(hookPath));
+  console.log();
+  console.log(chalk6.dim("The hook will run `git-shots review` before every push"));
+  console.log(chalk6.dim("when .git-shots.json is present and screenshots exist."));
+}
+async function hookUninstall(cwd = process.cwd()) {
+  const gitDir = getGitDir(cwd);
+  const hooksDir = resolve4(cwd, gitDir, "hooks");
+  const hookPath = join(hooksDir, "pre-push");
+  if (!existsSync3(hookPath)) {
+    console.log(chalk6.yellow("No pre-push hook found."));
+    return;
+  }
+  const existing = readFileSync3(hookPath, "utf-8");
+  if (!existing.includes(HOOK_MARKER)) {
+    console.error(chalk6.red("Pre-push hook exists but was not installed by git-shots."));
+    console.error(chalk6.dim("Remove it manually if you want: ") + chalk6.dim(hookPath));
+    process.exit(1);
+  }
+  unlinkSync(hookPath);
+  console.log(chalk6.green("Removed git-shots pre-push hook."));
+}
+
 // src/index.ts
 var program = new Command();
 program.name("git-shots").description("CLI for git-shots visual regression platform").version("0.1.0");
@@ -395,4 +504,11 @@ program.command("review").description("Upload screenshots, create review session
     timeout: options.timeout
   });
 });
+var 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/package.json

@@ -1,23 +1,23 @@
-{
-	"name": "git-shots-cli",
-	"version": "0.1.2",
-	"description": "CLI for git-shots visual regression platform",
-	"type": "module",
-	"bin": {
-		"git-shots": "./dist/index.js"
-	},
-	"scripts": {
-		"build": "tsup src/index.ts --format esm --dts",
-		"dev": "tsup src/index.ts --format esm --watch"
-	},
-	"dependencies": {
-		"commander": "^12.0.0",
-		"chalk": "^5.3.0",
-		"glob": "^11.0.0"
-	},
-	"devDependencies": {
-		"tsup": "^8.0.0",
-		"typescript": "^5.0.0",
-		"@types/node": "^22.0.0"
-	}
-}
+{
+	"name": "git-shots-cli",
+	"version": "0.2.0",
+	"description": "CLI for git-shots visual regression platform",
+	"type": "module",
+	"bin": {
+		"git-shots": "./dist/index.js"
+	},
+	"scripts": {
+		"build": "tsup src/index.ts --format esm --dts",
+		"dev": "tsup src/index.ts --format esm --watch"
+	},
+	"dependencies": {
+		"commander": "^12.0.0",
+		"chalk": "^5.3.0",
+		"glob": "^11.0.0"
+	},
+	"devDependencies": {
+		"tsup": "^8.0.0",
+		"typescript": "^5.0.0",
+		"@types/node": "^22.0.0"
+	}
+}

package/src/compare.ts

@@ -1,57 +1,57 @@
-import chalk from 'chalk';
-import type { GitShotsConfig } from './config.js';
-
-export async function compare(
-	config: GitShotsConfig,
-	options: { base?: string; head: string; threshold?: number }
-) {
-	const url = `${config.server}/api/compare`;
-	const body = {
-		project: config.project,
-		base: options.base ?? 'main',
-		head: options.head,
-		threshold: options.threshold ?? 0.1
-	};
-
-	console.log(chalk.dim(`Comparing ${body.base} vs ${body.head} for ${config.project}...`));
-
-	try {
-		const res = await fetch(url, {
-			method: 'POST',
-			headers: { 'Content-Type': 'application/json', Origin: config.server },
-			body: JSON.stringify(body)
-		});
-		const data = await res.json();
-
-		if (!res.ok) {
-			console.error(chalk.red(`Compare failed: ${JSON.stringify(data)}`));
-			process.exit(1);
-		}
-
-		console.log();
-		console.log(`Compared ${chalk.bold(data.compared)} screens`);
-		console.log();
-
-		if (data.diffs.length === 0) {
-			console.log(chalk.green('No visual differences found!'));
-			return;
-		}
-
-		// Print table
-		console.log(chalk.dim('Screen'.padEnd(30) + 'Mismatch'.padEnd(15) + 'Pixels'));
-		console.log(chalk.dim('-'.repeat(55)));
-
-		for (const d of data.diffs) {
-			const pct = d.mismatchPercentage.toFixed(2) + '%';
-			const color = d.mismatchPercentage > 10 ? chalk.red : d.mismatchPercentage > 1 ? chalk.yellow : chalk.green;
-			console.log(
-				d.screen.padEnd(30) +
-				color(pct.padEnd(15)) +
-				chalk.dim(d.mismatchPixels.toLocaleString())
-			);
-		}
-	} catch (err) {
-		console.error(chalk.red(`Request failed: ${err}`));
-		process.exit(1);
-	}
-}
+import chalk from 'chalk';
+import type { GitShotsConfig } from './config.js';
+
+export async function compare(
+	config: GitShotsConfig,
+	options: { base?: string; head: string; threshold?: number }
+) {
+	const url = `${config.server}/api/compare`;
+	const body = {
+		project: config.project,
+		base: options.base ?? 'main',
+		head: options.head,
+		threshold: options.threshold ?? 0.1
+	};
+
+	console.log(chalk.dim(`Comparing ${body.base} vs ${body.head} for ${config.project}...`));
+
+	try {
+		const res = await fetch(url, {
+			method: 'POST',
+			headers: { 'Content-Type': 'application/json', Origin: config.server },
+			body: JSON.stringify(body)
+		});
+		const data = await res.json();
+
+		if (!res.ok) {
+			console.error(chalk.red(`Compare failed: ${JSON.stringify(data)}`));
+			process.exit(1);
+		}
+
+		console.log();
+		console.log(`Compared ${chalk.bold(data.compared)} screens`);
+		console.log();
+
+		if (data.diffs.length === 0) {
+			console.log(chalk.green('No visual differences found!'));
+			return;
+		}
+
+		// Print table
+		console.log(chalk.dim('Screen'.padEnd(30) + 'Mismatch'.padEnd(15) + 'Pixels'));
+		console.log(chalk.dim('-'.repeat(55)));
+
+		for (const d of data.diffs) {
+			const pct = d.mismatchPercentage.toFixed(2) + '%';
+			const color = d.mismatchPercentage > 10 ? chalk.red : d.mismatchPercentage > 1 ? chalk.yellow : chalk.green;
+			console.log(
+				d.screen.padEnd(30) +
+				color(pct.padEnd(15)) +
+				chalk.dim(d.mismatchPixels.toLocaleString())
+			);
+		}
+	} catch (err) {
+		console.error(chalk.red(`Request failed: ${err}`));
+		process.exit(1);
+	}
+}

package/src/config.ts

@@ -1,28 +1,28 @@
-import { readFileSync, existsSync } from 'node:fs';
-import { resolve } from 'node:path';
-
-export interface GitShotsConfig {
-	project: string;
-	server: string;
-	directory: string;
-}
-
-const DEFAULT_CONFIG: GitShotsConfig = {
-	project: '',
-	server: 'https://git-shots.rijid356.workers.dev',
-	directory: 'docs/screenshots/current'
-};
-
-export function loadConfig(cwd: string = process.cwd()): GitShotsConfig {
-	const configPath = resolve(cwd, '.git-shots.json');
-	if (!existsSync(configPath)) {
-		return DEFAULT_CONFIG;
-	}
-	try {
-		const raw = readFileSync(configPath, 'utf-8');
-		const parsed = JSON.parse(raw);
-		return { ...DEFAULT_CONFIG, ...parsed };
-	} catch {
-		return DEFAULT_CONFIG;
-	}
-}
+import { readFileSync, existsSync } from 'node:fs';
+import { resolve } from 'node:path';
+
+export interface GitShotsConfig {
+	project: string;
+	server: string;
+	directory: string;
+}
+
+const DEFAULT_CONFIG: GitShotsConfig = {
+	project: '',
+	server: 'https://git-shots.rijid356.workers.dev',
+	directory: 'docs/screenshots/current'
+};
+
+export function loadConfig(cwd: string = process.cwd()): GitShotsConfig {
+	const configPath = resolve(cwd, '.git-shots.json');
+	if (!existsSync(configPath)) {
+		return DEFAULT_CONFIG;
+	}
+	try {
+		const raw = readFileSync(configPath, 'utf-8');
+		const parsed = JSON.parse(raw);
+		return { ...DEFAULT_CONFIG, ...parsed };
+	} catch {
+		return DEFAULT_CONFIG;
+	}
+}

package/src/hook.ts

@@ -0,0 +1,124 @@
+import { existsSync, writeFileSync, unlinkSync, chmodSync, readFileSync } from 'node:fs';
+import { resolve, join } from 'node:path';
+import { execSync } from 'node:child_process';
+import chalk from 'chalk';
+
+const HOOK_MARKER = '# git-shots-hook';
+
+const HOOK_SCRIPT = `#!/bin/sh
+${HOOK_MARKER}
+# Pre-push hook: runs git-shots visual review before pushing.
+# Installed by: git-shots hook install
+
+# Skip if no .git-shots.json config
+if [ ! -f ".git-shots.json" ]; then
+  exit 0
+fi
+
+# Read screenshots directory from config (default: docs/screenshots/current)
+SCREENSHOTS_DIR=$(node -e "try{const c=JSON.parse(require('fs').readFileSync('.git-shots.json','utf-8'));console.log(c.directory||'docs/screenshots/current')}catch{console.log('docs/screenshots/current')}" 2>/dev/null)
+
+# Skip if no screenshots directory or no PNGs
+if [ ! -d "$SCREENSHOTS_DIR" ]; then
+  exit 0
+fi
+
+PNG_COUNT=$(find "$SCREENSHOTS_DIR" -name "*.png" 2>/dev/null | head -1)
+if [ -z "$PNG_COUNT" ]; then
+  exit 0
+fi
+
+# Skip on main/master — no base to diff against
+BRANCH=$(git rev-parse --abbrev-ref HEAD)
+if [ "$BRANCH" = "main" ] || [ "$BRANCH" = "master" ]; then
+  exit 0
+fi
+
+echo ""
+echo "git-shots: Running visual review before push..."
+echo ""
+
+git-shots review
+EXIT_CODE=$?
+
+if [ $EXIT_CODE -eq 1 ]; then
+  echo ""
+  echo "git-shots: Visual review rejected. Push blocked."
+  exit 1
+fi
+
+if [ $EXIT_CODE -eq 2 ]; then
+  echo ""
+  echo "git-shots: Visual review timed out. Push allowed (review pending)."
+  exit 0
+fi
+
+exit 0
+`;
+
+function getGitDir(cwd: string): string {
+	try {
+		return execSync('git rev-parse --git-dir', { cwd, encoding: 'utf-8' }).trim();
+	} catch {
+		throw new Error('Not a git repository');
+	}
+}
+
+export async function hookInstall(cwd: string = process.cwd()) {
+	const gitDir = getGitDir(cwd);
+	const hooksDir = resolve(cwd, gitDir, 'hooks');
+	const hookPath = join(hooksDir, 'pre-push');
+
+	// Check if a pre-push hook already exists
+	if (existsSync(hookPath)) {
+		const existing = readFileSync(hookPath, 'utf-8');
+		if (existing.includes(HOOK_MARKER)) {
+			console.log(chalk.yellow('git-shots pre-push hook is already installed.'));
+			return;
+		}
+
+		// Another hook exists — don't overwrite
+		console.error(
+			chalk.red('A pre-push hook already exists at ') + chalk.dim(hookPath)
+		);
+		console.error(
+			chalk.dim('Remove or rename it first, then re-run this command.')
+		);
+		process.exit(1);
+	}
+
+	writeFileSync(hookPath, HOOK_SCRIPT, { mode: 0o755 });
+
+	// chmod on non-Windows (writeFileSync mode doesn't always stick)
+	try {
+		chmodSync(hookPath, 0o755);
+	} catch {
+		// Windows — mode already set via writeFileSync
+	}
+
+	console.log(chalk.green('Installed pre-push hook at ') + chalk.dim(hookPath));
+	console.log();
+	console.log(chalk.dim('The hook will run `git-shots review` before every push'));
+	console.log(chalk.dim('when .git-shots.json is present and screenshots exist.'));
+}
+
+export async function hookUninstall(cwd: string = process.cwd()) {
+	const gitDir = getGitDir(cwd);
+	const hooksDir = resolve(cwd, gitDir, 'hooks');
+	const hookPath = join(hooksDir, 'pre-push');
+
+	if (!existsSync(hookPath)) {
+		console.log(chalk.yellow('No pre-push hook found.'));
+		return;
+	}
+
+	const existing = readFileSync(hookPath, 'utf-8');
+	if (!existing.includes(HOOK_MARKER)) {
+		console.error(chalk.red('Pre-push hook exists but was not installed by git-shots.'));
+		console.error(chalk.dim('Remove it manually if you want: ') + chalk.dim(hookPath));
+		process.exit(1);
+	}
+
+	unlinkSync(hookPath);
+	console.log(chalk.green('Removed git-shots pre-push hook.'));
+}