commentme 1.0.6 → 1.0.8

package/README.md

@@ -1,6 +1,14 @@
-# commentme
+# CommentMe 🚀
 
-An Open Source CLI tool connected with its own website to manage and store your cluttered-code comments and give the codebase a clean look. Extract comments from your code files, store them in a database, visit commentme platform for UI-friendly seek and restore your comments line-wise later.
+**Declutter your codebase without losing context.**
+
+CommentMe is an AI-powered CLI toolkit designed for developers who value clean, readable code. It allows you to "skim" comments out of your source files into a secure vault, keeping your core logic pristine while maintaining a searchable, UI-friendly history on the web.
+
+### Key Capabilities:
+- 🧼 **Clean Code, Zero Loss**: Redact comments from files while keeping references for instant restoration.
+- 🤖 **AI Documentation**: Generate JSDocs and per-function comments automatically with LLMs.
+- 🧠 **Smart Explainer**: Get instant markdown-formatted architecture explanations for any code file.
+- 🌐 **Cloud Integration**: Manage and edit your extracted comments through a streamlined web interface.
 
 ## Installation
 ```bash

package/bin/commentme.js

@@ -9,6 +9,7 @@ import { deleteComment } from "../deletecoms.js";
 import { removeCommentsFromFile as skim } from "../skimcoms.js";
 import { unskimComments as unskim } from "../unskimcoms.js";
 import { generateCommentsPerFunc, generateCommentsPerClass, generateCommentsPerLine, generateExplanation } from "../generate.js";
+import { sanitizeFile } from "../sanitize.js";
 // import { connectDB, disconnectDB } from "../config/db.js";
 import { ensureAuth } from "../auth/authGuard.js";
 import { logout } from "../auth/logout.js";
@@ -53,6 +54,7 @@ Commands:
   commentme --unskim <file>      Restore comments to a file
   commentme --generate <file>    Generate AI comments and docs for a file
   commentme --explain <file>     Generate a full markdown explanation of a code file
+  commentme --sanitize <file>    Sanitize file for production (removes noisy comments)
   commentme --set-key            Set your own OpenRouter API key (stored securely)
   commentme --clear-key          Remove your saved API key
   commentme --logout             Log out from your session
@@ -153,6 +155,11 @@ Select generation type:
         await generateExplanation(args[1]);
         break;
 
+      case "--sanitize":
+        if (!args[1]) throw new Error("Usage: commentme --sanitize <file>");
+        await sanitizeFile(args[1]);
+        break;
+
       case "--set-key": {
         console.log("Paste your OpenRouter API key (input is hidden):");
         const key = await promptPassword("🔑 API Key: ");
@@ -187,6 +194,7 @@ Commands:
   commentme --unskim <file>
   commentme --generate <file>
   commentme --explain <file>
+  commentme --sanitize <file>
   commentme --set-key
   commentme --clear-key
   commentme --logout

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "commentme",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "A CLI tool to manage, redact and unredact your comments keeping the codebase clutterfree.",
   "type": "module",
   "bin": {

package/sanitize-test.js

@@ -0,0 +1,21 @@
+/**
+ * This is a JSDoc block.
+ * It should be PRESERVED.
+ * @param {string} msg 
+ */
+function testDoc(msg) {
+    
+    
+    console.log("This console.log should be PRESERVED.");
+
+    
+    const x = 10; 
+
+    /**
+     * Another JSDoc.
+     * Should be PRESERVED.
+     */
+    return msg + x;
+}
+
+testDoc("Hello");

package/sanitize.js

@@ -0,0 +1,62 @@
+import * as acorn from "acorn";
+import fs from "fs";
+import path from "path";
+import { getCurrentUserId } from "./utils/currentUser.js";
+
+/**
+ * Sanitizes a file for production by removing:
+ * 1. Single-line comments (// ...)
+ * 2. Block comments (/* ... * /) EXCEPT JSDocs (/** ... * /)
+ * 
+ * Note: console.log statements are preserved per user request.
+ */
+export async function sanitizeFile(filePath) {
+    if (!fs.existsSync(filePath)) {
+        throw new Error(`File not found: ${filePath}`);
+    }
+
+    // Check authentication
+    try {
+        getCurrentUserId();
+    } catch (e) {
+        console.error(e.message);
+        return;
+    }
+
+    const code = fs.readFileSync(filePath, "utf8");
+    const comments = [];
+
+    try {
+        acorn.parse(code, {
+            ecmaVersion: 2020,
+            sourceType: "module",
+            locations: true,
+            onComment: (isBlock, text, start, end) => {
+                const isJSDoc = isBlock && text.startsWith("*");
+
+                // If it's a single-line comment OR a non-JSDoc block comment, mark for removal
+                if (!isBlock || !isJSDoc) {
+                    comments.push({ start, end });
+                }
+            }
+        });
+    } catch (e) {
+        console.error(`❌ Error parsing ${filePath}: ${e.message}`);
+        console.log("⚠️  Falling back to manual sanitization might be risky. Skipping this file.");
+        return;
+    }
+
+    // Sort comments in descending order to avoid offset issues while slicing
+    comments.sort((a, b) => b.start - a.start);
+
+    let result = code;
+    for (const comment of comments) {
+        result = result.slice(0, comment.start) + result.slice(comment.end);
+    }
+
+    // Optional: Clean up empty lines that only contained comments
+    // result = result.replace(/^\s*[\r\n]/gm, "");
+
+    fs.writeFileSync(filePath, result, "utf8");
+    console.log(`✅ ${filePath} sanitized (comments removed, documentation preserved)`);
+}