jstar-reviewer 2.0.4 → 2.1.0

package/README.md

@@ -37,10 +37,13 @@ curl -fsSL https://raw.githubusercontent.com/JStaRFilms/jstar-code-review/v2.0.0
 
 ### After Install:
 
-1. Copy `.env.example` → `.env.local`
-2. Add your `GOOGLE_API_KEY` and `GROQ_API_KEY`
-3. Run `jstar init` to build the brain
-4. Run `jstar review` to review staged changes
+1.  **Check Config**: The tool now **auto-creates** `.env.example` and `.jstar/` when you run it.
+2.  **Add Keys**: Copy `.env.example` → `.env.local` and add your `GOOGLE_API_KEY` and `GROQ_API_KEY`.
+3.  **Index**: Run `jstar init` (or `pnpm run index:init`) to build the brain.
+4.  **Review**: Stage changes (`git add`) and run `jstar review` (or `pnpm run review`).
+
+For a detailed walkthrough, see **[ONBOARDING.md](./ONBOARDING.md)**.
+
 
 ---
 

package/bin/jstar.js

@@ -134,35 +134,48 @@ function runScript(scriptName) {
     });
 }
 
+const REQUIRED_ENV_VARS = {
+    'GOOGLE_API_KEY': '# Required: Google API key for Gemini embeddings\nGOOGLE_API_KEY=your_google_api_key_here',
+    'GROQ_API_KEY': '# Required: Groq API key for LLM reviews\nGROQ_API_KEY=your_groq_api_key_here',
+    'REVIEW_MODEL_NAME': '# Optional: Override the default model\n# REVIEW_MODEL_NAME=moonshotai/kimi-k2-instruct-0905'
+};
+
 function createSetupFiles() {
     const cwd = process.cwd();
 
-    // Create .jstar directory
+    // 1. Create .jstar directory
     const jstarDir = path.join(cwd, '.jstar');
     if (!fs.existsSync(jstarDir)) {
         fs.mkdirSync(jstarDir, { recursive: true });
         log(`${COLORS.green}✓${COLORS.reset} Created .jstar/`);
     }
 
-    // Create .env.example
-    const envExample = `# J-Star Reviewer Configuration
-# Copy this to .env.local and fill in your keys
-
-# Required: Google API key for Gemini embeddings
-GOOGLE_API_KEY=your_google_api_key_here
+    // 2. Create/Update .env.example
+    const envExamplePath = path.join(cwd, '.env.example');
+    if (fs.existsSync(envExamplePath)) {
+        let content = fs.readFileSync(envExamplePath, 'utf-8');
+        let addedKeys = [];
 
-# Required: Groq API key for LLM reviews
-GROQ_API_KEY=your_groq_api_key_here
-`;
+        for (const [key, template] of Object.entries(REQUIRED_ENV_VARS)) {
+            if (!content.includes(key)) {
+                content += '\n' + template + '\n';
+                addedKeys.push(key);
+            }
+        }
 
-    const envPath = path.join(cwd, '.env.example');
-    if (!fs.existsSync(envPath)) {
-        fs.writeFileSync(envPath, envExample);
-        log(`${COLORS.green}✓${COLORS.reset} Created .env.example`);
+        if (addedKeys.length > 0) {
+            fs.writeFileSync(envExamplePath, content);
+            log(`${COLORS.green}✓${COLORS.reset} Updated .env.example with missing keys: ${addedKeys.join(', ')}`);
+        } else {
+            log(`${COLORS.dim}  .env.example already exists and is up to date${COLORS.reset}`);
+        }
     } else {
-        log(`${COLORS.dim}  .env.example already exists${COLORS.reset}`);
+        const initialEnv = "# J-Star Code Reviewer\n" + Object.values(REQUIRED_ENV_VARS).join("\n") + "\n";
+        fs.writeFileSync(envExamplePath, initialEnv);
+        log(`${COLORS.green}✓${COLORS.reset} Created .env.example`);
     }
 
+
     // Update .gitignore
     const gitignorePath = path.join(cwd, '.gitignore');
     const gitignoreAdditions = `

package/dist/scripts/config.js

@@ -1,17 +1,85 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Config = void 0;
 const dotenv_1 = __importDefault(require("dotenv"));
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+// --- Auto-Setup Logic ---
+const REQUIRED_ENV_VARS = {
+    'GOOGLE_API_KEY': '# Required: Google API key for Gemini embeddings\nGOOGLE_API_KEY=your_google_api_key_here',
+    'GROQ_API_KEY': '# Required: Groq API key for LLM reviews\nGROQ_API_KEY=your_groq_api_key_here',
+    'REVIEW_MODEL_NAME': '# Optional: Override the default model\n# REVIEW_MODEL_NAME=moonshotai/kimi-k2-instruct-0905'
+};
+function ensureSetup() {
+    const cwd = process.cwd();
+    const jstarDir = path.join(cwd, ".jstar");
+    const envExamplePath = path.join(cwd, ".env.example");
+    // 1. Ensure .jstar exists
+    if (!fs.existsSync(jstarDir)) {
+        fs.mkdirSync(jstarDir, { recursive: true });
+    }
+    // 2. Ensure .env.example is up to date
+    if (fs.existsSync(envExamplePath)) {
+        let content = fs.readFileSync(envExamplePath, 'utf-8');
+        let missing = false;
+        for (const [key, template] of Object.entries(REQUIRED_ENV_VARS)) {
+            if (!content.includes(key)) {
+                content += `\n${template}\n`;
+                missing = true;
+            }
+        }
+        if (missing) {
+            fs.writeFileSync(envExamplePath, content);
+        }
+    }
+    else {
+        const initialEnv = "# J-Star Code Reviewer\n" + Object.values(REQUIRED_ENV_VARS).join("\n") + "\n";
+        fs.writeFileSync(envExamplePath, initialEnv);
+    }
+}
+// Run setup check
+ensureSetup();
 // Load .env.local first, then .env
 dotenv_1.default.config({ path: ".env.local" });
 dotenv_1.default.config();
 /**
  * Default fallback values.
- * These are intentional fallbacks when environment variables are not configured.
- * Override via REVIEW_MODEL_NAME env var for production use.
  */
 const DEFAULT_MODEL = "moonshotai/kimi-k2-instruct-0905";
 exports.Config = {

package/dist/scripts/indexer.js

@@ -42,19 +42,16 @@ const mock_llm_1 = require("./mock-llm");
 const path = __importStar(require("path"));
 const fs = __importStar(require("fs"));
 const chalk_1 = __importDefault(require("chalk"));
-const dotenv_1 = __importDefault(require("dotenv"));
-// Load .env.local first, then .env
-dotenv_1.default.config({ path: ".env.local" });
-dotenv_1.default.config();
 // Configuration
 const STORAGE_DIR = path.join(process.cwd(), ".jstar", "storage");
 const SOURCE_DIR = path.join(process.cwd(), "scripts"); // Changed from src/ to scripts/
-// Ensure OpenAI Key exists (LlamaIndex default) or fallback if we configured something else
-// (We are using local now, so this check is less critical, but good to have if we revert)
-// if (!process.env.OPENAI_API_KEY) {
-//     console.warn(chalk.yellow("⚠️  OPENAI_API_KEY not found. Embeddings may fail unless you have configured a local model."));
-// }
 async function main() {
+    // 0. Environment Validation
+    if (!process.env.GOOGLE_API_KEY) {
+        console.error(chalk_1.default.red("❌ Missing GOOGLE_API_KEY!"));
+        console.log(chalk_1.default.yellow("\nPlease ensure you have a .env.local file. Check .env.example for a template.\n"));
+        process.exit(1);
+    }
     const args = process.argv.slice(2);
     const isWatch = args.includes("--watch");
     console.log(chalk_1.default.blue("🧠 J-Star Indexer: Scanning codebase..."));

package/dist/scripts/reviewer.js

@@ -125,7 +125,16 @@ function parseReviewResponse(text) {
 // --- Main ---
 async function main() {
     console.log(chalk_1.default.blue("🕵️  J-Star Reviewer: Analyzing your changes...\n"));
-    // 0. Detective
+    // 0. Environment Validation
+    if (!process.env.GOOGLE_API_KEY || !process.env.GROQ_API_KEY) {
+        console.error(chalk_1.default.red("❌ Missing API Keys!"));
+        console.log(chalk_1.default.yellow("\nPlease ensure you have a .env.local file with:"));
+        console.log(chalk_1.default.white("- GOOGLE_API_KEY"));
+        console.log(chalk_1.default.white("- GROQ_API_KEY"));
+        console.log(chalk_1.default.white("\nCheck .env.example for a template.\n"));
+        return;
+    }
+    // 1. Detective
     console.log(chalk_1.default.blue("🔎 Running Detective Engine..."));
     const detective = new detective_1.Detective(SOURCE_DIR);
     await detective.scan();

package/package.json

@@ -1,18 +1,10 @@
 {
   "name": "jstar-reviewer",
-  "version": "2.0.4",
+  "version": "2.1.0",
   "description": "Local-First, Context-Aware AI Code Reviewer - Works with any language",
   "bin": {
     "jstar": "bin/jstar.js"
   },
-  "scripts": {
-    "build": "tsc",
-    "index:init": "ts-node scripts/indexer.ts --init",
-    "index:watch": "ts-node scripts/indexer.ts --watch",
-    "review": "ts-node scripts/reviewer.ts",
-    "detect": "ts-node scripts/detective.ts",
-    "prepare": "husky install"
-  },
   "keywords": [
     "code-review",
     "ai",
@@ -62,5 +54,12 @@
   "type": "commonjs",
   "bugs": {
     "url": "https://github.com/JStaRFilms/jstar-code-review/issues"
+  },
+  "scripts": {
+    "build": "tsc",
+    "index:init": "ts-node scripts/indexer.ts --init",
+    "index:watch": "ts-node scripts/indexer.ts --watch",
+    "review": "ts-node scripts/reviewer.ts",
+    "detect": "ts-node scripts/detective.ts"
   }
 }

package/scripts/config.ts

@@ -1,14 +1,53 @@
 import dotenv from "dotenv";
+import * as fs from "fs";
+import * as path from "path";
 import { Severity } from "./types";
 
+// --- Auto-Setup Logic ---
+const REQUIRED_ENV_VARS = {
+    'GOOGLE_API_KEY': '# Required: Google API key for Gemini embeddings\nGOOGLE_API_KEY=your_google_api_key_here',
+    'GROQ_API_KEY': '# Required: Groq API key for LLM reviews\nGROQ_API_KEY=your_groq_api_key_here',
+    'REVIEW_MODEL_NAME': '# Optional: Override the default model\n# REVIEW_MODEL_NAME=moonshotai/kimi-k2-instruct-0905'
+};
+
+function ensureSetup() {
+    const cwd = process.cwd();
+    const jstarDir = path.join(cwd, ".jstar");
+    const envExamplePath = path.join(cwd, ".env.example");
+
+    // 1. Ensure .jstar exists
+    if (!fs.existsSync(jstarDir)) {
+        fs.mkdirSync(jstarDir, { recursive: true });
+    }
+
+    // 2. Ensure .env.example is up to date
+    if (fs.existsSync(envExamplePath)) {
+        let content = fs.readFileSync(envExamplePath, 'utf-8');
+        let missing = false;
+        for (const [key, template] of Object.entries(REQUIRED_ENV_VARS)) {
+            if (!content.includes(key)) {
+                content += `\n${template}\n`;
+                missing = true;
+            }
+        }
+        if (missing) {
+            fs.writeFileSync(envExamplePath, content);
+        }
+    } else {
+        const initialEnv = "# J-Star Code Reviewer\n" + Object.values(REQUIRED_ENV_VARS).join("\n") + "\n";
+        fs.writeFileSync(envExamplePath, initialEnv);
+    }
+}
+
+// Run setup check
+ensureSetup();
+
 // Load .env.local first, then .env
 dotenv.config({ path: ".env.local" });
 dotenv.config();
 
 /**
  * Default fallback values.
- * These are intentional fallbacks when environment variables are not configured.
- * Override via REVIEW_MODEL_NAME env var for production use.
  */
 const DEFAULT_MODEL = "moonshotai/kimi-k2-instruct-0905";
 
@@ -19,3 +58,4 @@ export const Config = {
         MEDIUM: 5
     }
 };
+

package/scripts/indexer.ts

@@ -9,28 +9,26 @@ import { MockLLM } from "./mock-llm";
 import * as path from "path";
 import * as fs from "fs";
 import chalk from "chalk";
-import dotenv from "dotenv";
-
-// Load .env.local first, then .env
-dotenv.config({ path: ".env.local" });
-dotenv.config();
+import { Config } from "./config";
 
 // Configuration
 const STORAGE_DIR = path.join(process.cwd(), ".jstar", "storage");
 const SOURCE_DIR = path.join(process.cwd(), "scripts"); // Changed from src/ to scripts/
 
-// Ensure OpenAI Key exists (LlamaIndex default) or fallback if we configured something else
-// (We are using local now, so this check is less critical, but good to have if we revert)
-// if (!process.env.OPENAI_API_KEY) {
-//     console.warn(chalk.yellow("⚠️  OPENAI_API_KEY not found. Embeddings may fail unless you have configured a local model."));
-// }
-
 async function main() {
+    // 0. Environment Validation
+    if (!process.env.GOOGLE_API_KEY) {
+        console.error(chalk.red("❌ Missing GOOGLE_API_KEY!"));
+        console.log(chalk.yellow("\nPlease ensure you have a .env.local file. Check .env.example for a template.\n"));
+        process.exit(1);
+    }
+
     const args = process.argv.slice(2);
     const isWatch = args.includes("--watch");
 
     console.log(chalk.blue("🧠 J-Star Indexer: Scanning codebase..."));
 
+
     // 1. Load documents (Your Code)
     if (!fs.existsSync(SOURCE_DIR)) {
         console.error(chalk.red(`❌ Source directory not found: ${SOURCE_DIR}`));

package/scripts/reviewer.ts

@@ -109,8 +109,19 @@ function parseReviewResponse(text: string): LLMReviewResponse {
 async function main() {
     console.log(chalk.blue("🕵️  J-Star Reviewer: Analyzing your changes...\n"));
 
-    // 0. Detective
+    // 0. Environment Validation
+    if (!process.env.GOOGLE_API_KEY || !process.env.GROQ_API_KEY) {
+        console.error(chalk.red("❌ Missing API Keys!"));
+        console.log(chalk.yellow("\nPlease ensure you have a .env.local file with:"));
+        console.log(chalk.white("- GOOGLE_API_KEY"));
+        console.log(chalk.white("- GROQ_API_KEY"));
+        console.log(chalk.white("\nCheck .env.example for a template.\n"));
+        return;
+    }
+
+    // 1. Detective
     console.log(chalk.blue("🔎 Running Detective Engine..."));
+
     const detective = new Detective(SOURCE_DIR);
     await detective.scan();
     detective.report();

package/setup.js

@@ -115,7 +115,7 @@ async function main() {
 
     // HARDCODED: Tagged release URL - NOT configurable for security
     // To update, modify this constant and publish a new version of setup.js
-    const BASE_URL = 'https://raw.githubusercontent.com/JStaRFilms/jstar-code-review/v2.0.0';
+    const BASE_URL = 'https://raw.githubusercontent.com/JStaRFilms/jstar-code-review/v2.1.0';
 
     // Validate URL matches our exact expected pattern (defense in depth)
     function isValidUrl(url) {