devsplain 2.2.2 → 2.2.3

package/bin/cli.js

@@ -231,6 +231,7 @@ function isLineInsideString(lines, targetLineIndex, ext = '') {
         if (resetsAtLineEnd) {
             inSingle = false;
             inDouble = false;
+            inRegex = false;
         }
     }
     return inBacktick || inTripleDouble || inTripleSingle || inSingle || inDouble || inCppRawString || inRegex;
@@ -455,6 +456,7 @@ function analyzeComments(lines, ext = '') {
         if (resetsAtLineEnd) {
             inSingle = false;
             inDouble = false;
+            inRegex = false;
         }
         const isEntirelyInsideBlock = isInsideBlockStart && (inBlockJS || inBlockHTML || (commentStartIndex === -1));
         let isPureComment = false;
@@ -663,6 +665,33 @@ function spliceComments(data, comments, mode = 'default', ext = '') {
     const filteredText = filtered.map(line => line.text);
     const filteredIndices = filtered.map(line => line.originalIndex);
 
+    // Validate that all inserted lines (originalIndex === -1) are valid comments or empty lines [ds]
+    const insertedLines = annotated.filter(line => line.originalIndex === -1);
+    let inInsertedBlock = false;
+    for (const item of insertedLines) {
+        const trimmed = item.text.trim();
+        if (!trimmed) continue;
+        if (inInsertedBlock) {
+            if (trimmed.includes('*/') || trimmed.includes('-->')) {
+                inInsertedBlock = false;
+            }
+            continue;
+        }
+        const isValidComment = 
+            trimmed.startsWith('//') || 
+            trimmed.startsWith('/*') || 
+            trimmed.startsWith('*') || 
+            trimmed.startsWith('#') || 
+            trimmed.startsWith('<!--') || 
+            trimmed.startsWith('--');
+        if (!isValidComment) {
+            throw new Error(`Safety Assertion Failed: Refused to insert non-comment code: "${trimmed}"`);
+        }
+        if ((trimmed.startsWith('/*') && !trimmed.includes('*/')) || (trimmed.startsWith('<!--') && !trimmed.includes('-->'))) {
+            inInsertedBlock = true;
+        }
+    }
+
     const textEqual = filteredText.every((text, idx) => {
         const origIdx = filteredIndices[idx];
         const originalLine = originalLines[origIdx];
@@ -710,8 +739,7 @@ function spliceComments(data, comments, mode = 'default', ext = '') {
     }
 
     if (!textEqual || !indicesSequential) {
-        console.error("\nSafety Assertion Failed: Spliced code does not match original code minus comments!");
-        process.exit(1);
+        throw new Error("Safety Assertion Failed: Spliced code does not match original code minus comments!");
     }
 
     return annotated.map(line => line.text).join(lineEnding);
@@ -818,7 +846,7 @@ Options:
     const hasOverwriteFlag = args.includes('--overwrite');
     const hasKeepFlag = args.includes('--keep');
 
-    if (process.env.NODE_ENV !== 'test' && isGitDirty() && !isForce) {
+    if (process.env.NODE_ENV !== 'test' && isGitDirty() && !isForce && !isDryRun) {
         console.error("Error: Git working tree is dirty. Please commit or stash your changes, or use --force to bypass this check.");
         rl.close();
         process.exit(1);
@@ -871,9 +899,10 @@ Options:
 
     function isPathIgnored(targetPath) {
         const filename = path.basename(targetPath);
+        const relPath = path.relative(process.cwd(), targetPath).replace(/\\/g, '/');
         for (const pattern of allIgnored) {
             const cleanPattern = pattern.replace(/\/$/, '').replace(/\\$/, '');
-            if (filename === cleanPattern) return true;
+            if (filename === cleanPattern || relPath === cleanPattern || relPath.startsWith(cleanPattern + '/')) return true;
             if (pattern.startsWith('*') && filename.endsWith(pattern.slice(1))) return true;
         }
         return false;
@@ -899,7 +928,7 @@ Options:
             const validExtensions = [
                 '.js', '.jsx', '.ts', '.tsx', '.html', '.css', '.scss', '.vue', '.svelte',
                 '.py', '.java', '.c', '.cpp', '.cs', '.go', '.rb', '.php', '.rs', 
-                '.swift', '.kt', '.dart', '.sh'
+                '.swift', '.kt', '.dart', '.sh', '.sql'
             ];
 
             if (!validExtensions.includes(ext)) {

package/bin/post-commit.js

@@ -1,4 +1,4 @@
-const { execSync } = require('child_process');
+const { execSync, execFileSync } = require('child_process');
 const fs = require('fs');
 const path = require('path');
 const { spliceComments } = require('./cli');
@@ -30,7 +30,7 @@ try {
     }
 
     // Get a list of changed files in the last commit [ds]
-    const changedFilesStr = execSync('git diff-tree --no-commit-id --name-only -r HEAD', { encoding: 'utf8' }).trim();
+    const changedFilesStr = execSync('git diff-tree --no-commit-id --name-only -r --root HEAD', { encoding: 'utf8' }).trim();
     if (!changedFilesStr) {
         process.exit(0);
     }
@@ -40,7 +40,7 @@ try {
     const validExtensions = [
         '.js', '.jsx', '.ts', '.tsx', '.html', '.css', '.scss', '.vue', '.svelte',
         '.py', '.java', '.c', '.cpp', '.cs', '.go', '.rb', '.php', '.rs',
-        '.swift', '.kt', '.dart', '.sh'
+        '.swift', '.kt', '.dart', '.sh', '.sql'
     ];
 
     /** Filter function to determine which files to auto-comment [ds] */
@@ -97,13 +97,13 @@ try {
         // Log and attempt to auto-comment the current file [ds]
         console.log(`[devsplain] Automatically commenting file: ${file}`);
         try {
-            let extraFlags = '';
-            if (process.env.DS_OVER) extraFlags += ' --overwrite';
-            if (process.env.DS_KEEP) extraFlags += ' --keep';
-
-            // Construct the command to run the auto-commenting CLI [ds]
             const cliPath = path.join(__dirname, 'cli.js');
-            execSync(`node "${cliPath}" "${file}" --force${modeFlag}${extraFlags}`, { stdio: 'inherit' });
+            const cliArgs = [cliPath, file, '--force'];
+            if (modeFlag.trim()) cliArgs.push(modeFlag.trim());
+            if (process.env.DS_OVER) cliArgs.push('--overwrite');
+            if (process.env.DS_KEEP) cliArgs.push('--keep');
+
+            execFileSync(process.execPath, cliArgs, { stdio: 'inherit' });
             commentedAny = true;
             successfullyCommentedFiles.push(file);
         } catch (err) {
@@ -115,7 +115,7 @@ try {
     if (commentedAny) {
         for (const file of successfullyCommentedFiles) {
             try {
-                execSync(`git add "${file}"`);
+                execFileSync('git', ['add', file]);
             } catch (addErr) {}
         }
         

package/bin/setup-hook.js

@@ -57,8 +57,17 @@ if [ -f package.json ] && grep -q '"test"' package.json 2>/dev/null; then
   npm test || exit 1
 fi
 `;
-        // Write pre-commit hook to file [ds]
-        fs.writeFileSync(preCommitHookPath, preCommitContent);
+        // Write pre-commit hook safely [ds]
+        if (fs.existsSync(preCommitHookPath)) {
+            const existing = fs.readFileSync(preCommitHookPath, 'utf8');
+            if (!existing.includes('# devsplain native pre-commit hook')) {
+                fs.appendFileSync(preCommitHookPath, '\n' + preCommitContent);
+            } else {
+                fs.writeFileSync(preCommitHookPath, preCommitContent);
+            }
+        } else {
+            fs.writeFileSync(preCommitHookPath, preCommitContent);
+        }
         try {
             fs.chmodSync(preCommitHookPath, 0o755);
         } catch (err) {}
@@ -73,8 +82,17 @@ fi
 echo "Auto-generating comments for files in the last commit..."
 node "${postCommitScript}"${modeArgs} || exit 1
 `;
-        // Write post-commit hook to file [ds]
-        fs.writeFileSync(postCommitHookPath, postCommitContent);
+        // Write post-commit hook safely [ds]
+        if (fs.existsSync(postCommitHookPath)) {
+            const existing = fs.readFileSync(postCommitHookPath, 'utf8');
+            if (!existing.includes('# devsplain native post-commit hook')) {
+                fs.appendFileSync(postCommitHookPath, '\n' + postCommitContent);
+            } else {
+                fs.writeFileSync(postCommitHookPath, postCommitContent);
+            }
+        } else {
+            fs.writeFileSync(postCommitHookPath, postCommitContent);
+        }
         try {
             fs.chmodSync(postCommitHookPath, 0o755);
         } catch (err) {}

package/lib/config.js

@@ -22,8 +22,14 @@ function askSecret(query) {
         process.stdout.write('\n');
         rl.close();
         resolve(key);
+      } else if (char === '\u0008' || char === '\u007f') { // Backspace
+        if (key.length > 0) {
+          key = key.slice(0, -1);
+          process.stdout.write('\b \b');
+        }
       } else if (char === '\u0003') { // Ctrl+C
-        process.exit();
+        process.stdin.setRawMode(false);
+        process.exit(130);
       } else {
         key += char;
         process.stdout.write('*');
@@ -35,7 +41,7 @@ function askSecret(query) {
 
 // Migrates old config to the new format [ds]
 function migrateConfig(oldConfig) {
-  if (oldConfig.provider && !oldConfig.providers) {
+  if (oldConfig && typeof oldConfig === 'object' && oldConfig.provider && !oldConfig.providers) {
     return {
       activeProvider: oldConfig.provider,
       providers: {
@@ -75,7 +81,7 @@ async function getConfig(forceWizard = false) {
     }
   }
 
-  if (!fileConfig || forceWizard) {
+  if (!fileConfig || !fileConfig.activeProvider || !fileConfig.providers || !fileConfig.providers[fileConfig.activeProvider] || forceWizard) {
     let rl = readline.createInterface({
       input: process.stdin,
       output: process.stdout
@@ -274,9 +280,10 @@ async function getConfig(forceWizard = false) {
       ...config.providers[config.activeProvider]
     };
   } else {
+    const active = fileConfig.providers[fileConfig.activeProvider] || {};
     return {
       provider: fileConfig.activeProvider,
-      ...fileConfig.providers[fileConfig.activeProvider]
+      ...active
     };
   }
 }

package/lib/llm.js

@@ -4,13 +4,16 @@ async function fetchWithRetry(url, options, maxRetries = 3, initialDelay = 1000)
     // Loop through each attempt, up to the maximum number of retries [ds]
     for (let attempt = 0; attempt < maxRetries; attempt++) {
         const controller = new AbortController();
-        const timeoutId = setTimeout(() => controller.abort(), 15000);
+        const timeoutId = setTimeout(() => controller.abort(), 45000);
         try {
             const response = await fetch(url, {
                 ...options,
                 signal: controller.signal
             });
             clearTimeout(timeoutId);
+            if (!response) {
+                throw new Error("No response received from fetch");
+            }
             if (response.ok) {
                 return response;
             }
@@ -22,7 +25,7 @@ async function fetchWithRetry(url, options, maxRetries = 3, initialDelay = 1000)
         } catch (err) {
             clearTimeout(timeoutId);
             if (err.name === 'AbortError') {
-                lastError = new Error("Request timed out after 15 seconds");
+                lastError = new Error("Request timed out after 45 seconds");
             } else {
                 lastError = err;
             }
@@ -46,8 +49,9 @@ async function getComments(code, language, config, mode = 'default') {
     const extMatch = language.match(/\.[0-9a-z]+$/i);
     const ext = extMatch ? extMatch[0].toLowerCase() : '';
     const isPython = ext === '.py';
-    const isRubyOrShell = ['.rb', '.sh', '.php'].includes(ext);
+    const isRubyOrShell = ['.rb', '.sh'].includes(ext);
     const isHTML = ['.html', '.vue', '.svelte'].includes(ext);
+    const isCss = ['.css', '.scss'].includes(ext);
     const isSql = ext === '.sql';
     
     // Define the single-line comment token and examples [ds]
@@ -63,6 +67,10 @@ async function getComments(code, language, config, mode = 'default') {
         singleLineToken = '<!--';
         blockExample = '<!-- Calculates the total price -->';
         inlineExample = '<!-- Check for null values -->';
+    } else if (isCss) {
+        singleLineToken = '/*';
+        blockExample = '/* Calculates the total price */';
+        inlineExample = '/* Check for null values */';
     } else if (isSql) {
         singleLineToken = '--';
         blockExample = '-- Calculates the total price';
@@ -77,6 +85,11 @@ async function getComments(code, language, config, mode = 'default') {
         instruction = `Provide highly detailed block comments above functions, and exhaustive step-by-step inline comments explaining every conditional branch, loop, variable assignment, and logical block inside function bodies. Do not be sparse; explain the code's execution flow in detail.`;
     }
 
+    let rule5 = `5. IMPORTANT: Use ONLY ${singleLineToken} for comments. DO NOT use docstrings or multi-line string literals like """ or ''' for comments.`;
+    if (isCss) {
+        rule5 = `5. IMPORTANT: In CSS/SCSS, you MUST use /* ... */ for comments. DO NOT use // comments under any circumstances.`;
+    }
+
     let prompt = `
 You are a code documentation engine. Analyze the following ${language} code which has line numbers prepended to it.
 ${instruction}
@@ -86,7 +99,7 @@ CRITICAL RULES:
 2. Each object must have exactly two properties: "line" (the integer line number where the comment should be inserted ABOVE) and "comment" (the text of the comment itself).
 3. Do NOT include the original code in your response.
 4. If no comments are needed, return an empty array: [].
-5. IMPORTANT: Use ONLY ${singleLineToken} for comments. DO NOT use docstrings or multi-line string literals like """ or ''' for comments.
+${rule5}
 
 Example Output:
 [
@@ -116,10 +129,15 @@ ${numberedCode}
             });
             data = await response.json();
         } catch (error) {
-            throw new Error("Network Error: Could not connect to the AI provider. Check your internet or API url.");
+            throw new Error(`AI Provider Request Failed: ${error.message}`);
         }
         if (data.error) {
-            throw new Error(`API Error: ${data.error.message}`);
+            const msg = data.error.message || (typeof data.error === 'string' ? data.error : JSON.stringify(data.error));
+            throw new Error(`API Error: ${msg}`);
+        }
+        if (!data.candidates || !data.candidates[0] || !data.candidates[0].content || !data.candidates[0].content.parts || !data.candidates[0].content.parts[0]) {
+            const reason = data.candidates?.[0]?.finishReason || 'Unknown error';
+            throw new Error(`AI Provider returned no content (finish reason: ${reason})`);
         }
         textResponse = data.candidates[0].content.parts[0].text;
     } else if (config.provider === 'claude') {
@@ -145,10 +163,14 @@ ${numberedCode}
             });
             data = await response.json();
         } catch (error) {
-            throw new Error("Network Error: Could not connect to the AI provider. Check your internet or API url.");
+            throw new Error(`AI Provider Request Failed: ${error.message}`);
         }
         if (data.error) {
-            throw new Error(`API Error: ${data.error.message}`);
+            const msg = data.error.message || (typeof data.error === 'string' ? data.error : JSON.stringify(data.error));
+            throw new Error(`API Error: ${msg}`);
+        }
+        if (!data.content || !data.content[0] || typeof data.content[0].text !== 'string') {
+            throw new Error(`AI Provider returned an unexpected response structure: ${JSON.stringify(data)}`);
         }
         textResponse = data.content[0].text;
     } 
@@ -166,6 +188,7 @@ ${numberedCode}
                 },
                 body: JSON.stringify({ 
                     "model": config.model, 
+                    "max_tokens": 8192,
                     "messages": [{ 
                         "role": "user", 
                         "content": prompt 
@@ -174,10 +197,14 @@ ${numberedCode}
             });
             data = await response.json();
         } catch (error) {
-            throw new Error("Network Error: Could not connect to the AI provider. Check your internet or API url.");
+            throw new Error(`AI Provider Request Failed: ${error.message}`);
         }
         if (data.error) {
-            throw new Error(`API Error: ${data.error.message}`);
+            const msg = data.error.message || (typeof data.error === 'string' ? data.error : JSON.stringify(data.error));
+            throw new Error(`API Error: ${msg}`);
+        }
+        if (!data.choices || !data.choices[0] || !data.choices[0].message || typeof data.choices[0].message.content !== 'string') {
+            throw new Error(`AI Provider returned an unexpected response structure: ${JSON.stringify(data)}`);
         }
         textResponse = data.choices[0].message.content;
     }
@@ -220,15 +247,30 @@ ${numberedCode}
             }
 
             const trimmedComment = item.comment.trim();
-            const startsWithCommentMarker = 
-                trimmedComment.startsWith('//') || 
-                trimmedComment.startsWith('/*') || 
-                trimmedComment.startsWith('#') ||
-                trimmedComment.startsWith('<!--') ||
-                trimmedComment.startsWith('--');
-
-            if (!startsWithCommentMarker) {
-                throw new Error(`Security Error: Comment on line ${item.line} does not start with a valid comment character sequence. Rejected: ${trimmedComment}`);
+            const commentLines = trimmedComment.split(/\r?\n/);
+            let inBlock = false;
+            for (const cl of commentLines) {
+                const tcl = cl.trim();
+                if (!tcl) continue;
+                if (inBlock) {
+                    if (tcl.includes('*/') || tcl.includes('-->')) {
+                        inBlock = false;
+                    }
+                    continue;
+                }
+                const startsWithMarker = 
+                    tcl.startsWith('//') || 
+                    tcl.startsWith('/*') || 
+                    tcl.startsWith('*') || 
+                    tcl.startsWith('#') || 
+                    tcl.startsWith('<!--') || 
+                    tcl.startsWith('--');
+                if (!startsWithMarker) {
+                    throw new Error(`Security Error: Comment on line ${item.line} contains invalid non-comment line: "${tcl}"`);
+                }
+                if ((tcl.startsWith('/*') && !tcl.includes('*/')) || (tcl.startsWith('<!--') && !tcl.includes('-->'))) {
+                    inBlock = true;
+                }
             }
         }
     }

package/package.json

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