devsplain 1.7.1 → 1.8.0

package/README.md

@@ -83,6 +83,9 @@ devsplain --config
 
 Your settings are stored securely in `~/.devsplainrc` (configured with `chmod 600` on POSIX systems to restrict read access).
 
+> [!NOTE]
+> **API Testing Notice:** `devsplain` supports OpenAI, Anthropic, Ollama, Groq, and Gemini endpoints, but the E2E test suite has currently only been aggressively verified against the **Groq** and **Gemini** APIs. If you encounter any unexpected parsing issues or edge-case errors with other providers, please open an issue or submit a PR!
+
 ---
 
 ## CLI Usage & Options

package/bin/cli.js

@@ -566,10 +566,10 @@ Options:
     if (cliProvider) {
         config.provider = cliProvider;
         if (!cliModel) {
-            config.model = cliProvider === 'gemini' ? 'gemini-2.0-flash' : 'llama-3.3-70b-versatile';
+            config.model = cliProvider === 'gemini' ? 'gemini-2.0-flash' : (cliProvider === 'claude' ? 'claude-3-5-sonnet-20240620' : 'llama-3.3-70b-versatile');
         }
         if (!cliBaseUrl) {
-            config.baseUrl = cliProvider === 'gemini' ? null : (cliProvider === 'groq' ? 'https://api.groq.com/openai' : (cliProvider === 'openai' ? 'https://api.openai.com' : ''));
+            config.baseUrl = cliProvider === 'gemini' ? null : (cliProvider === 'groq' ? 'https://api.groq.com/openai' : (cliProvider === 'openai' ? 'https://api.openai.com' : (cliProvider === 'claude' ? 'https://api.anthropic.com' : '')));
         }
     }
     if (cliModel) config.model = cliModel;

package/bin/post-commit.js

