prsmith 1.0.2 → 2.0.0

package/CHANGELOG.md

@@ -2,9 +2,51 @@
 
 All notable changes to this project will be documented in this file.
 
+## [2.0.0] - 2026-06-01
+
+### Added
+
+- **GitHub Integration**: Direct comment posting to PRs and full integrated Review Submission support, featuring auto-detection of repository details from local Git configs.
+- **AI "Rude-to-Polite" Polish**: A unified client supporting Gemini, OpenAI, and Groq over lightweight native HTTP requests, translating harsh or blunt feedback into constructive and polite reviews.
+- **Interactive Batch Review Mode (`prsmith batch`)**: Loop through multiple issues in a single terminal session, compile them into a unified report, and optionally post them as separate native inline review comments on GitHub.
+- **File & Line Context**: Link your comments directly to code files and line numbers, generating clickable GitHub deep links when repo details are available.
+- **Before & After Code Snippets**: Show differences between original and proposed code structures in collapsible `<details>` blocks with syntax highlighting.
+
+## [1.1.0] - 2026-06-01
+
+### Added
+
+- **Clipboard Integration**: Automatically copies the generated markdown to your clipboard (`clipboardy`).
+- **Editor Prompts**: The `issue` and `fix` interactive prompts now intelligently launch your default system `$EDITOR` (e.g. VS Code, vim) for a seamless multi-line typing experience.
+- **CLI Arguments**: You can completely bypass the interactive mode by supplying flags: `-s`, `-t`, `-i`, `-f`.
+- **File Output**: Use the `-o` or `--out` flag to directly write the markdown to a file (e.g. `prsmith --out comment.md`).
+- **Update Notifier**: The CLI now checks for updates in the background and notifies you if a newer version is available on NPM.
+- **Custom Configs**: Support for `.prsmith.json` files in your home directory (`~/`) or project directory. Define your own custom severities and intro templates!
+
+## [1.0.2] - 2026-05-31
+
+### Added
+
+- Integrated `commander` to provide robust native support for CLI flags (`-h`, `--help`, `-v`, `--version`).
+- Graceful termination handling: Intercepting `ExitPromptError` to display a friendly message when users abort the interactive prompt (e.g., via `Ctrl+C`) instead of throwing stack traces.
+- Custom author branding and detailed bio added to the README footer.
+
+## [1.0.1] - 2026-05-31
+
+### Fixed
+
+- Re-configured Git Hooks (Husky) to ensure `npm test` and `npm run lint` run reliably on pre-commit.
+- Resolved invalid path structures in `package.json` for the executable `bin` field.
+- Fixed a bug in `inquirer` by migrating legacy `"list"` prompt types to `"select"` to prevent CLI crashes.
+
+### Changed
+
+- Massively overhauled `README.md` for NPM compatibility: Replaced unsupported Mermaid diagrams with elegant ASCII flowcharts, incorporated GitHub/NPM badges, and structured sections with collapsible `<details>` HTML tags for premium rendering on the NPM website.
+
 ## [1.0.0] - 2026-05-31
 
 ### Added
+
 - Interactive CLI prompts to generate PR review comments.
 - Formatter to generate markdown based on severity, title, issue, and fix.
 - Initial setup for linting, testing, and CI.

package/README.md

