prsmith 1.0.1 → 1.1.0

package/CHANGELOG.md

@@ -2,6 +2,33 @@
 
 All notable changes to this project will be documented in this file.
 
+## [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

package/README.md

@@ -1,28 +1,38 @@
-# PRSmith
+<div align="center">
+  <h1>PRSmith</h1>
+  
+  [![npm version](https://img.shields.io/npm/v/prsmith.svg?style=flat-square)](https://www.npmjs.com/package/prsmith)
+  [![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)
 
-[![npm version](https://img.shields.io/npm/v/prsmith.svg?style=flat-square)](https://www.npmjs.com/package/prsmith)
-[![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>
+</div>
 
-Forge professional pull request review comments directly from the terminal.
+---
 
 PRSmith streamlines the process of writing code reviews by providing an interactive prompt that generates consistently formatted, polite, and actionable Markdown comments.
 
----
-
 ## Architecture Flow
 
 The tool operates via a straightforward interactive flow, generating structured markdown from your inputs.
 
-```mermaid
-graph TD
-    A[User runs 'prsmith'] --> B{Interactive Prompts}
-    B -->|Severity| C[Select Critical, Major, Minor, Suggestion]
-    B -->|Title| D[Enter Title]
-    B -->|Issue| E[Describe Problem]
-    B -->|Fix| F[Suggest Fix]
-    C & D & E & F --> G[Markdown Generator]
-    G --> H[Print Formatted PR Comment]
+```text
+ ┌──────────────────────────┐
+ │  Run `prsmith` Command   │
+ └────────────┬─────────────┘
+              ▼
+ ┌──────────────────────────┐
+ │   Interactive Prompts    │
+ │ (Severity, Title, Issue) │
+ └────────────┬─────────────┘
+              ▼
+ ┌──────────────────────────┐
+ │   Markdown Generation    │
+ └────────────┬─────────────┘
+              ▼
+ ┌──────────────────────────┐
+ │ Print Formatted Comment  │
+ └──────────────────────────┘
 ```
 
 ---
@@ -35,25 +45,71 @@ Install globally to use it anywhere on your machine.
 npm install -g prsmith
 ```
 
-## Usage
+## ✨ Advanced Features (v1.1.0)
 
-Simply run the command in your terminal:
+- **Interactive Editor Prompts:** For multi-line issues, PRSmith temporarily opens your system's default `$EDITOR` (like VS Code or Vim) so you can type formatted text seamlessly.
+- **Auto-Clipboard:** No need to manually highlight terminal output! The generated markdown is automatically copied to your clipboard.
+- **Bypass Prompts:** Skip the interactive flow completely by using CLI arguments (perfect for scripting).
+- **File Output:** Directly write the output to a `.md` file using the `--out` flag.
+- **Custom Templates:** Create a `.prsmith.json` file in your project or home directory to define your own severity levels and custom intro messages.
+
+## 💻 Usage
+
+### Interactive Mode
+The primary way to use PRSmith is via its interactive mode. Simply run:
 
 ```bash
 prsmith
 ```
+This will launch the interactive prompt. When asked to describe the issue or fix, your default terminal editor will launch, allowing you to write multi-line markdown!
+
+### Non-Interactive Flags
+
+You can bypass the prompts entirely:
+
+```bash
+prsmith -s Critical -t "Memory Leak" -i "Connection left open." -f "Add a finally block." -o review.md
+```
+
+| Flag | Full | Description |
+| :--- | :--- | :--- |
+| `-s` | `--severity` | Severity level (e.g., Critical, Minor) |
+| `-t` | `--title` | The review title |
+| `-i` | `--issue` | Description of the problem |
+| `-f` | `--fix` | Suggested solution |
+| `-o` | `--out` | Save generated markdown to a specific file |
+
+### Configuration (`.prsmith.json`)
+
+You can define custom templates by creating a `.prsmith.json` in your home directory (`~/`) or current working directory:
+
+```json
+{
+  "templates": {
+    "Nitpick": "This is just a tiny nitpick, no pressure to fix.",
+    "Security": "CRITICAL SECURITY VULNERABILITY DETECTED."
+  }
+}
+```
+If you pass `-s Nitpick` (or select it in the CLI), PRSmith will automatically use your custom text!
+
+<details>
+<summary><b>Click to view an Example Interaction</b></summary>
 
-## Example Interaction
+<br/>
 
-**Input:**
+**Input Data:**
 
-- Severity: `Critical`
-- Title: `Scope Issue`
-- Issue: `Utility functions are nested incorrectly.`
-- Suggested Fix: `Move them to module scope.`
+| Field | Input |
+| :--- | :--- |
+| **Severity** | `<kbd>Critical</kbd>` |
+| **Title** | `Scope Issue` |
+| **Issue** | `Utility functions are nested incorrectly.` |
+| **Suggested Fix** | `Move them to module scope.` |
 
-**Output:**
+**Output Markdown:**
 
+```md
 ### Critical: Scope Issue
 
 The current implementation introduces a critical issue.
@@ -65,9 +121,19 @@ Utility functions are nested incorrectly.
 **Suggested Fix**
 
 Move them to module scope.
+```
+
+</details>
+
+---
 
 ## Development & Contribution
 
+<details>
+<summary><b>Local Setup Guide</b></summary>
+
+<br/>
+
 To set up the project locally:
 
 ```bash
@@ -86,7 +152,27 @@ npm run lint
 # Format the code
 npm run format
 ```
+</details>
 
 ## License
 
 This project is licensed under the MIT License.
+
+---
+
+<div align="center">
+  <h3>Built with 💻 by Tarunya Kesharwani</h3>
+  
+  <p>
+    <i>"I build things. Usually web apps, sometimes automation scripts that save me from doing something tedious twice."</i>
+  </p>
+  
+  <p>
+    I'm a Full-Stack Engineer and Open Source fanatic (GSoC'26 @ C2SI, Mentor @ GSSoC & SSoC). I obsess over frontend architecture that doesn't collapse under its own weight, seamless developer experiences, and building UI that feels intentional. When I'm not writing TypeScript, I'm probably deep in a rabbit hole about AI, startup strategy, or restructuring a folder hierarchy for the third time. 
+  </p>
+
+  <p>
+    <a href="https://www.github.com/tarunyaprogrammer"><b>GitHub</b></a> &nbsp;&bull;&nbsp;
+    <a href="https://www.linkedin.com/in/tarunyakesharwani/"><b>LinkedIn</b></a>
+  </p>
+</div>

package/bin/cli.js

@@ -1,30 +1,64 @@
 #!/usr/bin/env node
 
+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 { getReviewData } from "../src/prompts.js";
 import { generateMarkdown } from "../src/formatter.js";
+import { loadConfig } from "../src/config.js";
 
-async function main() {
-  try {
-    console.log(
-      chalk.cyan("\nPRSmith - Professional PR Review Comment Generator\n")
-    );
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const pkg = JSON.parse(
+  fs.readFileSync(path.join(__dirname, "../package.json"), "utf8")
+);
 
-    const data = await getReviewData();
+updateNotifier({ pkg }).notify();
 
-    const markdown = generateMarkdown(data);
+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")
+  .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")
+  .action(async (options) => {
+    try {
+      console.log(
+        chalk.cyan("\nPRSmith - Professional PR Review Comment Generator\n")
+      );
 
-    console.log(chalk.green("\nGenerated Comment:\n"));
-    console.log(markdown);
-  } catch (error) {
-    if (error.name === "ExitPromptError") {
-      console.log(chalk.yellow("\nYou have quit in b/w :) \n"));
-      process.exit(0);
+      const config = loadConfig();
+      const data = await getReviewData(options, config);
+      const markdown = generateMarkdown(data, config);
+
+      console.log(chalk.green("\nGenerated Comment:\n"));
+      console.log(markdown);
+
+      clipboardy.writeSync(markdown);
+      console.log(chalk.green("✅ Comment copied to clipboard!\n"));
+
+      if (options.out) {
+        const outPath = path.resolve(process.cwd(), options.out);
+        fs.writeFileSync(outPath, markdown, "utf8");
+        console.log(chalk.green(`✅ Comment saved to ${outPath}\n`));
+      }
+    } catch (error) {
+      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(error);
+      process.exit(1);
     }
-    console.error(chalk.red("\nSomething went wrong.\n"));
-    console.error(error);
-    process.exit(1);
-  }
-}
+  });
 
-main();
+program.parse(process.argv);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prsmith",
-  "version": "1.0.1",
+  "version": "1.1.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",

package/src/config.js

@@ -0,0 +1,28 @@
+import fs from 'fs';
+import path from 'path';
+import os from 'os';
+
+export function loadConfig() {
+  const configPaths = [
+    path.join(os.homedir(), '.prsmith.json'),
+    path.join(process.cwd(), '.prsmith.json')
+  ];
+
+  let mergedConfig = { templates: {} };
+
+  for (const configPath of configPaths) {
+    if (fs.existsSync(configPath)) {
+      try {
+        const fileContent = fs.readFileSync(configPath, 'utf-8');
+        const parsed = JSON.parse(fileContent);
+        if (parsed.templates) {
+          mergedConfig.templates = { ...mergedConfig.templates, ...parsed.templates };
+        }
+      } catch (err) {
+        console.warn(`Warning: Could not parse config at ${configPath} - ${err.message}`);
+      }
+    }
+  }
+
+  return mergedConfig;
+}

package/src/formatter.js

@@ -1,8 +1,9 @@
-import { templates } from "./templates.js";
+import { templates as defaultTemplates } from "./templates.js";
 
-export function generateMarkdown(data) {
+export function generateMarkdown(data, config = {}) {
+  const mergedTemplates = { ...defaultTemplates, ...(config.templates || {}) };
   const intro =
-    templates[data.severity] ||
+    mergedTemplates[data.severity] ||
     "The current implementation requires attention.";
 
   return `### ${data.severity}: ${data.title}

package/src/prompts.js

@@ -1,27 +1,52 @@
 import inquirer from "inquirer";
 
-export async function getReviewData() {
-  return inquirer.prompt([
-    {
+export async function getReviewData(options = {}, config = {}) {
+  const defaultSeverities = ["Critical", "Major", "Minor", "Suggestion"];
+  let severities = [...defaultSeverities];
+  if (config.templates) {
+    for (const key of Object.keys(config.templates)) {
+      if (!severities.includes(key)) {
+        severities.push(key);
+      }
+    }
+  }
+
+  const questions = [];
+
+  if (!options.severity) {
+    questions.push({
       type: "select",
       name: "severity",
       message: "Select severity:",
-      choices: ["Critical", "Major", "Minor", "Suggestion"],
-    },
-    {
+      choices: severities,
+    });
+  }
+
+  if (!options.title) {
+    questions.push({
       type: "input",
       name: "title",
       message: "Review title:",
-    },
-    {
-      type: "input",
+    });
+  }
+
+  if (!options.issue) {
+    questions.push({
+      type: "editor",
       name: "issue",
       message: "Describe the issue:",
-    },
-    {
-      type: "input",
+    });
+  }
+
+  if (!options.fix) {
+    questions.push({
+      type: "editor",
       name: "fix",
       message: "Suggested fix:",
-    },
-  ]);
+    });
+  }
+
+  const answers = questions.length > 0 ? await inquirer.prompt(questions) : {};
+
+  return { ...options, ...answers };
 }

package/tests/formatter.test.js

@@ -29,4 +29,23 @@ describe("formatter.js", () => {
     const markdown = generateMarkdown(data);
     expect(markdown).toContain("The current implementation requires attention.");
   });
+
+  it("should use custom templates when passed via config", () => {
+    const data = {
+      severity: "Nitpick",
+      title: "Formatting",
+      issue: "Indentation is off.",
+      fix: "Fix indentation."
+    };
+
+    const config = {
+      templates: {
+        Nitpick: "This is a tiny nitpick."
+      }
+    };
+
+    const markdown = generateMarkdown(data, config);
+    expect(markdown).toContain("### Nitpick: Formatting");
+    expect(markdown).toContain("This is a tiny nitpick.");
+  });
 });