npm - explainthisrepo - Versions diffs - 0.9.5 → 0.9.6 - Mend

explainthisrepo 0.9.5 → 0.9.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/dist/init.js CHANGED Viewed

@@ -7,7 +7,8 @@ const PROVIDERS = {
     "2": "openai",
     "3": "ollama",
     "4": "anthropic",
-    "5": "openrouter",
+    "5": "groq",
+    "6": "openrouter",
 };
 export async function runInit() {
     const err = process.stderr;
@@ -44,8 +45,9 @@ async function promptProvider() {
     err.write("  1) Gemini\n");
     err.write("  2) OpenAI\n");
     err.write("  3) Ollama (local)\n");
-    err.write("  4) Anthropic\n");
-    err.write("  5) OpenRouter\n");
+    err.write("  4) Anthropic (Claude)\n");
+    err.write("  5) Groq\n");
+    err.write("  6) OpenRouter\n");
     const choice = (await prompt("> ")).trim();
     const provider = PROVIDERS[choice];
     if (!provider) {
@@ -56,42 +58,57 @@ async function promptProvider() {
 async function promptProviderConfig(provider) {
     if (provider === "gemini") {
         const key = (await promptHidden("Gemini API key: ")).trim();
-        if (!key) {
+        if (!key)
             throw new Error("API key cannot be empty");
-        }
         return { api_key: key };
     }
     if (provider === "openai") {
         const key = (await promptHidden("OpenAI API key: ")).trim();
-        if (!key) {
+        if (!key)
             throw new Error("API key cannot be empty");
-        }
         return { api_key: key };
     }
     if (provider === "anthropic") {
-        const key = (await promptHidden("Anthropic API key: ")).trim();
-        if (!key) {
+        const key = (await promptHidden("Anthropic (Claude) API key: ")).trim();
+        if (!key)
             throw new Error("API key cannot be empty");
-        }
         return { api_key: key };
     }
     if (provider === "ollama") {
-        const model = (await prompt("Ollama model (e.g. llama3, glm-5:cloud): ")).trim();
-        if (!model) {
+        const model = (await prompt("Ollama model (e.g. llama3, glm-5:cloud, gemma3:4b): ")).trim();
+        if (!model)
             throw new Error("Model cannot be empty");
-        }
         const host = (await prompt("Ollama host [http://localhost:11434]: ")).trim() ||
             "http://localhost:11434";
+        return { model, host };
+    }
+    if (provider === "groq") {
+        const key = (await promptHidden("Groq API key: ")).trim();
+        if (!key)
+            throw new Error("API key cannot be empty");
+        const err = process.stderr;
+        err.write(chalk.bold("Select Groq model:\n"));
+        err.write("  1) llama3-70b-8192\n");
+        err.write("  2) mixtral-8x7b\n");
+        err.write("  3) deepseek-r1-distill-llama-70b\n");
+        const choice = (await prompt("> ")).trim();
+        const modelMap = {
+            "1": "llama3-70b-8192",
+            "2": "mixtral-8x7b",
+            "3": "deepseek-r1-distill-llama-70b",
+        };
+        const model = modelMap[choice];
+        if (!model)
+            throw new Error("Invalid model selection");
         return {
+            api_key: key,
             model,
-            host,
         };
     }
     if (provider === "openrouter") {
         const key = (await promptHidden("OpenRouter API key: ")).trim();
-        if (!key) {
+        if (!key)
             throw new Error("API key cannot be empty");
-        }
         const err = process.stderr;
         err.write(chalk.bold("Select OpenRouter model:\n"));
         err.write("  1) openai/gpt-4o (balanced)\n");
@@ -112,9 +129,8 @@ async function promptProviderConfig(provider) {
         }
         else {
             model = modelMap[choice];
-            if (!model) {
+            if (!model)
                 throw new Error("Invalid model selection");
-            }
         }
         if (!model || !model.trim()) {
             throw new Error("Model cannot be empty");

package/dist/providers/groq.d.ts ADDED Viewed

@@ -0,0 +1,17 @@
+import { LLMProvider } from "./base.js";
+type GroqConfig = {
+    api_key?: string;
+    model?: string;
+};
+export declare class GroqProvider implements LLMProvider {
+    name: string;
+    private apiKey;
+    private model;
+    private client;
+    constructor(config?: GroqConfig);
+    validateConfig(): void;
+    private getClient;
+    generate(prompt: string): Promise<string>;
+    doctor(): Promise<string[]>;
+}
+export {};

package/dist/providers/groq.js ADDED Viewed

@@ -0,0 +1,70 @@
+import { LLMProviderError } from "./base.js";
+export class GroqProvider {
+    name = "groq";
+    apiKey;
+    model;
+    client = null;
+    constructor(config = {}) {
+        this.apiKey = config.api_key ?? "";
+        this.model = config.model;
+        this.validateConfig();
+    }
+    validateConfig() {
+        if (!this.apiKey || !this.apiKey.trim()) {
+            throw new LLMProviderError("Groq provider requires an API key.\n" +
+                "Run `explainthisrepo init` or set providers.groq.api_key.");
+        }
+        if (!this.model || !String(this.model).trim()) {
+            throw new LLMProviderError("Groq provider requires a model.\n" +
+                "Set providers.groq.model (e.g. llama3-70b-8192, mixtral-8x7b, deepseek-r1-distill-llama-70b).");
+        }
+    }
+    getClient() {
+        if (this.client) {
+            return this.client;
+        }
+        try {
+            const Groq = require("groq");
+            this.client = new Groq({ apiKey: this.apiKey });
+            return this.client;
+        }
+        catch {
+            throw new LLMProviderError("Groq support is not installed.\n" +
+                "Install it with:\n" +
+                "  npm install groq");
+        }
+    }
+    async generate(prompt) {
+        const client = this.getClient();
+        let response;
+        try {
+            response = await client.chat.completions.create({
+                model: this.model,
+                messages: [
+                    { role: "user", content: prompt }
+                ]
+            });
+        }
+        catch (err) {
+            const message = err?.message ? String(err.message) : String(err);
+            throw new LLMProviderError(`Groq request failed: ${message}`);
+        }
+        let text = null;
+        try {
+            text = response?.choices?.[0]?.message?.content ?? null;
+        }
+        catch {
+            text = null;
+        }
+        if (!text || !text.trim()) {
+            throw new LLMProviderError("Groq returned no text");
+        }
+        return text.trim();
+    }
+    async doctor() {
+        return [
+            `GROQ_API_KEY set: ${Boolean(this.apiKey)}`,
+            `model: ${this.model}`,
+        ];
+    }
+}

package/dist/providers/index.d.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export { LLMProvider, LLMProviderError } from "./base.js";

package/dist/providers/index.js ADDED Viewed

	@@ -0,0 +1 @@
1	+ export { LLMProviderError } from "./base.js";

package/package.json CHANGED Viewed

@@ -1,62 +1,62 @@
-{
-  "name": "explainthisrepo",
-  "version": "0.9.5",
-  "description": "The fastest way to understand any codebase in plain English. Not blind AI summarization",
-  "license": "MIT",
-  "type": "module",
-  "author": "Caleb Wodi <calebwodi33@gmail.com>",
-  "homepage": "https://explainthisrepo.com",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/calchiwo/ExplainThisRepo.git",
-    "directory": "node_version"
-  },
-  "bugs": {
-    "url": "https://github.com/calchiwo/ExplainThisRepo/issues"
-  },
-  "keywords": [
-    "github",
-    "cli",
-    "explain",
-    "repository",
-    "ai",
-    "repo-analysis",
-    "code-explanater",
-    "documentation",
-    "developer-productivity",
-    "developer-tools"
-  ],
-  "bin": {
-    "explainthisrepo": "dist/cli.js",
-    "explain-this-repo": "dist/cli.js",
-    "etr": "dist/cli.js"
-  },
-  "files": [
-    "dist",
-    "README.md",
-    "LICENSE"
-  ],
-  "scripts": {
-    "build": "tsc",
-    "start": "node dist/cli.js",
-    "sync-meta": "cp ../README.md README.md && cp ../LICENSE LICENSE",
-    "prepublishOnly": "npm run sync-meta && npm run build"
-  },
-  "engines": {
-    "node": ">=20"
-  },
-  "dependencies": {
-    "@google/generative-ai": "^0.24.1",
-    "@iarna/toml": "^2.2.5",
-    "axios": "^1.13.2",
-    "commander": "^14.0.3",
-    "dotenv": "^17.2.3",
-    "openai": "^4.0.0",
-    "ora": "^9.3.0",
-    "toml": "^3.0.0"
-  },
-  "devDependencies": {
-    "@types/node": "^22.0.0",
-    "typescript": "^5.6.0"
-  }
-}
+{
+  "name": "explainthisrepo",
+  "version": "0.9.6",
+  "description": "The fastest way to understand any codebase in plain English. Not blind AI summarization",
+  "license": "MIT",
+  "type": "module",
+  "author": "Caleb Wodi <calebwodi33@gmail.com>",
+  "homepage": "https://explainthisrepo.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/calchiwo/ExplainThisRepo.git",
+    "directory": "node_version"
+  },
+  "bugs": {
+    "url": "https://github.com/calchiwo/ExplainThisRepo/issues"
+  },
+  "keywords": [
+    "github",
+    "cli",
+    "explain",
+    "repository",
+    "ai",
+    "repo-analysis",
+    "code-explanater",
+    "documentation",
+    "developer-productivity",
+    "developer-tools"
+  ],
+  "bin": {
+    "explainthisrepo": "dist/cli.js",
+    "explain-this-repo": "dist/cli.js",
+    "etr": "dist/cli.js"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "start": "node dist/cli.js",
+    "sync-meta": "cp ../README.md README.md && cp ../LICENSE LICENSE",
+    "prepublishOnly": "npm run sync-meta && npm run build"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "dependencies": {
+    "@google/generative-ai": "^0.24.1",
+    "@iarna/toml": "^2.2.5",
+    "axios": "^1.13.2",
+    "commander": "^14.0.3",
+    "dotenv": "^17.2.3",
+    "openai": "^4.0.0",
+    "ora": "^9.3.0",
+    "toml": "^3.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "typescript": "^5.6.0"
+  }
+}