@@ -5,7 +5,13 @@ const { spliceComments } = require('./cli');
 
 /** Main execution block [ds] */
 try {
-    // Get the current git directory [ds]
+    // Allow users to completely bypass the AI hook using an environment variable [ds]
+    if (process.env.SKIP_DEVSPLAIN) {
+        console.log('[devsplain] SKIP_DEVSPLAIN is set. Bypassing AI generation.');
+        process.exit(0);
+    }
+
+    // Prevent the hook from firing during rebases, merges, or cherry-picks [ds]
     const gitDir = execSync('git rev-parse --git-dir', { encoding: 'utf8' }).trim();
     const isRebasing = fs.existsSync(path.join(gitDir, 'rebase-merge')) || fs.existsSync(path.join(gitDir, 'rebase-apply'));
     const isMerging = fs.existsSync(path.join(gitDir, 'MERGE_HEAD'));
@@ -57,6 +63,7 @@ try {
     if (args.includes('--full')) modeFlag = ' --full';
 
     let commentedAny = false;
+    const successfullyCommentedFiles = [];
 
     /** Iterate over files to comment [ds] */
     for (const file of filesToComment) {
@@ -90,6 +97,7 @@ try {
             const cliPath = path.join(__dirname, 'cli.js');
             execSync(`node "${cliPath}" "${file}" --force${modeFlag}`, { stdio: 'inherit' });
             commentedAny = true;
+            successfullyCommentedFiles.push(file);
         } catch (err) {
             console.warn(`[devsplain] Warning: Failed to comment ${file}: ${err.message}`);
         }
@@ -97,10 +105,18 @@ try {
 
     /** Stage and commit auto-generated comments if any [ds] */
     if (commentedAny) {
-        const status = execSync('git diff --name-only', { encoding: 'utf8' }).trim();
-        if (status.length > 0) {
+        // Only stage the exact files that the AI touched to avoid accidentally committing unstaged work [ds]
+        for (const file of successfullyCommentedFiles) {
+            try {
+                execSync(`git add "${file}"`);
+            } catch (addErr) {}
+        }
+        
+        // Check if there are actually staged changes now [ds]
+        const stagedChanges = execSync('git diff --cached --name-only', { encoding: 'utf8' }).trim();
+        if (stagedChanges.length > 0) {
             console.log('[devsplain] Staging and committing auto-generated comments...');
-            execSync('git commit -am "docs: auto-generated comments by devsplain" --no-verify', { stdio: 'inherit' });
+            execSync('git commit -m "docs: auto-generated comments by devsplain" --no-verify', { stdio: 'inherit' });
             console.log('[devsplain] Comments committed successfully! Rollback via: git reset --hard HEAD~1');
         }
     }

package/lib/config.js

@@ -8,8 +8,8 @@ const configPath = path.join(os.homedir(), '.devsplainrc');
 async function getConfig(forceWizard = false) {
   if (process.env.DEVSPLAIN_API_KEY || process.env.DEVSPLAIN_PROVIDER) {
     const provider = process.env.DEVSPLAIN_PROVIDER || 'gemini';
-    const model = process.env.DEVSPLAIN_MODEL || (provider === 'gemini' ? 'gemini-2.0-flash' : 'llama-3.3-70b-versatile');
-    const baseUrl = process.env.DEVSPLAIN_BASE_URL || (provider === 'gemini' ? null : 'https://api.groq.com/openai');
+    const model = process.env.DEVSPLAIN_MODEL || (provider === 'gemini' ? 'gemini-2.0-flash' : (provider === 'claude' ? 'claude-3-5-sonnet-20240620' : 'llama-3.3-70b-versatile'));
+    const baseUrl = process.env.DEVSPLAIN_BASE_URL || (provider === 'gemini' ? null : (provider === 'claude' ? 'https://api.anthropic.com' : 'https://api.groq.com/openai'));
     return {
       provider,
       apiKey: process.env.DEVSPLAIN_API_KEY || '',
@@ -41,9 +41,10 @@ async function getConfig(forceWizard = false) {
       console.log("2. Gemini (Free Tier)");
       console.log("3. OpenAI (Paid)");
       console.log("4. Custom (Ollama, local, etc)");
+      console.log("5. Claude (Anthropic)");
 
       // Get user's selected AI provider option [ds]
-      const choice = await askQuestion("Select (1-4): ");
+      const choice = await askQuestion("Select (1-5): ");
 
       // Handle selected AI provider option [ds]
       if (choice === '1') {
@@ -68,8 +69,14 @@ async function getConfig(forceWizard = false) {
         provider = 'custom';
         model = await askQuestion("Model name (e.g., llama3): ");
         baseUrl = await askQuestion("Base URL (e.g., http://localhost:11434): ");
+      } else if (choice === '5') {
+        provider = 'claude';
+        baseUrl = 'https://api.anthropic.com';
+        console.log("\nGet your Anthropic key here: https://console.anthropic.com/settings/keys");
+        const customModel = await askQuestion("Model name (press Enter for default 'claude-3-5-sonnet-20240620'): ");
+        model = customModel.trim() || 'claude-3-5-sonnet-20240620';
       } else {
-        console.log("Invalid choice. Please select 1, 2, 3, or 4.");
+        console.log("Invalid choice. Please select 1, 2, 3, 4, or 5.");
         continue;
       }
 

package/lib/llm.js

@@ -117,8 +117,36 @@ ${numberedCode}
             throw new Error(`API Error: ${data.error.message}`);
         }
         textResponse = data.candidates[0].content.parts[0].text;
+    } else if (config.provider === 'claude') {
+        const url = `${config.baseUrl}/v1/messages`;
+        let data;
+        try {
+            const response = await fetchWithRetry(url, {
+                method: 'POST',
+                headers: {
+                    'Content-Type': 'application/json',
+                    'x-api-key': config.apiKey,
+                    'anthropic-version': '2023-06-01'
+                },
+                body: JSON.stringify({
+                    "model": config.model,
+                    "max_tokens": 8192,
+                    "messages": [{
+                        "role": "user",
+                        "content": prompt
+                    }]
+                })
+            });
+            data = await response.json();
+        } catch (error) {
+            throw new Error("Network Error: Could not connect to the AI provider. Check your internet or API url.");
+        }
+        if (data.error) {
+            throw new Error(`API Error: ${data.error.message}`);
+        }
+        textResponse = data.content[0].text;
     } 
-    // Otherwise, use a different provider [ds]
+    // Otherwise, use an OpenAI-compatible provider [ds]
     else {
         const url = `${config.baseUrl}/v1/chat/completions`;
         let data;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "devsplain",
-  "version": "1.7.1",
+  "version": "1.8.0",
   "description": "An agent-agnostic CLI tool that automatically adds JSDoc and inline comments to your code using free LLMs.",
   "author": "mwahaj36",
   "license": "MIT",