@commitguard/cli 0.0.13 → 0.0.15

package/README.md

@@ -0,0 +1,167 @@
+# CommitGuard
+
+Protect your codebase with every commit. CommitGuard automatically analyzes your code for security vulnerabilities, performance issues, and code quality problems before they enter your repository. Grab your free API key at https://commitguard.ai.
+
+## Installation
+
+Get CommitGuard running in under 60 seconds. It works seamlessly with any git repository and integrates automatically with VSCode and other git clients.
+
+### Quick Start
+
+**1. Install CommitGuard globally**
+
+```bash
+npm install -g @commitguard/cli
+```
+
+**2. Navigate to your project**
+
+```bash
+cd your-project
+```
+
+**3. Initialize CommitGuard**
+
+```bash
+commitguard init
+```
+
+**4. Commit as usual**
+
+CommitGuard now runs automatically on every commit. It works with all git integrations including VSCode, terminal, and other git clients.
+
+```bash
+git commit -m "Add new feature"
+[CommitGuard] Analyzing commit...
+✓ Commit passed all checks
+```
+
+## Usage
+
+### Bypassing Checks
+
+To bypass CommitGuard checks for a specific commit, add `--skip` to your commit message:
+
+```bash
+git commit -m "Add new feature --skip"
+```
+
+The `--skip` flag is automatically removed from the final commit message. When using git in your terminal, you'll be prompted to confirm if you want to bypass checks.
+
+### Configuring Checks
+
+View or update CommitGuard preferences for your repository:
+
+```bash
+commitguard config
+```
+
+On the Pro plan, you can add custom rules through the config comand.
+
+## CLI Commands
+
+### `commitguard init`
+
+Install CommitGuard in your current repository.
+
+```bash
+$ commitguard init
+✓ CommitGuard installed successfully
+```
+
+### `commitguard remove`
+
+Remove CommitGuard from the current repository.
+
+```bash
+$ commitguard remove
+✓ CommitGuard removed
+```
+
+### `commitguard config`
+
+View or update CommitGuard preferences for the current repository. Pro plan users can add custom rules.
+
+```bash
+$ commitguard config
+Select enabled checks for this project:
+Security, Performance, Code Quality, Architecture
+```
+
+### `commitguard keys`
+
+Manage your global API key for CommitGuard.
+
+```bash
+$ commitguard keys
+Current API key: sk-ant-***************
+```
+
+## What Happens After Installation?
+
+- Every commit is analyzed before it's created.
+- No config files are added to your project
+- Bypass checks anytime with `--skip` in your commit message
+- Works seamlessly with all git clients and IDEs
+
+## Troubleshooting
+
+<details>
+<summary><strong>CommitGuard isn't running on commits</strong></summary>
+
+Try reinstalling the hooks:
+
+```bash
+commitguard remove
+commitguard init
+```
+
+Verify that the hooks are installed:
+
+```bash
+ls -la .git/hooks/
+```
+
+You should see a `pre-commit` hook file.
+</details>
+
+<details>
+<summary><strong>How do I skip a single commit?</strong></summary>
+
+Add `--skip` to your commit message:
+
+```bash
+git commit -m "Emergency fix --skip"
+```
+
+The `--skip` flag is automatically removed from the final message.
+</details>
+
+<details>
+<summary><strong>How do I completely remove CommitGuard?</strong></summary>
+
+Remove the hooks and uninstall the package:
+
+```bash
+commitguard remove
+npm uninstall -g @commitguard/cli
+```
+</details>
+
+## Features
+
+- **Security Analysis** - Detect vulnerabilities before they reach your repo
+- **Performance Checks** - Identify performance bottlenecks early
+- **Code Quality** - Maintain consistent code standards
+- **Architecture Review** - Ensure architectural patterns are followed
+- **Zero Configuration** - Works out of the box
+- **Universal Compatibility** - Works with any git workflow
+-- **Custom Rules** - Add your own custom checks to the code reviews
+
+## Support
+
+For issues, feature requests, or questions related to this package please open an issue or email us at hello@commitguard.ai
+
+## License
+
+MIT

package/dist/index.mjs

@@ -17,7 +17,7 @@ import stringWidth from "string-width";
 import "dotenv/config";
 
 //#region package.json
