gitpal-cli 1.0.3 → 1.0.4

package/README.md

@@ -1,11 +1,11 @@
 # 🤖 GitPal — AI-Powered Git Assistant CLI
-<!-- 
+
 > Stop writing commit messages manually. Let AI do it in 3 seconds.
 
 [![npm version](https://img.shields.io/npm/v/gitpal-cli.svg?style=flat-square)](https://www.npmjs.com/package/gitpal-cli)
 [![npm downloads](https://img.shields.io/npm/dm/gitpal-cli.svg?style=flat-square)](https://www.npmjs.com/package/gitpal-cli)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://opensource.org/licenses/MIT)
-[![Node.js](https://img.shields.io/badge/Node.js-18%2B-green?style=flat-square)](https://nodejs.org) -->
+[![Node.js](https://img.shields.io/badge/Node.js-18%2B-green?style=flat-square)](https://nodejs.org)
 
 ---
 
@@ -193,6 +193,36 @@ gitpal config
 
 ---
 
+### `gitpal review` — AI Code Reviewer
+Reviews your staged code for bugs, security issues and bad practices before you commit — like having a senior developer on your team 24/7.
+
+```bash
+git add .
+gitpal review
+
+# 🐛 Bugs Found:
+# - No error handling on login failure
+#
+# 🔒 Security Issues:
+# - Password stored as plain text, use bcrypt
+#
+# 💡 Improvements:
+# - Add input validation for username and password
+#
+# ❌ Verdict: Do not commit
+
+# ? What would you like to do?
+# ✅ Looks good — generate commit message and commit
+# ❌ I will fix the issues first
+```
+
+**Options:**
+```bash
+gitpal review --review-only    # Only review, skip commit step
+```
+
+---
+
 ## 🔄 Full Daily Workflow
 
 ```
@@ -201,6 +231,8 @@ Morning — open your project
 Write some code (auth feature)
          ↓
 git add .
+gitpal review  →  AI checks for bugs and security issues
+         ↓
 gitpal commit  →  "feat(auth): add Google OAuth login"
          ↓
 Write more code (fix a bug)
@@ -228,6 +260,7 @@ gitpal changelog --ver 2.0.0  →  Full changelog ready
 | Spend 15 mins on PR description | Generated in 3 seconds |
 | Forget what you built last week | Plain English summary instantly |
 | Write changelog manually | Auto-generated from commits |
+| No code review before commit | AI catches bugs before they reach GitHub |
 | Works with one AI only | Works with 4 AI providers |
 
 ---
@@ -247,7 +280,8 @@ gitpal/
 │       ├── summary.js     ← gitpal summary
 │       ├── pr.js          ← gitpal pr
 │       ├── changelog.js   ← gitpal changelog
-│       └── config.js      ← gitpal config
+│       ├── config.js      ← gitpal config
+│       └── review.js      ← gitpal review
 └── tests/
     └── ai.test.js
 ```
@@ -258,7 +292,7 @@ gitpal/
 
 ```bash
 # Clone the repo
-git clone https://github.com/harshit_gangwar16/gitpal
+git clone https://github.com/h1a2r3s4h/gitpal
 cd gitpal
 
 # Install dependencies
@@ -292,7 +326,7 @@ Contributions are welcome! To add a new AI provider:
 
 Built by **Harshit Gangwar**
 
-- GitHub: [@harshit_gangwar16](https://github.com/harshit_gangwar16)
+- GitHub: [@h1a2r3s4h](https://github.com/h1a2r3s4h)
 - npm: [gitpal-cli](https://www.npmjs.com/package/gitpal-cli)
 
 ---
@@ -305,4 +339,4 @@ MIT — free to use, modify and distribute.
 
 <p align="center">
   <strong>If GitPal saves you time, give it a ⭐ on GitHub!</strong>
-</p>
+</p>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gitpal-cli",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "AI-powered Git assistant CLI",
   "main": "src/index.js",
   "bin": {
@@ -26,5 +26,8 @@
     "ora": "^7.0.1",
     "simple-git": "^3.21.0"
   },
-  "type": "module"
+  "type": "module",
+  "devDependencies": {
+    "jest": "^30.3.0"
+  }
 }

package/src/commands/explain.js

@@ -0,0 +1,181 @@
+import chalk from 'chalk';
+import ora from 'ora';
+import fs from 'fs';
+import path from 'path';
+import { isGitRepo } from '../git.js';
+import { askAI } from '../ai.js';
+import simpleGit from 'simple-git';
+
+const git = simpleGit();
+
+export async function explainCommand(target, options) {
+  // 1. Guard: must be inside a git repo
+  if (!(await isGitRepo())) {
+    console.log(chalk.red('❌ Not a git repository.'));
+    process.exit(1);
+  }
+
+  // 2. Decide what to explain
+  if (!target) {
+    console.log(chalk.red('❌ Please provide something to explain.'));
+    console.log(chalk.dim('\nExamples:'));
+    console.log(chalk.cyan('  gitpal explain a3f2c1              ') + chalk.dim('← explain a commit'));
+    console.log(chalk.cyan('  gitpal explain src/auth.js         ') + chalk.dim('← explain a file'));
+    console.log(chalk.cyan('  gitpal explain src/auth.js --function login') + chalk.dim('← explain a function'));
+    process.exit(1);
+  }
+
+  // 3. Check if target is a file or a commit hash
+  const isFile = fs.existsSync(target);
+  const isCommitHash = /^[0-9a-f]{6,40}$/i.test(target);
+
+  if (isFile) {
+    await explainFile(target, options);
+  } else if (isCommitHash) {
+    await explainCommit(target);
+  } else {
+    console.log(chalk.red(`❌ "${target}" is not a valid file or commit hash.`));
+    process.exit(1);
+  }
+}
+
+// ─── EXPLAIN FILE ─────────────────────────────────────────────────────────────
+
+async function explainFile(filePath, options) {
+  const spinner = ora(`Reading ${filePath}...`).start();
+
+  let code;
+  try {
+    code = fs.readFileSync(filePath, 'utf-8');
+  } catch {
+    spinner.fail(chalk.red(`Cannot read file: ${filePath}`));
+    process.exit(1);
+  }
+
+  if (!code.trim()) {
+    spinner.fail(chalk.yellow('File is empty.'));
+    process.exit(1);
+  }
+
+  spinner.succeed(`Read ${path.basename(filePath)} successfully.`);
+
+  const aiSpinner = ora('AI is analyzing the code...').start();
+
+  let prompt;
+
+  if (options.function) {
+    // Explain a specific function
+    prompt = `You are a senior developer explaining code to a junior developer.
+
+Analyze this code and explain ONLY the function named "${options.function}".
+
+Explain:
+1. What this function does in simple words
+2. What inputs it takes
+3. What it returns
+4. Step by step what happens inside it
+5. Any important things to know
+
+Use simple language. No jargon. Maximum 10 lines.
+End with: "Depends on: X, Y, Z" (list any libraries or functions it uses)
+
+File: ${filePath}
+Code:
+${code.slice(0, 4000)}`;
+  } else {
+    // Explain the entire file
+    prompt = `You are a senior developer explaining code to a junior developer.
+
+Analyze this entire file and explain it clearly.
+
+Tell me:
+1. What is the PURPOSE of this file in one sentence
+2. What are the MAIN functions/classes (list each with one line description)
+3. How does it FIT into a typical project
+4. Any IMPORTANT patterns or techniques used
+
+Use simple language. Be concise. Maximum 15 lines.
+End with: "Depends on: X, Y, Z" (list key imports/dependencies)
+
+File: ${filePath}
+Code:
+${code.slice(0, 4000)}`;
+  }
+
+  try {
+    const explanation = await askAI(prompt);
+    aiSpinner.succeed('Explanation ready!\n');
+
+    const title = options.function
+      ? `📖 Explaining function: ${chalk.cyan(options.function)}() in ${chalk.dim(filePath)}`
+      : `📖 Explaining file: ${chalk.cyan(path.basename(filePath))}`;
+
+    console.log(chalk.bold(title));
+    console.log(chalk.dim('─'.repeat(50)));
+    console.log(chalk.white(explanation));
+    console.log('');
+
+  } catch (err) {
+    aiSpinner.fail(chalk.red(`AI Error: ${err.message}`));
+    process.exit(1);
+  }
+}
+
+// ─── EXPLAIN COMMIT ───────────────────────────────────────────────────────────
+
+async function explainCommit(hash) {
+  const spinner = ora(`Fetching commit ${hash}...`).start();
+
+  let diff, log;
+  try {
+    diff = await git.show([hash, '--stat', '--patch']);
+    log = await git.log({ from: `${hash}^`, to: hash, maxCount: 1 });
+  } catch {
+    spinner.fail(chalk.red(`Commit "${hash}" not found.`));
+    process.exit(1);
+  }
+
+  spinner.succeed('Commit found.');
+
+  const aiSpinner = ora('AI is analyzing the commit...').start();
+
+  const commitMessage = log.all[0]?.message || 'No message';
+  const commitDate = log.all[0]?.date || '';
+  const commitAuthor = log.all[0]?.author_name || '';
+
+  const prompt = `You are a senior developer explaining a git commit to a junior developer.
+
+Explain this commit in plain English.
+
+Tell me:
+1. WHAT changed — what was added, removed or modified
+2. WHY it was likely changed — what problem it solves
+3. FILES affected — list each file and what changed in it
+4. IMPACT — how does this affect the overall project
+
+Use simple language. Be specific. Maximum 15 lines.
+
+Commit: ${hash}
+Message: ${commitMessage}
+Author: ${commitAuthor}
+Date: ${commitDate}
+
+Diff:
+${diff.slice(0, 4000)}`;
+
+  try {
+    const explanation = await askAI(prompt);
+    aiSpinner.succeed('Explanation ready!\n');
+
+    console.log(chalk.bold(`📖 Explaining commit: ${chalk.cyan(hash)}`));
+    console.log(chalk.dim(`Message: ${commitMessage}`));
+    console.log(chalk.dim(`Author: ${commitAuthor}  |  Date: ${commitDate}`));
+    console.log(chalk.dim('─'.repeat(50)));
+    console.log(chalk.white(explanation));
+    console.log('');
+
+  } catch (err) {
+    aiSpinner.fail(chalk.red(`AI Error: ${err.message}`));
+    process.exit(1);
+  }
+}

package/src/index.js

@@ -6,7 +6,7 @@ import { prCommand } from './commands/pr.js';
 import { changelogCommand } from './commands/changelog.js';
 import { configCommand } from './commands/config.js';
 import { reviewCommand } from './commands/review.js';
-
+import { explainCommand } from './commands/explain.js';
 const program = new Command();
 
 console.log(chalk.cyan.bold('\n🤖 GitPal — Your AI Git Assistant\n'));
@@ -53,7 +53,11 @@ program
   .option('-r, --review-only', 'Only review, do not commit')
   .action(reviewCommand);
   
-
+program
+  .command('explain <target>')
+  .description('Explain any file or commit in plain English')
+  .option('-f, --function <name>', 'Explain a specific function')
+  .action(explainCommand);
 program.parse(process.argv);
 
 // Show help if no command given

package/tests/ai.test.js

@@ -0,0 +1,207 @@
+import { describe, test, expect, beforeEach, afterEach } from '@jest/globals';
+import fs from 'fs';
+import os from 'os';
+import path from 'path';
+
+const CONFIG_PATH = path.join(os.homedir(), '.gitpal.json');
+
+function cleanConfig() {
+  if (fs.existsSync(CONFIG_PATH)) {
+    fs.unlinkSync(CONFIG_PATH);
+  }
+}
+
+// ─── CONFIG TESTS ─────────────────────────────────────────────────────────────
+
+describe('Config Management', () => {
+
+  beforeEach(() => cleanConfig());
+  afterEach(() => cleanConfig());
+
+  test('loadConfig returns empty object when no config exists', async () => {
+    const { loadConfig } = await import('../src/ai.js');
+    const config = loadConfig();
+    expect(config).toEqual({});
+  });
+
+  test('saveConfig saves provider and apiKey correctly', async () => {
+    const { saveConfig, loadConfig } = await import('../src/ai.js');
+    saveConfig({ provider: 'groq', apiKey: 'test-key-123' });
+    const config = loadConfig();
+    expect(config.provider).toBe('groq');
+    expect(config.apiKey).toBe('test-key-123');
+  });
+
+  test('saveConfig overwrites existing config', async () => {
+    const { saveConfig, loadConfig } = await import('../src/ai.js');
+    saveConfig({ provider: 'openai', apiKey: 'old-key' });
+    saveConfig({ provider: 'anthropic', apiKey: 'new-key' });
+    const config = loadConfig();
+    expect(config.provider).toBe('anthropic');
+    expect(config.apiKey).toBe('new-key');
+  });
+
+  test('saveConfig supports all 4 providers', async () => {
+    const { saveConfig, loadConfig } = await import('../src/ai.js');
+    const providers = ['groq', 'openai', 'gemini', 'anthropic'];
+    for (const provider of providers) {
+      saveConfig({ provider, apiKey: `key-for-${provider}` });
+      const config = loadConfig();
+      expect(config.provider).toBe(provider);
+    }
+  });
+
+  test('config file is created at correct path', async () => {
+    const { saveConfig } = await import('../src/ai.js');
+    saveConfig({ provider: 'groq', apiKey: 'test-key' });
+    expect(fs.existsSync(CONFIG_PATH)).toBe(true);
+  });
+
+  test('config file contains valid JSON', async () => {
+    const { saveConfig } = await import('../src/ai.js');
+    saveConfig({ provider: 'groq', apiKey: 'test-key' });
+    const raw = fs.readFileSync(CONFIG_PATH, 'utf-8');
+    expect(() => JSON.parse(raw)).not.toThrow();
+  });
+
+});
+
+// ─── AI PROVIDER TESTS ────────────────────────────────────────────────────────
+
+describe('AI Provider Validation', () => {
+
+  beforeEach(() => cleanConfig());
+  afterEach(() => cleanConfig());
+
+  test('askAI throws error when no config exists', async () => {
+    const { askAI } = await import('../src/ai.js');
+    await expect(askAI('test prompt')).rejects.toThrow('No AI provider configured');
+  });
+
+  test('askAI throws error for unknown provider', async () => {
+    const { saveConfig, askAI } = await import('../src/ai.js');
+    saveConfig({ provider: 'unknownprovider', apiKey: 'test-key' });
+    await expect(askAI('test prompt')).rejects.toThrow();
+  });
+
+  test('askAI throws error when apiKey is missing', async () => {
+    const { saveConfig, askAI } = await import('../src/ai.js');
+    saveConfig({ provider: 'groq', apiKey: '' });
+    await expect(askAI('test prompt')).rejects.toThrow();
+  });
+
+});
+
+// ─── GIT UTILITY TESTS ────────────────────────────────────────────────────────
+
+describe('Git Utilities', () => {
+
+test('isGitRepo returns a boolean', async () => {
+  const { isGitRepo } = await import('../src/git.js');
+  const result = await isGitRepo();
+  expect(typeof result).toBe('boolean');
+});
+
+  test('isGitRepo returns true inside a git repo', async () => {
+    const { isGitRepo } = await import('../src/git.js');
+    const result = await isGitRepo();
+    expect(result).toBe(true);
+  });
+
+  test('getRecentCommits returns an array', async () => {
+    const { getRecentCommits } = await import('../src/git.js');
+    const commits = await getRecentCommits(3);
+    expect(Array.isArray(commits)).toBe(true);
+  });
+
+  test('getRecentCommits respects the limit', async () => {
+    const { getRecentCommits } = await import('../src/git.js');
+    const commits = await getRecentCommits(2);
+    expect(commits.length).toBeLessThanOrEqual(2);
+  });
+
+  test('getCurrentBranch returns a string', async () => {
+    const { getCurrentBranch } = await import('../src/git.js');
+    const branch = await getCurrentBranch();
+    expect(typeof branch).toBe('string');
+    expect(branch.length).toBeGreaterThan(0);
+  });
+
+  test('getStagedDiff returns a string', async () => {
+    const { getStagedDiff } = await import('../src/git.js');
+    const diff = await getStagedDiff();
+    expect(typeof diff).toBe('string');
+  });
+
+});
+
+// ─── PACKAGE.JSON VALIDATION ──────────────────────────────────────────────────
+
+describe('Package Configuration', () => {
+
+  test('package.json has correct name', () => {
+    const pkg = JSON.parse(fs.readFileSync('./package.json', 'utf-8'));
+    expect(pkg.name).toBe('gitpal-cli');
+  });
+
+  test('package.json has bin field', () => {
+    const pkg = JSON.parse(fs.readFileSync('./package.json', 'utf-8'));
+    expect(pkg.bin).toBeDefined();
+  });
+
+  test('package.json has version', () => {
+    const pkg = JSON.parse(fs.readFileSync('./package.json', 'utf-8'));
+    expect(pkg.version).toBeDefined();
+    expect(pkg.version).toMatch(/^\d+\.\d+\.\d+$/);
+  });
+
+  test('package.json has required dependencies', () => {
+    const pkg = JSON.parse(fs.readFileSync('./package.json', 'utf-8'));
+    const required = ['commander', 'simple-git', 'chalk', 'ora', 'inquirer'];
+    required.forEach(dep => {
+      expect(pkg.dependencies).toHaveProperty(dep);
+    });
+  });
+
+  test('bin/gitpal.js file exists and is not empty', () => {
+    const binPath = './bin/gitpal.js';
+    expect(fs.existsSync(binPath)).toBe(true);
+    const content = fs.readFileSync(binPath, 'utf-8');
+    expect(content.trim().length).toBeGreaterThan(0);
+  });
+
+});
+
+// ─── COMMAND FILES EXIST ──────────────────────────────────────────────────────
+
+describe('Command Files', () => {
+
+  const commands = ['commit', 'summary', 'pr', 'changelog', 'config', 'review'];
+
+  commands.forEach(cmd => {
+    test(`src/commands/${cmd}.js exists`, () => {
+      expect(fs.existsSync(`./src/commands/${cmd}.js`)).toBe(true);
+    });
+
+    test(`src/commands/${cmd}.js is not empty`, () => {
+      const content = fs.readFileSync(`./src/commands/${cmd}.js`, 'utf-8');
+      expect(content.trim().length).toBeGreaterThan(0);
+    });
+  });
+
+  test('src/ai.js exists and is not empty', () => {
+    const content = fs.readFileSync('./src/ai.js', 'utf-8');
+    expect(content.trim().length).toBeGreaterThan(0);
+  });
+
+  test('src/git.js exists and is not empty', () => {
+    const content = fs.readFileSync('./src/git.js', 'utf-8');
+    expect(content.trim().length).toBeGreaterThan(0);
+  });
+
+  test('src/index.js exists and is not empty', () => {
+    const content = fs.readFileSync('./src/index.js', 'utf-8');
+    expect(content.trim().length).toBeGreaterThan(0);
+  });
+
+});