prsmith 1.0.0 → 1.0.2

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,23 +45,46 @@ Install globally to use it anywhere on your machine.
 npm install -g prsmith
 ```
 
+## Features
+
+- **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
 
-Simply run the command in your terminal:
+### Standard Mode
+The primary way to use PRSmith is via its interactive mode. Simply run:
 
 ```bash
 prsmith
 ```
+This will launch the interactive prompt asking for Severity, Title, Issue, and Fix.
+
+### Commands & Flags
+
+| Command | Description |
+| :--- | :--- |
+| `prsmith` | Launch the interactive generator |
+| `prsmith -h`, `--help` | Display the help menu and commands |
+| `prsmith -v`, `--version` | Print the current installed version |
+
+<details>
+<summary><b>Click to view an Example Interaction</b></summary>
+
+<br/>
 
-## Example Interaction
+**Input Data:**
 
-**Input:**
-- 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
@@ -67,8 +100,17 @@ Utility functions are nested incorrectly.
 Move them to module scope.
 ```
 
+</details>
+
+---
+
 ## Development & Contribution
 
+<details>
+<summary><b>Local Setup Guide</b></summary>
+
+<br/>
+
 To set up the project locally:
 
 ```bash
@@ -87,7 +129,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,36 @@
 #!/usr/bin/env node
 
 import chalk from "chalk";
+import { program } from "commander";
 import { getReviewData } from "../src/prompts.js";
 import { generateMarkdown } from "../src/formatter.js";
 
-async function main() {
-  try {
-    console.log(
-      chalk.cyan("\nPRSmith - Professional PR Review Comment Generator\n")
-    );
+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")
+  .action(async () => {
+    try {
+      console.log(
+        chalk.cyan("\nPRSmith - Professional PR Review Comment Generator\n")
+      );
 
-    const data = await getReviewData();
+      const data = await getReviewData();
 
-    const markdown = generateMarkdown(data);
+      const markdown = generateMarkdown(data);
 
-    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);
+      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);
+      }
+      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.0",
+  "version": "1.0.2",
   "description": "Forge professional pull request review comments from simple prompts.",
   "keywords": [
     "pull-request",