-var version = "0.0.13";
+var version = "0.0.15";
 var package_default = {
 	name: "@commitguard/cli",
 	type: "module",
@@ -347,54 +347,75 @@ async function manageGlobalKey() {
 
 //#endregion
 //#region src/utils/api.ts
-async function sendToCommitGuard(diff, eslint, config) {
+const DEFAULT_TIMEOUT = 2e4;
+async function sendToCommitGuard(diff, eslint, config$1) {
 	const apiKey = process.env.COMMITGUARD_API_KEY || getGlobalKey() || null;
 	if (!apiKey) throw new Error("No API key found. Set one globally with \"commitguard keys\" or add COMMITGUARD_API_KEY to your .env file. Get your free API key at https://commitguard.ai");
 	const apiUrl = process.env.COMMITGUARD_API_URL || "https://api.commitguard.ai/v1/analyze";
-	const response = await fetch(apiUrl, {
-		method: "POST",
-		headers: {
-			"Content-Type": "application/json",
-			"Authorization": `Bearer ${apiKey}`,
-			"User-Agent": "commitguard-cli"
-		},
-		body: JSON.stringify({
-			diff,
-			eslint,
-			config
-		})
-	});
-	if (!response.ok) {
-		const errorText = await response.text();
-		let errorMessage = "Failed to analyze commit";
-		if (response.status === 401) errorMessage = "Invalid API key. Check your key with \"commitguard keys\" or get a new one at https://commitguard.ai";
-		else if (response.status === 429) errorMessage = "Rate limit exceeded. Please try again later";
-		else if (response.status === 500) errorMessage = "CommitGuard service error. Please try again later";
-		else if (response.status >= 400 && response.status < 500) errorMessage = `Request error: ${errorText || "Invalid request"}`;
-		else errorMessage = `Service unavailable (${response.status}). Please try again later`;
-		throw new Error(errorMessage);
+	const controller = new AbortController();
+	const timeoutId = setTimeout(() => controller.abort(), DEFAULT_TIMEOUT);
+	try {
+		const response = await fetch(apiUrl, {
+			method: "POST",
+			headers: {
+				"Content-Type": "application/json",
+				"Authorization": `Bearer ${apiKey}`,
+				"User-Agent": "commitguard-cli"
+			},
+			body: JSON.stringify({
+				diff,
+				eslint,
+				config: config$1
+			}),
+			signal: controller.signal
+		});
+		clearTimeout(timeoutId);
+		if (!response.ok) {
+			const errorText = await response.text();
+			let errorMessage = "Failed to analyze commit";
+			if (response.status === 401) errorMessage = "Invalid API key. Check your key with \"commitguard keys\" or get a new one at https://commitguard.ai";
+			else if (response.status === 429) errorMessage = "Rate limit exceeded. Please try again later";
+			else if (response.status === 500) errorMessage = "CommitGuard service error. Please try again later";
+			else if (response.status >= 400 && response.status < 500) errorMessage = `Request error: ${errorText || "Invalid request"}`;
+			else errorMessage = `Service unavailable (${response.status}). Please try again later`;
+			throw new Error(errorMessage);
+		}
+		return await response.json();
+	} catch (error) {
+		clearTimeout(timeoutId);
+		if (error instanceof Error && error.name === "AbortError") throw new Error(`Request timed out after ${DEFAULT_TIMEOUT}ms`);
+		throw error;
 	}
-	return await response.json();
 }
 async function bypassCommitGuard() {
 	const apiKey = process.env.COMMITGUARD_API_KEY || getGlobalKey() || null;
 	if (!apiKey) throw new Error("No API key found. Set one globally with \"commitguard keys\" or add COMMITGUARD_API_KEY to your .env file. Get your free API key at https://commitguard.ai");
 	const apiUrl = process.env.COMMITGUARD_API_BYPASS_URL || "https://api.commitguard.ai/v1/bypass";
 	const diff = getLastDiff();
-	const response = await fetch(apiUrl, {
-		method: "POST",
-		headers: {
-			"Content-Type": "application/json",
-			"Authorization": `Bearer ${apiKey}`,
-			"User-Agent": "commitguard-cli"
-		},
-		body: JSON.stringify({ diff })
-	});
-	if (!response.ok) {
-		const errorText = await response.text();
-		throw new Error(`API request failed (${response.status}): ${errorText}`);
+	const controller = new AbortController();
+	const timeoutId = setTimeout(() => controller.abort(), DEFAULT_TIMEOUT);
+	try {
+		const response = await fetch(apiUrl, {
+			method: "POST",
+			headers: {
+				"Content-Type": "application/json",
+				"Authorization": `Bearer ${apiKey}`,
+				"User-Agent": "commitguard-cli"
+			},
+			body: JSON.stringify({ diff }),
+			signal: controller.signal
+		});
+		clearTimeout(timeoutId);
+		if (!response.ok) {
+			const errorText = await response.text();
+			throw new Error(`API request failed (${response.status}): ${errorText}`);
+		}
+		return await response.json();
+	} catch (error) {
+		clearTimeout(timeoutId);
+		if (error instanceof Error && error.name === "AbortError") throw new Error(`Request timed out after ${DEFAULT_TIMEOUT}ms`);
+		throw error;
 	}
-	return await response.json();
 }
 
 //#endregion
@@ -533,7 +554,7 @@ async function manageConfig() {
 	}
 	let customRule = currentConfig.customRule;
 	if (currentConfig.customRule) {
-		consola.info(`Current custom rule: ${currentConfig.customRule}`);
+		log.info(`Current custom rule: ${currentConfig.customRule}`);
 		const editCustomRule = await confirm({
 			message: "Would you like to edit the custom rule? (Currently only available to pro users)",
 			initialValue: false
@@ -676,13 +697,13 @@ async function getEslintRules({ startDir = process.cwd(), overrideCache = false
 		} catch {}
 		return null;
 	});
-	const config = (await Promise.all(loaders)).find((r) => r !== null) ?? {
+	const config$1 = (await Promise.all(loaders)).find((r) => r !== null) ?? {
 		rules: {},
 		source: null
 	};
-	cache.setKey(cacheKey, config);
+	cache.setKey(cacheKey, config$1);
 	cache.save(true);
-	return config;
+	return config$1;
 }
 
 //#endregion
@@ -845,6 +866,7 @@ async function removeHooks() {
 //#endregion
 //#region src/utils/staged.ts
 const CACHE_PATH = join(".git", "commitguard-cache.json");
+const config = loadConfig();
 const CATEGORY_LABELS = {
 	security: "🚨 [SECURITY]",
 	performance: "🚀 [PERFORMANCE]",
@@ -912,7 +934,6 @@ async function onStaged() {
 	const existingCache = readCache();
 	if (existingCache && existingCache.hash === diffHash) return;
 	try {
-		const config = loadConfig();
 		const response = await sendToCommitGuard(diff, (await getEslintRules()).rules, config);
 		writeCache({
 			hash: diffHash,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@commitguard/cli",
   "type": "module",
-  "version": "0.0.13",
+  "version": "0.0.15",
   "description": "AI-powered git commit checker that blocks bad code before it ships",
   "license": "MIT",
   "repository": {