devsplain 1.0.0

package/bin/cli.js

@@ -0,0 +1,59 @@
+#!/usr/bin/env node
+/**
+ * Requires the necessary modules for the script to run.
+ * @requires ../lib/llm.js - provides the getComments function
+ * @requires ../lib/config.js - provides the getConfig function
+ * @requires fs - provides file system functionality
+ */
+const { getComments } = require('../lib/llm.js')
+const { getConfig } = require('../lib/config.js')
+const fs = require('fs');
+
+/**
+ * Retrieves the file path from the command line arguments.
+ * @type {string}
+ */
+const filepath = process.argv[2]
+
+/**
+ * Checks if a file path was provided.
+ * If not, it logs the usage message and exits the process.
+ */
+if (!filepath) {
+    console.log("usage: commie <file>")
+    process.exit(1)
+}
+else {
+    /**
+     * Defines an asynchronous function to comment the code in the provided file.
+     * @async
+     */
+    (async () => {
+        /**
+         * Retrieves the configuration settings.
+         * @type {object}
+         */
+        const config = await getConfig();
+        
+        /**
+         * Reads the contents of the file at the provided file path.
+         * @type {string}
+         */
+        const data = fs.readFileSync(filepath, 'utf-8');
+        
+        // Log a message to indicate that the file is being analyzed
+        console.log("Analyzing File...");
+        
+        /**
+         * Retrieves the commented code using the getComments function.
+         * @type {string}
+         */
+        const commentedCode = await getComments(data, 'javascript', config)
+        
+        // Write the commented code back to the file
+        fs.writeFileSync(filepath, commentedCode);
+        
+        // Log a success message with the file path
+        console.log(`Successfully commented ${filepath}`);
+    })();
+}

package/lib/config.js

@@ -0,0 +1,36 @@
+const fs = require('fs');
+const path = require('path');
+const os = require('os');
+const readline = require('readline');
+const configPath = path.join(os.homedir(), '.commierc');
+
+const rl=readline.createInterface({
+            input:process.stdin,
+            output:process.stdout
+        });
+const askQuestion=(query)=>new Promise((resolve)=>rl.question(query,resolve))
+
+
+
+async function getConfig(){
+    if(!fs.existsSync(configPath)){
+        console.log("Please Enter your api key");
+        const answer=await askQuestion("Paste it here: ");
+        rl.close()
+           const config = {
+            provider: 'groq',
+            apiKey: answer,
+            model: 'llama-3.3-70b-versatile',
+            baseUrl: 'https://api.groq.com/openai'
+        };
+        fs.writeFileSync(configPath,JSON.stringify(config, null,2))
+        return config
+    }
+    else {
+    rl.close(); 
+    const rawData = fs.readFileSync(configPath, 'utf8');
+    return JSON.parse(rawData);
+    }
+}
+
+module.exports = { getConfig };

package/lib/llm.js

@@ -0,0 +1,53 @@
+async function getComments(code,language,config){
+    const prompt=
+    `
+    Add comments to this ${language} code. add JSDoc/docstrings block above functions and brief inline comments for complex logic. Return ONLY the commented code. NO MARKDOWN. NO EXPLANATION. NO PERSONAL MESSAGE.
+    ${code}
+    `
+
+    if(config.provider==='gemini'){
+        const url=`https://generativelanguage.googleapis.com/v1beta/models/${config.model}:generateContent?key=${config.apiKey}`;
+        const response = await fetch(url,
+            {
+                method:'POST',
+                headers:{'Content-Type':'application/json'},
+                body:JSON.stringify({
+                    "contents":[{"parts":[{"text":prompt}]}]
+                })
+            }
+        );
+        const data=await response.json();
+        console.log("DEBUG API RESPONSE:", data); 
+        if (data.error) {
+            console.error("\n API Error:", data.error.message);
+            process.exit(1);
+        }
+        let text = data.candidates[0].content.parts[0].text;
+        text = text.replace(/^```[\w]*\n/m, '').replace(/```$/m, '').trim();
+        return text;
+    }
+    else{
+        const url=`${config.baseUrl}/v1/chat/completions`;
+        const response=await fetch(url,{
+            method:'POST',
+            headers:{'Content-Type':'application/json','Authorization':`Bearer ${config.apiKey}`},
+            body:JSON.stringify({ "model": config.model, "messages": [{ "role": "user", "content": prompt }]
+            })
+
+        })
+        const data = await response.json();
+        console.log("DEBUG API RESPONSE:", data); 
+         if (data.error) {
+            console.error("\n API Error:", data.error.message);
+            process.exit(1);
+        }
+        let text = data.choices[0].message.content;
+        text = text.replace(/^```[\w]*\n/m, '').replace(/```$/m, '').trim();
+        return text;
+
+
+    }
+
+}
+
+module.exports={getComments};

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "devsplain",
+  "version": "1.0.0",
+  "description": "An agent-agnostic CLI tool that automatically adds JSDoc and inline comments to your code using free LLMs.",
+  "author": "mwahaj36",
+  "license": "MIT",
+  "main": "bin/cli.js",
+  "type": "commonjs",
+  "bin": {
+    "devsplain": "./bin/cli.js"
+  },
+  "files": [
+    "bin",
+    "lib"
+  ],
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "keywords": [
+    "cli",
+    "ai",
+    "comments",
+    "jsdoc",
+    "documentation",
+    "gemini",
+    "groq",
+    "llm"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mwahaj36/commie.git"
+  },
+  "bugs": {
+    "url": "https://github.com/mwahaj36/commie/issues"
+  },
+  "homepage": "https://github.com/mwahaj36/commie#readme",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  }
+}