prsmith 1.0.0

package/.github/workflows/ci.yml

@@ -0,0 +1,21 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          cache: 'npm'
+      - run: npm ci
+      - run: npm run lint
+      - run: npm run test

package/.husky/pre-commit

@@ -0,0 +1,2 @@
+npm run lint
+npm test

package/.prettierrc

@@ -0,0 +1,6 @@
+{
+  "semi": true,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "trailingComma": "es5"
+}

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [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/LICENSE

@@ -0,0 +1,11 @@
+MIT License
+
+Copyright Tarunya Kesharwani (tarunyak) 2026
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND.

package/README.md

@@ -0,0 +1,93 @@
+# PRSmith
+
+[![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)
+
+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]
+```
+
+---
+
+## Installation
+
+Install globally to use it anywhere on your machine.
+
+```bash
+npm install -g prsmith
+```
+
+## Usage
+
+Simply run the command in your terminal:
+
+```bash
+prsmith
+```
+
+## Example Interaction
+
+**Input:**
+- Severity: `Critical`
+- Title: `Scope Issue`
+- Issue: `Utility functions are nested incorrectly.`
+- Suggested Fix: `Move them to module scope.`
+
+**Output:**
+
+```md
+### Critical: Scope Issue
+
+The current implementation introduces a critical issue.
+
+**Problem**
+
+Utility functions are nested incorrectly.
+
+**Suggested Fix**
+
+Move them to module scope.
+```
+
+## Development & Contribution
+
+To set up the project locally:
+
+```bash
+# Install dependencies
+npm install
+
+# Run the CLI locally
+npm start
+
+# Run unit tests
+npm test
+
+# Lint the codebase
+npm run lint
+
+# Format the code
+npm run format
+```
+
+## License
+
+This project is licensed under the MIT License.

package/bin/cli.js

@@ -0,0 +1,30 @@
+#!/usr/bin/env node
+
+import chalk from "chalk";
+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")
+    );
+
+    const data = await getReviewData();
+
+    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.error(chalk.red("\nSomething went wrong.\n"));
+    console.error(error);
+    process.exit(1);
+  }
+}
+
+main();

package/eslint.config.js

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

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "prsmith",
+  "version": "1.0.0",
+  "description": "Forge professional pull request review comments from simple prompts.",
+  "keywords": [
+    "pull-request",
+    "code-review",
+    "github",
+    "cli",
+    "developer-tools"
+  ],
+  "license": "MIT",
+  "author": "tarunyak",
+  "type": "module",
+  "main": "index.js",
+  "bin": {
+    "prsmith": "bin/cli.js"
+  },
+  "scripts": {
+    "start": "node bin/cli.js",
+    "test": "vitest run",
+    "lint": "eslint .",
+    "format": "prettier --write .",
+    "prepare": "husky"
+  },
+  "dependencies": {
+    "chalk": "^5.6.2",
+    "commander": "^15.0.0",
+    "inquirer": "^14.0.1"
+  },
+  "devDependencies": {
+    "@eslint/js": "^10.0.1",
+    "eslint": "^10.4.1",
+    "husky": "^9.1.7",
+    "prettier": "^3.8.3",
+    "vitest": "^4.1.7"
+  }
+}

package/src/formatter.js

@@ -0,0 +1,20 @@
+import { templates } from "./templates.js";
+
+export function generateMarkdown(data) {
+  const intro =
+    templates[data.severity] ||
+    "The current implementation requires attention.";
+
+  return `### ${data.severity}: ${data.title}
+
+${intro}
+
+**Problem**
+
+${data.issue}
+
+**Suggested Fix**
+
+${data.fix}
+`;
+}

package/src/generator.js

@@ -0,0 +1 @@
+// generator.js

package/src/prompts.js

@@ -0,0 +1,27 @@
+import inquirer from "inquirer";
+
+export async function getReviewData() {
+  return inquirer.prompt([
+    {
+      type: "select",
+      name: "severity",
+      message: "Select severity:",
+      choices: ["Critical", "Major", "Minor", "Suggestion"],
+    },
+    {
+      type: "input",
+      name: "title",
+      message: "Review title:",
+    },
+    {
+      type: "input",
+      name: "issue",
+      message: "Describe the issue:",
+    },
+    {
+      type: "input",
+      name: "fix",
+      message: "Suggested fix:",
+    },
+  ]);
+}

package/src/templates.js

@@ -0,0 +1,13 @@
+export const templates = {
+  Critical:
+    "The current implementation introduces a critical issue.",
+
+  Major:
+    "The current implementation introduces a significant issue.",
+
+  Minor:
+    "The current implementation could be improved.",
+
+  Suggestion:
+    "The implementation works, but there may be a cleaner approach."
+};

package/tests/formatter.test.js

@@ -0,0 +1,32 @@
+import { describe, it, expect } from "vitest";
+import { generateMarkdown } from "../src/formatter.js";
+
+describe("formatter.js", () => {
+  it("should generate proper markdown for Critical severity", () => {
+    const data = {
+      severity: "Critical",
+      title: "Memory Leak",
+      issue: "The connection is never closed.",
+      fix: "Add a finally block to close the connection."
+    };
+
+    const markdown = generateMarkdown(data);
+    
+    expect(markdown).toContain("### Critical: Memory Leak");
+    expect(markdown).toContain("The current implementation introduces a critical issue.");
+    expect(markdown).toContain("The connection is never closed.");
+    expect(markdown).toContain("Add a finally block to close the connection.");
+  });
+
+  it("should fallback to a default intro if severity is unknown", () => {
+    const data = {
+      severity: "Unknown",
+      title: "Something",
+      issue: "Bad code.",
+      fix: "Fix code."
+    };
+
+    const markdown = generateMarkdown(data);
+    expect(markdown).toContain("The current implementation requires attention.");
+  });
+});