devsplain 2.2.0 → 2.2.1

package/bin/cli.js

@@ -10,7 +10,7 @@ const { execSync } = require('child_process');
 let rl;
 let askQuestion;
 
-// Checks if the Git working tree is dirty [ds]
+// Determines whether the current Git repository has uncommitted changes [ds]
 function isGitDirty() {
     try {
         const gitDir = execSync('git rev-parse --is-inside-work-tree', { stdio: ['ignore', 'pipe', 'ignore'], encoding: 'utf8' }).trim();
@@ -23,7 +23,7 @@ function isGitDirty() {
     return false;
 }
 
-// Checks if a line of code is inside a string literal [ds]
+// Checks whether a given line of code is inside a string literal [ds]
 function isLineInsideString(lines, targetLineIndex, ext = '') {
     const isPython = ext.toLowerCase() === '.py';
     const isHTML = ['.html', '.vue', '.svelte'].includes(ext.toLowerCase());
@@ -236,7 +236,7 @@ function isLineInsideString(lines, targetLineIndex, ext = '') {
     return inBacktick || inTripleDouble || inTripleSingle || inSingle || inDouble || inCppRawString || inRegex;
 }
 
-// Analyzes comments in a given set of code lines [ds]
+// Analyzes comments within a given list of code lines [ds]
 function analyzeComments(lines, ext = '') {
     const isPython = ext.toLowerCase() === '.py';
     const isHTML = ['.html', '.vue', '.svelte'].includes(ext.toLowerCase());
@@ -477,7 +477,7 @@ function analyzeComments(lines, ext = '') {
     return analysis;
 }
 
-// Splices comments into the given code data [ds]
+// Inserts or removes comments from code based on the specified mode [ds]
 function spliceComments(data, comments, mode = 'default', ext = '') {
     const hasCRLF = data.includes('\r\n');
     const lineEnding = hasCRLF ? '\r\n' : '\n';
@@ -530,7 +530,23 @@ function spliceComments(data, comments, mode = 'default', ext = '') {
                 if (lineAnalysis.isPureComment) {
                     finalDeletions.add(lineNum);
                 } else if (lineAnalysis.commentStartIndex !== -1) {
-                    annotated[i].text = lineStr.slice(0, lineAnalysis.commentStartIndex).trimEnd();
+                    const idx = lineAnalysis.commentStartIndex;
+                    const remainder = lineStr.slice(idx);
+                    let newText = lineStr.slice(0, idx).trimEnd();
+                    
+                    if (remainder.startsWith('/*')) {
+                        const endIdx = remainder.indexOf('*/');
+                        if (endIdx !== -1) {
+                            newText = lineStr.slice(0, idx) + remainder.slice(endIdx + 2);
+                        }
+                    } else if (remainder.startsWith('<!--')) {
+                        const endIdx = remainder.indexOf('-->');
+                        if (endIdx !== -1) {
+                            newText = lineStr.slice(0, idx) + remainder.slice(endIdx + 3);
+                        }
+                    }
+                    
+                    annotated[i].text = newText.trimEnd();
                 }
             } else if (mode === 'clean') {
                 const isDsBlockLine = dsBlocks.has(lineNum);
@@ -542,7 +558,23 @@ function spliceComments(data, comments, mode = 'default', ext = '') {
                     }
                 } else if (lineAnalysis.commentStartIndex !== -1) {
                     if (isDsBlockLine || hasDsInline) {
-                        annotated[i].text = lineStr.slice(0, lineAnalysis.commentStartIndex).trimEnd();
+                        const idx = lineAnalysis.commentStartIndex;
+                        const remainder = lineStr.slice(idx);
+                        let newText = lineStr.slice(0, idx).trimEnd();
+                        
+                        if (remainder.startsWith('/*')) {
+                            const endIdx = remainder.indexOf('*/');
+                            if (endIdx !== -1) {
+                                newText = lineStr.slice(0, idx) + remainder.slice(endIdx + 2);
+                            }
+                        } else if (remainder.startsWith('<!--')) {
+                            const endIdx = remainder.indexOf('-->');
+                            if (endIdx !== -1) {
+                                newText = lineStr.slice(0, idx) + remainder.slice(endIdx + 3);
+                            }
+                        }
+                        
+                        annotated[i].text = newText.trimEnd();
                     }
                 }
             }
@@ -643,7 +675,23 @@ function spliceComments(data, comments, mode = 'default', ext = '') {
                 const isDsBlockLine = dsBlocks.has(origIdx + 1);
                 const hasDsInline = originalLine.includes('[ds]');
                 if (mode === 'prune' || (mode === 'clean' && (hasDsInline || isDsBlockLine))) {
-                    const expectedStripped = originalLine.slice(0, lineAnalysis.commentStartIndex).trimEnd();
+                    const idx = lineAnalysis.commentStartIndex;
+                    const remainder = originalLine.slice(idx);
+                    let expectedStripped = originalLine.slice(0, idx).trimEnd();
+                    
+                    if (remainder.startsWith('/*')) {
+                        const endIdx = remainder.indexOf('*/');
+                        if (endIdx !== -1) {
+                            expectedStripped = originalLine.slice(0, idx) + remainder.slice(endIdx + 2);
+                        }
+                    } else if (remainder.startsWith('<!--')) {
+                        const endIdx = remainder.indexOf('-->');
+                        if (endIdx !== -1) {
+                            expectedStripped = originalLine.slice(0, idx) + remainder.slice(endIdx + 3);
+                        }
+                    }
+                    expectedStripped = expectedStripped.trimEnd();
+
                     if (text === expectedStripped) {
                         return true;
                     }
@@ -669,7 +717,7 @@ function spliceComments(data, comments, mode = 'default', ext = '') {
     return annotated.map(line => line.text).join(lineEnding);
 }
 
-// Runs the CLI interface for the application [ds]
+// Runs the command-line interface for the application [ds]
 async function runCLI() {
     rl = readline.createInterface({ input: process.stdin, output: process.stdout });
     askQuestion = (query) => new Promise((resolve) => rl.question(query, resolve));
@@ -823,7 +871,6 @@ Options:
         return false;
     }
 
-    // Processes a given file path, either a file or directory [ds]
     async function processPath(targetPath) {
         const stats = fs.statSync(targetPath);
 
@@ -881,7 +928,6 @@ Options:
                         fs.renameSync(tempPath, targetPath);
                         console.log(` Successfully saved ${targetPath}`);
                     } else {
-                        // Asks the user if they want to save the commented code to a file [ds]
                         console.log(` Skipped ${targetPath}`);
                     }
                 } else {
@@ -914,7 +960,6 @@ Options:
     rl.close();
 }
 
-// Starts the CLI application if this script is run directly [ds]
 if (require.main === module) {
     runCLI().catch(err => {
         console.error(err);

package/package.json

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