@@ -5,16 +5,16 @@
   [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square)](https://opensource.org/licenses/MIT)
   [![CI](https://img.shields.io/github/actions/workflow/status/TarunyaProgrammer/PRSmith_NPMPackage/ci.yml?branch=main&style=flat-square)](https://github.com/TarunyaProgrammer/PRSmith_NPMPackage/actions)
 
-  <p><b>Forge professional pull request review comments directly from the terminal.</b></p>
+  <p><b>Forge professional pull request review comments and submit integrated reviews directly from the terminal.</b></p>
 </div>
 
 ---
 
-PRSmith streamlines the process of writing code reviews by providing an interactive prompt that generates consistently formatted, polite, and actionable Markdown comments.
+PRSmith streamlines the process of writing code reviews by providing an interactive prompt that generates consistently formatted, polite, and actionable Markdown comments. With **v2.0.0**, PRSmith evolves into an **intelligent, automated, production-grade Code Review suite** featuring AI-powered tone polishing, direct GitHub integrations, file context, and batch review loops.
 
 ## Architecture Flow
 
-The tool operates via a straightforward interactive flow, generating structured markdown from your inputs.
+The tool operates via a straightforward interactive flow, generating structured markdown from your inputs and supporting remote integrations.
 
 ```text
  ┌──────────────────────────┐
@@ -23,7 +23,12 @@ The tool operates via a straightforward interactive flow, generating structured
               ▼
  ┌──────────────────────────┐
  │   Interactive Prompts    │
- │ (Severity, Title, Issue) │
+ │ (File, Snippets, Issue)  │
+ └────────────┬─────────────┘
+              ▼
+ ┌──────────────────────────┐
+ │   AI Polish (Optional)   │
+ │ (Gemini, OpenAI, Groq)   │
  └────────────┬─────────────┘
               ▼
  ┌──────────────────────────┐
@@ -31,7 +36,8 @@ The tool operates via a straightforward interactive flow, generating structured
  └────────────┬─────────────┘
               ▼
  ┌──────────────────────────┐
- │ Print Formatted Comment  │
+ │  Export / Direct Post    │
+ │ (GitHub, Clipboard, File)│
  └──────────────────────────┘
 ```
 
@@ -45,61 +51,158 @@ Install globally to use it anywhere on your machine.
 npm install -g prsmith
 ```
 
-## Features
+---
+
+## ⚡ Key Features (v2.0.0)
+
+PRSmith has been completely overhauled with a set of powerful new features:
+
+1. **🚀 GitHub Integration (PR Comments & Reviews)**:
+   - Post your generated review comment directly to a Pull Request as an issue comment, or as a native GitHub code review.
+   - **Zero-Config Repo Auto-Detection**: Auto-detects the repository owner and name from your local `.git/config` remotes.
+2. **✨ AI "Rude-to-Polite" Polish**:
+   - Polishes blunt or harsh descriptions into constructive, professional, and empathetic reviews.
+   - Built-in support for **Gemini** (default), **OpenAI**, and **Groq** via lightweight native HTTP requests.
+3. **📁 File & Line Number Context**:
+   - Link your feedback directly to code files and line ranges (e.g. `src/utils.js:45-50`).
+   - If GitHub integration is active, PRSmith generates **clickable GitHub deep links** straight to the code!
+4. **🔍 Before/After Code Snippet Comparisons**:
+   - Provide original and proposed code blocks. Outputs collapsible `<details>` blocks featuring gorgeous syntax highlighting.
+5. **📦 Batch Review Mode (`prsmith batch`)**:
+   - Run a single review runner loop to review multiple files or issues in one go.
+   - Export all bundled reviews together: copy them, save to a report, or **submit a native multi-comment review on GitHub** in a single click!
 
-- **Interactive Prompts:** No need to memorize complex flags. Just run the tool and answer the prompts.
-- **Smart Formatting:** Automatically generates perfectly structured Markdown.
-- **Graceful Exits:** Hit `Ctrl+C` anytime to exit safely without stack traces.
-- **Built-in Help:** Run `prsmith --help` to view documentation directly in your terminal.
+---
+
+## 💻 Usage
 
-## Usage
+### 1. Fully Interactive Mode
 
-### Standard Mode
-The primary way to use PRSmith is via its interactive mode. Simply run:
+The simplest way to use PRSmith:
 
 ```bash
 prsmith
 ```
-This will launch the interactive prompt asking for Severity, Title, Issue, and Fix.
 
-### Commands & Flags
+This starts the wizard, prompting you for:
 
-| Command | Description |
-| :--- | :--- |
-| `prsmith` | Launch the interactive generator |
-| `prsmith -h`, `--help` | Display the help menu and commands |
-| `prsmith -v`, `--version` | Print the current installed version |
+- Severity level & Title
+- Problem description & Suggested fix (opens your system's default `$EDITOR` like VS Code, Vim, or Nano for comfortable multi-line editing)
+- Optional File & Line context
+- Optional Before & After code snippets
+- Optional AI Polish toggle
 
-<details>
-<summary><b>Click to view an Example Interaction</b></summary>
+### 2. Interactive Batch Mode (New)
 
-<br/>
+Review multiple issues in a single terminal session and compile them into a unified report:
+
+```bash
+prsmith batch
+```
+
+At the end of the batch review, an interactive menu allows you to copy the unified report, save it to a file, or **submit all comments at once as native inline review threads** on a GitHub PR.
+
+### 3. Non-Interactive CLI Flags
+
+Bypass the prompts entirely for fast operations or CI/CD pipelines:
 
-**Input Data:**
+```bash
+prsmith -s Critical -t "Resource Leak" -i "The connection is never closed." -f "Add a finally block." -p "src/db.js" -l "12-15" --ai --github --pr 42
+```
 
-| Field | Input |
-| :--- | :--- |
-| **Severity** | `<kbd>Critical</kbd>` |
-| **Title** | `Scope Issue` |
-| **Issue** | `Utility functions are nested incorrectly.` |
-| **Suggested Fix** | `Move them to module scope.` |
+| Flag       | Full         | Description                                                        |
+| :--------- | :----------- | :----------------------------------------------------------------- |
+| `-s`       | `--severity` | Severity level (e.g., Critical, Suggestion)                        |
+| `-t`       | `--title`    | The review title                                                   |
+| `-i`       | `--issue`    | Description of the problem                                         |
+| `-f`       | `--fix`      | Suggested solution                                                 |
+| `-o`       | `--out`      | Save generated markdown to a specific file                         |
+| `-p`       | `--path`     | File path context of code under review                             |
+| `-l`       | `--line`     | Line number or range (e.g. `12` or `45-50`)                        |
+| `--lang`   | `--lang`     | Programming language for code highlighting (default: `javascript`) |
+| `--before` | `--before`   | Original code snippet (Before)                                     |
+| `--after`  | `--after`    | Proposed code snippet (After)                                      |
+| `--ai`     | `--ai`       | Toggle AI-assisted polishing for constructive tone                 |
+| `--github` | `--github`   | Post comments directly to GitHub                                   |
+| `--pr`     | `--pr`       | The GitHub Pull Request number                                     |
+| `--repo`   | `--repo`     | GitHub repository in `owner/repo` format                           |
 
-**Output Markdown:**
+---
+
+## 🛠️ Configuration (`.prsmith.json`)
+
+To enable AI polishing and GitHub integration, create a `.prsmith.json` file in your home directory (`~/`) or current project working directory:
+
+```json
+{
+  "githubToken": "ghp_yourGitHubPersonalAccessToken",
+  "aiProvider": "gemini",
+  "aiApiKey": "AI_PROVIDER_API_KEY",
+  "aiModel": "gemini-1.5-flash",
+  "defaultBranch": "main",
+  "templates": {
+    "Nitpick": "This is just a tiny nitpick, no pressure to fix.",
+    "Security": "CRITICAL SECURITY VULNERABILITY DETECTED."
+  }
+}
+```
 
-```md
-### Critical: Scope Issue
+### AI Configuration Mappings:
 
-The current implementation introduces a critical issue.
+- **`aiProvider`**: `gemini` (default), `openai`, or `groq`.
+- **`aiModel`**:
+  - Gemini default: `gemini-1.5-flash`
+  - OpenAI default: `gpt-4o-mini`
+  - Groq default: `llama-3.3-70b-versatile`
+- Credentials can also be supplied via **Environment Variables**:
+  - `GITHUB_TOKEN`
+  - `GEMINI_API_KEY`
+  - `OPENAI_API_KEY`
+  - `GROQ_API_KEY`
+
+---
+
+<details>
+<summary><b>Click to view an Example Markdown Output</b></summary>
+
+<br/>
+
+### Suggestion: Optimized Loop
+
+The implementation works, but there may be a cleaner approach.
+
+📁 **File:** [`src/utils/math.js:15-20`](https://github.com/tarunyaprogrammer/PRSmith/blob/main/src/utils/math.js#L15)
 
 **Problem**
 
-Utility functions are nested incorrectly.
+The current `forEach` iteration is performing multiple lookups on a large array, which has a noticeable performance overhead in hot paths.
 
 **Suggested Fix**
 
-Move them to module scope.
+We can optimize this by storing the length in a local variable and utilizing a standard `for-i` loop.
+
+<details>
+<summary>🔍 View Code Diff / Comparison</summary>
+
+**Before:**
+
+```javascript
+items.forEach((item) => {
+  doCalculation(item);
+});
 ```
 
+**After:**
+
+```javascript
+const len = items.length;
+for (let i = 0; i < len; i++) {
+  doCalculation(items[i]);
+}
+```
+
+</details>
+
 </details>
 
 ---
@@ -129,6 +232,7 @@ npm run lint
 # Format the code
 npm run format
 ```
+
 </details>
 
 ## License

package/bin/cli.js

@@ -1,36 +1,216 @@
 #!/usr/bin/env node
 
-import chalk from "chalk";
-import { program } from "commander";
-import { getReviewData } from "../src/prompts.js";
-import { generateMarkdown } from "../src/formatter.js";
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import chalk from 'chalk';
+import { program } from 'commander';
+import clipboardy from 'clipboardy';
+import updateNotifier from 'update-notifier';
+import inquirer from 'inquirer';
+import { getReviewData } from '../src/prompts.js';
+import { generateMarkdown } from '../src/formatter.js';
+import { loadConfig } from '../src/config.js';
+import { polishText } from '../src/ai.js';
+import { detectGithubRepo, postPRComment } from '../src/github.js';
+import { runBatchReview } from '../src/batch.js';
 
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const pkg = JSON.parse(
+  fs.readFileSync(path.join(__dirname, '../package.json'), 'utf8')
+);
+
+updateNotifier({ pkg }).notify();
+
+// Define 'batch' command
 program
-  .name("prsmith")
-  .description("Forge professional pull request review comments directly from the terminal.")
-  .version("1.0.1", "-v, --version", "Output the current version")
-  .helpOption("-h, --help", "Display help for command")
+  .command('batch')
+  .description(
+    'Start an interactive batch review loop to bundle multiple comments.'
+  )
   .action(async () => {
+    try {
+      const config = loadConfig();
+      await runBatchReview(config);
+    } catch (error) {
+      if (error.name === 'ExitPromptError') {
+        console.log(chalk.yellow('\nYou have quit Batch Review Mode :) \n'));
+        process.exit(0);
+      }
+      console.error(chalk.red('\nSomething went wrong in Batch Mode.\n'));
+      console.error(error);
+      process.exit(1);
+    }
+  });
+
+// Main program CLI options
+program
+  .name('prsmith')
+  .description(
+    'Forge professional pull request review comments directly from the terminal.'
+  )
+  .version(pkg.version, '-v, --version', 'Output the current version')
+  .helpOption('-h, --help', 'Display help for command')
+
+  // Existing Options
+  .option(
+    '-s, --severity <level>',
+    'Severity of the issue (e.g. Critical, Major, Minor, Suggestion)'
+  )
+  .option('-t, --title <title>', 'Title of the review')
+  .option('-i, --issue <issue>', 'Description of the issue')
+  .option('-f, --fix <fix>', 'Suggested fix')
+  .option('-o, --out <file>', 'Save the output to a markdown file')
+
+  // New Options (v2.0.0)
+  .option(
+    '-p, --path <filepath>',
+    'File path context of the code being reviewed'
+  )
+  .option('-l, --line <range>', 'Line number or range (e.g. 12 or 45-50)')
+  .option(
+    '--lang <language>',
+    'Programming language for code syntax highlighting',
+    'javascript'
+  )
+  .option('--before <code>', 'Original code snippet (Before)')
+  .option('--after <code>', 'Proposed code snippet (After)')
+  .option('--ai', 'Automatically polish description and fix with AI for tone')
+  .option(
+    '--github',
+    'Post the review comment directly to a GitHub Pull Request'
+  )
+  .option('--pr <prNumber>', 'The Pull Request number to post comment to')
+  .option(
+    '--repo <owner/repo>',
+    "GitHub repository in 'owner/repo' format (otherwise auto-detected)"
+  )
+
+  .action(async (options) => {
+    // If the subcommand 'batch' is run, this main action is skipped automatically by Commander
     try {
       console.log(
-        chalk.cyan("\nPRSmith - Professional PR Review Comment Generator\n")
+        chalk.cyan('\nPRSmith - Professional PR Review Comment Generator\n')
       );
 
-      const data = await getReviewData();
+      const config = loadConfig();
+
+      // Get the rest of review data interactively or via flags
+      let data = await getReviewData(options, config);
 
-      const markdown = generateMarkdown(data);
+      // Perform AI Polish if requested
+      if (data.ai) {
+        console.log(chalk.yellow('\n✨ Polishing comments with AI...'));
+        data.issue = await polishText(
+          data.issue,
+          'Problem Description',
+          config
+        );
+        data.fix = await polishText(data.fix, 'Suggested Fix', config);
+      }
+
+      // Generate the markdown block
+      const markdown = generateMarkdown(data, config);
 
-      console.log(chalk.green("\nGenerated Comment:\n"));
+      console.log(chalk.green('\nGenerated Comment:\n'));
       console.log(markdown);
+
+      // Clipboard integration
+      try {
+        clipboardy.writeSync(markdown);
+        console.log(chalk.green('✅ Comment copied to clipboard!'));
+      } catch {
+        console.warn(
+          chalk.yellow('⚠️ Could not write to clipboard automatically.')
+        );
+      }
+
+      // Save to file if output specified
+      if (options.out) {
+        const outPath = path.resolve(process.cwd(), options.out);
+        fs.writeFileSync(outPath, markdown, 'utf8');
+        console.log(chalk.green(`✅ Comment saved to ${outPath}`));
+      }
+
+      // Post to GitHub if specified
+      if (options.github || options.pr || options.repo) {
+        const detectedRepo = detectGithubRepo();
+        let owner = '';
+        let repoName = '';
+
+        if (options.repo) {
+          const parts = options.repo.split('/');
+          if (parts.length === 2) {
+            owner = parts[0];
+            repoName = parts[1];
+          }
+        } else if (detectedRepo) {
+          owner = detectedRepo.owner;
+          repoName = detectedRepo.repo;
+        }
+
+        const prQuestions = [];
+        if (!owner || !repoName) {
+          prQuestions.push(
+            {
+              type: 'input',
+              name: 'owner',
+              message: 'GitHub repository owner:',
+              validate: (val) => val.trim() !== '' || 'Owner is required.',
+            },
+            {
+              type: 'input',
+              name: 'repoName',
+              message: 'GitHub repository name:',
+              validate: (val) => val.trim() !== '' || 'Repo name is required.',
+            }
+          );
+        }
+
+        if (!options.pr) {
+          prQuestions.push({
+            type: 'input',
+            name: 'prNumber',
+            message: 'Pull Request Number:',
+            validate: (val) =>
+              /^\d+$/.test(val.trim()) || 'PR number must be an integer.',
+          });
+        }
+
+        const prAnswers =
+          prQuestions.length > 0 ? await inquirer.prompt(prQuestions) : {};
+
+        const finalOwner = owner || prAnswers.owner;
+        const finalRepo = repoName || prAnswers.repoName;
+        const finalPr = options.pr || prAnswers.prNumber;
+
+        console.log(
+          chalk.yellow('\n🚀 Posting comment directly to GitHub PR...')
+        );
+
+        const commentUrl = await postPRComment(
+          finalOwner,
+          finalRepo,
+          finalPr,
+          markdown,
+          config
+        );
+
+        console.log(
+          chalk.green(`🎉 Success! Comment posted to GitHub PR #${finalPr}`)
+        );
+        console.log(chalk.green(`🔗 Comment Link: ${commentUrl}\n`));
+      }
     } catch (error) {
-      if (error.name === "ExitPromptError") {
-        console.log(chalk.yellow("\nYou have quit in b/w :) \n"));
+      if (error.name === 'ExitPromptError') {
+        console.log(chalk.yellow('\nYou have quit in b/w :) \n'));
         process.exit(0);
       }
-      console.error(chalk.red("\nSomething went wrong.\n"));
+      console.error(chalk.red('\nSomething went wrong.\n'));
       console.error(error);
       process.exit(1);
     }
   });
 
