devsplain 1.5.1 → 1.5.3

package/bin/cli.js

@@ -22,7 +22,7 @@ function isGitDirty() {
     return false;
 }
 
-/** Determines if a specific line index is inside a string or multiline literal */
+/** Determines if a specific line index falls within a string literal */
 function isLineInsideString(lines, targetLineIndex, ext = '') {
     const isPython = ext.toLowerCase() === '.py';
     let inBacktick = false;
@@ -31,6 +31,7 @@ function isLineInsideString(lines, targetLineIndex, ext = '') {
     let inSingle = false;
     let inDouble = false;
 
+    // Iterate through lines prior to the target to track string/block state
     for (let i = 0; i < targetLineIndex; i++) {
         const line = lines[i];
         let j = 0;
@@ -51,6 +52,7 @@ function isLineInsideString(lines, targetLineIndex, ext = '') {
                     }
                 }
             } else {
+                // Check for unescaped backtick (JS template strings) or quotes
                 if (!inSingle && !inDouble && line[j] === '`') {
                     let escaped = false;
                     let k = j - 1;
@@ -96,7 +98,7 @@ function isLineInsideString(lines, targetLineIndex, ext = '') {
     return inBacktick || inTripleDouble || inTripleSingle || inSingle || inDouble;
 }
 
-/** Analyzes code to identify pure comment lines and block boundaries */
+/** Performs a lexical analysis to categorize code lines and comment blocks */
 function analyzeComments(lines, ext = '') {
     const isPython = ext.toLowerCase() === '.py';
     const isHTML = ['.html', '.vue', '.svelte'].includes(ext.toLowerCase());
@@ -108,6 +110,7 @@ function analyzeComments(lines, ext = '') {
     let inDouble = false;
     let inBlockJS = false;
     let inBlockHTML = false;
+    // Iterate through each line character by character to detect comment boundaries
     for (let i = 0; i < lines.length; i++) {
         const line = lines[i];
         let commentStartIndex = -1;
@@ -247,8 +250,9 @@ function analyzeComments(lines, ext = '') {
     return analysis;
 }
 
-/** Splicers or removes comments from source data based on the requested mode */
+/** Splices generated comments into the source data or removes existing ones */
 function spliceComments(data, comments, mode = 'default', ext = '') {
+    // Determine platform-specific line endings
     const hasCRLF = data.includes('\r\n');
     const lineEnding = hasCRLF ? '\r\n' : '\n';
     const originalLines = data.split(/\r?\n/);
@@ -258,6 +262,7 @@ function spliceComments(data, comments, mode = 'default', ext = '') {
     const annotated = originalLines.map((text, index) => ({ text, originalIndex: index }));
     let analysis = null;
 
+    // 'clean' mode removes all existing comments/documentation
     if (mode === 'clean') {
         analysis = analyzeComments(originalLines, ext);
         const finalDeletions = new Set();
@@ -306,6 +311,7 @@ function spliceComments(data, comments, mode = 'default', ext = '') {
             annotated.splice(lineNum - 1, 1);
         }
     } else {
+        // 'default'/'light'/'full' mode: Inject AI-generated comments
         for (const c of validComments) {
             if (isLineInsideString(originalLines, c.line - 1, ext)) {
                 console.warn(`[devsplain] Skipping comment insertion at line ${c.line} to avoid string literal corruption.`);
@@ -368,7 +374,7 @@ function spliceComments(data, comments, mode = 'default', ext = '') {
     return annotated.map(line => line.text).join(lineEnding);
 }
 
-/** Main CLI entry point handler */
+/** Main entry point for the CLI tool logic */
 async function runCLI() {
     rl = readline.createInterface({ input: process.stdin, output: process.stdout });
     askQuestion = (query) => new Promise((resolve) => rl.question(query, resolve));
@@ -416,7 +422,8 @@ Options:
 
     if (args.includes('--setup-hook')) {
         rl.close();
-        require('./setup-hook.js');
+        const installHooks = require('./setup-hook.js');
+        await installHooks();
         return;
     }
 
@@ -484,7 +491,7 @@ Options:
     let successCount = 0;
     let failCount = 0;
 
-    /** Recursively traverses directories to process files */
+    /** Recursively traverses the file system to identify and process source files */
     async function processPath(targetPath) {
         const stats = fs.statSync(targetPath);
 
@@ -529,6 +536,7 @@ Options:
 
             console.log(` Analyzing ${filename} in ${mode} mode...`);
             try {
+                // Logic to either clean existing comments or replace/insert new ones
                 let comments = [];
                 let commentedCode;
                 if (mode !== 'clean') {
@@ -544,6 +552,7 @@ Options:
                     console.log(`---------------------------------------\n`);
                     const answer = await askQuestion("Type 'write' to save to file, or press any key to discard: ");
                     if (answer.toLowerCase() === 'write') {
+                        // Use temporary file for atomic write operations
                         const tempPath = targetPath + '.tmp';
                         fs.writeFileSync(tempPath, commentedCode, 'utf8');
                         fs.renameSync(tempPath, targetPath);
@@ -581,7 +590,6 @@ Options:
     rl.close();
 }
 
-// If running as a standalone script, start the CLI; otherwise export helpers
 if (require.main === module) {
     runCLI().catch(err => {
         console.error(err);

package/bin/setup-hook.js

@@ -4,12 +4,12 @@ const { execSync } = require('child_process');
 const readline = require('readline');
 
 /**
- * Configures and installs git pre-commit and post-commit hooks.
- * Detects the local git repository and prompts the user for comment mode preferences.
+ * Initializes and installs Git pre-commit and post-commit hooks.
+ * Prompts the user for documentation mode configuration.
 */
 async function installHooks() {
     try {
-        // Resolve the actual .git directory path
+        // Resolve the root .git directory path
         const gitDir = execSync('git rev-parse --git-dir', { encoding: 'utf8' }).trim();
         const hooksDir = path.join(gitDir, 'hooks');
         if (!fs.existsSync(hooksDir)) {
@@ -17,13 +17,13 @@ async function installHooks() {
         }
 
         let modeChoice = '1';
-        // Check if running in an interactive terminal to prompt for preferences
+        // Interactive mode requires a TTY terminal
         if (process.stdout.isTTY) {
             const rl = readline.createInterface({
                 input: process.stdin,
                 output: process.stdout
             });
-            // Helper to wrap readline as a Promise for async/await control flow
+            // Promisify the readline interface for async/await flow
             const askQuestion = (query) => new Promise((resolve) => rl.question(query, resolve));
 
             console.log('\nSelect default commenting mode for Git commits:');
@@ -35,7 +35,7 @@ async function installHooks() {
             rl.close();
         }
 
-        // Map user selection to CLI argument flags for the post-commit handler
+        // Determine documentation style flags based on user input
         let modeArgs = '';
         if (modeChoice === '2') {
             modeArgs = ' --light';
@@ -43,7 +43,7 @@ async function installHooks() {
             modeArgs = ' --full';
         }
 
-        // Define and write the pre-commit shell script
+        // Write the pre-commit script to the git hooks directory
         const preCommitHookPath = path.join(hooksDir, 'pre-commit');
         const preCommitContent = `#!/bin/sh
 # devsplain native pre-commit hook
@@ -51,12 +51,12 @@ echo "Running pre-commit tests..."
 npm test || exit 1
 `;
         fs.writeFileSync(preCommitHookPath, preCommitContent);
-        // Ensure the shell script is executable by the system
         try {
+            // Ensure the hook file is executable
             fs.chmodSync(preCommitHookPath, 0o755);
         } catch (err) {}
 
-        // Define and write the post-commit shell script
+        // Write the post-commit script that triggers documentation generation
         const postCommitHookPath = path.join(hooksDir, 'post-commit');
         const postCommitContent = `#!/bin/sh
 # devsplain native post-commit hook
@@ -64,7 +64,6 @@ echo "Auto-generating comments for files in the last commit..."
 node bin/post-commit.js${modeArgs} || exit 1
 `;
         fs.writeFileSync(postCommitHookPath, postCommitContent);
-        // Ensure the post-commit shell script is executable
         try {
             fs.chmodSync(postCommitHookPath, 0o755);
         } catch (err) {}
@@ -75,5 +74,8 @@ node bin/post-commit.js${modeArgs} || exit 1
     }
 }
 
-// Execute the hook installation sequence
-installHooks();
+// Execute the function automatically if the file is run directly
+if (require.main === module) {
+    installHooks();
+}
+module.exports = installHooks;

package/package.json

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