-program.parse(process.argv);
+program.parse(process.argv);

package/eslint.config.js

@@ -1,18 +1,20 @@
-import js from "@eslint/js";
+import js from '@eslint/js';
 
 export default [
   js.configs.recommended,
   {
     languageOptions: {
-      ecmaVersion: "latest",
-      sourceType: "module",
+      ecmaVersion: 'latest',
+      sourceType: 'module',
       globals: {
-        process: "readonly",
-        console: "readonly",
+        process: 'readonly',
+        console: 'readonly',
+        fetch: 'readonly',
+        global: 'readonly',
       },
     },
     rules: {
-      "no-unused-vars": "warn",
+      'no-unused-vars': 'warn',
     },
   },
 ];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prsmith",
-  "version": "1.0.2",
+  "version": "2.0.0",
   "description": "Forge professional pull request review comments from simple prompts.",
   "keywords": [
     "pull-request",
@@ -25,8 +25,10 @@
   },
   "dependencies": {
     "chalk": "^5.6.2",
+    "clipboardy": "^5.3.1",
     "commander": "^15.0.0",
-    "inquirer": "^14.0.1"
+    "inquirer": "^14.0.1",
+    "update-notifier": "^7.3.1"
   },
   "devDependencies": {
     "@eslint/js": "^10.0.1",