scai 0.1.8 → 0.1.10

package/README.md

@@ -11,12 +11,27 @@
 
 ---
 
+## ❤️ Philosophy: Why Local AI?
+
+We believe your code — and your workflow — should stay **yours**. scai runs entirely on your machine using open-source models and tools.
+
+No internet connection. No vendor lock-in. Just local, private, AI-enhanced developer experience.
+
+✅ Works entirely offline  
+✅ No API keys, cloud accounts, or telemetry  
+✅ Backed by open-source models  
+✅ Designed for CLI-first devs and scriptable workflows  
+
+---
+
+**scai** follows the Unix philosophy — small, composable tools with powerful output.
+
 ## 🚀 Features
 
 - 💬 Generate commit messages from staged Git changes  
 - ✨ Refactor a single JavaScript file for improved readability  
 - 🔍 Check Git status with one command  
-- ⚡️ Powered by Ollama + local models like `llama3` and `mistral`  
+- ⚡️ Powered by open local Ollama models like `mistral`  
 - 🛠️ CLI built with Node.js + TypeScript  
 - 🔒 No external services, full privacy by design  
 
@@ -61,7 +76,7 @@ This will:
 git add .
 
 # Let scai suggest a commit message
-scai commit
+scai suggest
 ```
 
 > Example output:
@@ -72,7 +87,7 @@ feat(api): add error handling to user service
 To automatically commit with the suggested message:
 
 ```bash
-scai commit --commit
+scai suggest --commit
 ```
 
 ---
@@ -91,6 +106,16 @@ path/to/refactored/file.refactored.js
 
 ---
 
+### 🧩 Generate Tests
+
+```bash
+scai generate-tests <file>
+```
+
+Automatically generates Jest test files for specified JavaScript/TypeScript modules.
+
+---
+
 ### 🔍 Check Git status
 
 ```bash
@@ -118,10 +143,3 @@ However:
 For full terms, see the [LICENSE](./LICENSE) file.
 
 ---
-
-## ❤️ Why Local-First?
-
-We believe your code — and your workflow — should stay **yours**. scai runs entirely on your machine using open-source models and tools.
-
-No internet connection. No vendor lock-in. Just local, private, AI-enhanced developer experience.
-

package/dist/commands/CommitSuggesterCmd.js

@@ -7,17 +7,21 @@ function askUserToChoose(suggestions) {
             console.log(`${i + 1}) ${msg}`);
         });
         console.log(`${suggestions.length + 1}) 🔁 Regenerate suggestions`);
+        console.log(`${suggestions.length + 2}) ✍️  Write your own commit message`);
         const rl = readline.createInterface({
             input: process.stdin,
             output: process.stdout,
         });
-        rl.question(`\n👉 Choose a commit message [1-${suggestions.length + 1}]: `, (answer) => {
+        rl.question(`\n👉 Choose a commit message [1-${suggestions.length + 2}]: `, (answer) => {
             rl.close();
             const choice = parseInt(answer, 10);
-            if (isNaN(choice) || choice < 1 || choice > suggestions.length + 1) {
+            if (isNaN(choice) || choice < 1 || choice > suggestions.length + 2) {
                 console.log('⚠️  Invalid selection. Using the first suggestion by default.');
                 resolve(0);
             }
+            else if (choice === suggestions.length + 2) {
+                resolve('custom');
+            }
             else {
                 resolve(choice - 1); // Return 0-based index (0 to 3)
             }
@@ -45,6 +49,18 @@ async function generateSuggestions(prompt) {
     }
     return messages;
 }
+function promptCustomMessage() {
+    return new Promise((resolve) => {
+        const rl = readline.createInterface({
+            input: process.stdin,
+            output: process.stdout,
+        });
+        rl.question('\n📝 Enter your custom commit message:\n> ', (input) => {
+            rl.close();
+            resolve(input.trim());
+        });
+    });
+}
 export async function suggestCommitMessage(options) {
     try {
         let diff = execSync("git diff", { encoding: "utf-8" }).trim();
@@ -65,13 +81,17 @@ ${diff}`;
         let message = null;
         while (message === null) {
             const suggestions = await generateSuggestions(prompt);
-            const choiceIndex = await askUserToChoose(suggestions);
-            if (choiceIndex === suggestions.length) {
+            const choice = await askUserToChoose(suggestions);
+            if (choice === suggestions.length) {
                 // User chose "Regenerate"
                 console.log('\n🔄 Regenerating suggestions...\n');
                 continue;
             }
-            message = suggestions[choiceIndex];
+            if (choice === 'custom') {
+                message = await promptCustomMessage();
+                break;
+            }
+            message = suggestions[choice];
         }
         console.log(`\n✅ Selected commit message:\n${message}\n`);
         if (options.commit) {
@@ -80,7 +100,7 @@ ${diff}`;
                 execSync("git add .", { encoding: "utf-8" });
             }
             execSync(`git commit -m "${message.replace(/"/g, '\\"')}"`, { stdio: 'inherit' });
-            console.log('✅ Committed with AI-suggested message.');
+            console.log('✅ Committed with selected message.');
         }
     }
     catch (err) {

package/dist/commands/ReadmeCmd.js

@@ -3,9 +3,12 @@ import fs from 'fs/promises';
 import path from 'path';
 export async function updateReadmeIfNeeded() {
     try {
-        const diff = execSync("git diff", { encoding: "utf-8" }).trim();
+        let diff = execSync("git diff", { encoding: "utf-8" }).trim();
         if (!diff) {
-            console.log("⚠️ No changes to analyze in the working directory.");
+            diff = execSync("git diff --cached", { encoding: "utf-8" }).trim();
+        }
+        if (!diff) {
+            console.log('⚠️  No staged changes to suggest a message for.');
             return;
         }
         const readmePath = path.resolve("README.md");

package/dist/commands/RefactorCmd.js

@@ -1,7 +1,6 @@
 import fs from 'fs/promises';
 import path from 'path';
 import { runPromptPipeline } from '../pipeline/runPipeline.js';
-import { refactorModule } from '../pipeline/modules/refactorModule.js';
 import { addCommentsModule } from '../pipeline/modules/commentModule.js';
 import { cleanupModule } from '../pipeline/modules/cleanupModule.js';
 export async function handleRefactor(filepath, options = {}) {
@@ -28,11 +27,11 @@ export async function handleRefactor(filepath, options = {}) {
         // Read source code
         const originalCode = await fs.readFile(filepath, 'utf-8');
         // Run through pipeline modules
-        const refactored = await runPromptPipeline([refactorModule, addCommentsModule, cleanupModule], { code: originalCode });
-        if (!refactored.trim())
+        const refactored = await runPromptPipeline([addCommentsModule, cleanupModule], { code: originalCode });
+        if (!refactored.code.trim())
             throw new Error('⚠️ Model returned empty result');
         // Save refactored output
-        await fs.writeFile(refactoredPath, refactored, 'utf-8');
+        await fs.writeFile(refactoredPath, refactored.code, 'utf-8');
         console.log(`✅ Refactored code saved to: ${refactoredPath}`);
         console.log(`ℹ️ Run again with '--apply' to overwrite the original.`);
     }

package/dist/commands/TestGenCmd.js

@@ -0,0 +1,14 @@
+import fs from 'fs/promises';
+import { generateTestsModule } from '../pipeline/modules/generateTestsModule.js';
+import { cleanupModule } from '../pipeline/modules/cleanupModule.js';
+import { runPromptPipeline } from '../pipeline/runPipeline.js';
+export async function generateTests(filepath) {
+    try {
+        const code = await fs.readFile(filepath, 'utf-8');
+        const result = await runPromptPipeline([generateTestsModule, cleanupModule], { code, filepath });
+        console.log('✅ Test generated and cleaned up.');
+    }
+    catch (err) {
+        console.error('❌ Error generating tests:', err.message);
+    }
+}

package/dist/index.js

@@ -5,6 +5,7 @@ import { checkGit } from "./commands/GitCmd.js";
 import { suggestCommitMessage } from "./commands/CommitSuggesterCmd.js";
 import { handleRefactor } from "./commands/RefactorCmd.js";
 import { updateReadmeIfNeeded } from "./commands/ReadmeCmd.js";
+import { generateTests } from "./commands/TestGenCmd.js";
 // Import the model check and initialization logic
 import { bootstrap } from './modelSetup.js';
 // Create the CLI instance
@@ -27,7 +28,7 @@ cmd
     .description('Check Git status')
     .action(checkGit);
 cmd
-    .command('commit')
+    .command('suggest')
     .description('Suggest a commit message from staged changes')
     .option('-c, --commit', 'Automatically commit with suggested message')
     .action(suggestCommitMessage);
@@ -40,5 +41,9 @@ cmd
     .command('readme')
     .description('Update README.md if relevant changes were made')
     .action(updateReadmeIfNeeded);
+cmd
+    .command('generate-tests <file>')
+    .description('Generate a Jest test file for the specified JS/TS module')
+    .action((file) => generateTests(file));
 // Parse CLI arguments
 cmd.parse(process.argv);

package/dist/jest.config.js

@@ -0,0 +1,11 @@
+const config = {
+    preset: 'ts-jest',
+    testEnvironment: 'node',
+    setupFilesAfterEnv: ['./jest.setup.ts'],
+    transform: {
+        '^.+\\.ts$': 'ts-jest',
+    },
+    moduleFileExtensions: ['ts', 'js', 'json', 'node'],
+    testPathIgnorePatterns: ['/node_modules/', '/dist/'],
+};
+export default config;

package/dist/jest.setup.js

@@ -0,0 +1,7 @@
+import { jest } from '@jest/globals';
+// Jest setup to mock fetch for Node.js 18+
+if (typeof global.fetch === 'undefined') {
+    global.fetch = jest.fn(() => Promise.resolve({
+        json: () => Promise.resolve({ response: 'Mocked Commit Message' }),
+    }));
+}

package/dist/pipeline/modules/cleanupModule.js

@@ -1,34 +1,42 @@
+function isNaturalLanguageNoise(line) {
+    const trimmed = line.trim().toLowerCase();
+    return (trimmed.startsWith('i ') ||
+        trimmed.startsWith('here') ||
+        trimmed.startsWith('this') ||
+        trimmed.startsWith('the following') ||
+        trimmed.startsWith('below') ||
+        trimmed.startsWith('in this') ||
+        trimmed.startsWith('we have') ||
+        trimmed.includes('the code above') ||
+        trimmed.includes('ensures that') ||
+        trimmed.includes('it handles') ||
+        trimmed.includes('used to'));
+}
 export const cleanupModule = {
     name: 'cleanup',
-    description: 'Removes markdown formatting and explanations from the output',
+    description: 'Remove markdown fences and natural language noise from top/bottom of code',
     async run({ code }) {
-        const prompt = `
-You are a code cleanup assistant.
-
-Your task is to take the following code output and:
-- Remove any markdown formatting like triple backticks from the top of the file
-- Remove any markdown formatting like triple backticks from the bottom of the file
-- Keep all actual TypeScript/JavaScript code
-- keep all comments that start with // or /* and ends with */
-- do not tell me what you have done or make any such similar comments
-- do not add any tripple backticks
-
-Return ONLY the cleaned code, without any markdown or extra text.
-
---- CODE START ---
-${code}
---- CODE END ---
-`.trim();
-        const res = await fetch('http://localhost:11434/api/generate', {
-            method: 'POST',
-            headers: { 'Content-Type': 'application/json' },
-            body: JSON.stringify({
-                model: 'llama3',
-                prompt,
-                stream: false
-            }),
-        });
-        const data = await res.json();
-        return { code: data.response?.trim() ?? '' };
+        let lines = code.trim().split('\n');
+        // ───── Clean top ─────
+        while (lines.length) {
+            const line = lines[0].trim();
+            if (line === '' || line.startsWith('```') || isNaturalLanguageNoise(line)) {
+                lines.shift();
+            }
+            else {
+                break;
+            }
+        }
+        // ───── Clean bottom ─────
+        while (lines.length) {
+            const line = lines[lines.length - 1].trim();
+            if (line === '' || line.startsWith('```') || isNaturalLanguageNoise(line)) {
+                lines.pop();
+            }
+            else {
+                break;
+            }
+        }
+        return { code: lines.join('\n').trim() };
     }
 };

package/dist/pipeline/modules/commentModule.js

@@ -5,9 +5,9 @@ export const addCommentsModule = {
         const prompt = `
 You are a senior JavaScript engineer. 
 
-Add clear and helpful single-line // comments only to each block of the following code. 
-- Keep the code unchanged otherwise.
-- Return ONLY the valid refactored code (no markdown)
+Add clear and helpful single-line // comments to complex parts of the code.
+- Do NOT remove or change in ANY way any parts of the code!
+- Output ALL of the original code with your comments included
 
 --- CODE START ---
 ${input.code}

package/dist/pipeline/modules/generateTestsModule.js

@@ -0,0 +1,42 @@
+import fs from 'fs/promises';
+import path from 'path';
+export const generateTestsModule = {
+    name: 'generateTests',
+    description: 'Generate a Jest test file for the class/module',
+    async run({ code, filepath }) {
+        const prompt = `
+You're a senior TypeScript developer. Given the following class or module, generate a Jest test file.
+
+Guidelines:
+- Use the 'jest' test framework
+- Cover public methods and one edge case
+- Name the file <original>.test.ts
+- Only return valid TypeScript code
+
+--- CODE START ---
+${code}
+--- CODE END ---
+    `.trim();
+        const res = await fetch('http://localhost:11434/api/generate', {
+            method: 'POST',
+            headers: { 'Content-Type': 'application/json' },
+            body: JSON.stringify({
+                model: 'mistral',
+                prompt,
+                stream: false
+            })
+        });
+        const data = await res.json();
+        const testCode = data.response?.trim();
+        if (!testCode)
+            throw new Error('⚠️ No test code returned from model');
+        // Determine test file path next to refactored file
+        if (!filepath)
+            throw new Error('Missing filepath in pipeline context');
+        const { dir, name } = path.parse(filepath);
+        const testPath = path.join(dir, `${name}.test.ts`);
+        await fs.writeFile(testPath, testCode, 'utf-8');
+        console.log(`✅ Test file saved to: ${testPath}`);
+        return { code, filepath }; // unchanged input
+    }
+};

package/dist/pipeline/modules/refactorModule.js

@@ -6,9 +6,8 @@ export const refactorModule = {
 You are a senior JavaScript/TypeScript engineer.
 
 Refactor the following code:
-- Split into ~10 line functions
-- Improve naming, structure, and clarity
-- Return ONLY the valid refactored code (no markdown)
+- Refactor all functions longer than 20 lines by extracting logical parts into smaller helper functions. 
+- Each resulting function should aim for clarity and ideally be under 20 lines, unless splitting would harm readability or functionality.
 
 --- CODE START ---
 ${code}

package/dist/pipeline/runPipeline.js

@@ -1,10 +1,23 @@
 export async function runPromptPipeline(modules, input) {
     let current = input;
-    console.log('Input: ', input);
+    // Add flag or condition for logging (optional)
+    const isDebug = true;
+    if (isDebug) {
+        console.log('Input: ', input);
+    }
     for (const mod of modules) {
-        console.log(`⚙️ Running: ${mod.name}`);
-        current = await mod.run(current);
-        console.log("Current: ", current);
+        try {
+            current = await mod.run(current);
+            if (isDebug) {
+                console.log(`⚙️ Running: ${mod.name}`);
+                console.log("Current: ", current);
+            }
+        }
+        catch (error) {
+            console.error(`❌ Error in ${mod.name}:`, error instanceof Error ? error.message : error);
+            throw new Error(`Pipeline failed at module ${mod.name}`);
+        }
     }
-    return current.code;
+    // Return the output, assuming 'code' holds the relevant transformed content
+    return { code: current.code }; // Ensure the return type matches PromptOutput
 }

package/dist/utils/runTests.js

@@ -0,0 +1,11 @@
+import { execSync } from 'child_process';
+export function runJestTest(testFile) {
+    try {
+        execSync(`npx jest ${testFile} --silent`, { stdio: 'inherit' });
+        return true;
+    }
+    catch (err) {
+        console.error(`❌ Tests failed for ${testFile}`);
+        return false;
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "scai",
-  "version": "0.1.8",
+  "version": "0.1.10",
   "type": "module",
   "bin": {
     "scai": "./dist/index.js"
@@ -11,7 +11,14 @@
   },
   "author": "Rasmus Uhd Norgaard",
   "license": "SEE LICENSE IN LICENSE",
-  "keywords": ["cli", "ai", "refactor", "devtools", "local", "typescript"],
+  "keywords": [
+    "cli",
+    "ai",
+    "refactor",
+    "devtools",
+    "local",
+    "typescript"
+  ],
   "scripts": {
     "build": "tsc",
     "start": "node dist/index.js"
@@ -20,11 +27,14 @@
     "commander": "^11.0.0"
   },
   "devDependencies": {
+    "@types/jest": "^30.0.0",
     "@types/node": "^24.0.1",
+    "jest": "^30.0.2",
+    "ts-jest": "^29.4.0",
     "typescript": "^5.8.3"
   },
   "files": [
     "dist/",
-    "README.md"	
+    "README.md"
   ]
-}
+}

package/dist/commands/CommitSuggesterCmd.refactored.js

@@ -1,44 +0,0 @@
-"use strict";
-Here;
-is;
-the;
-refactored;
-code;
-with (comments)
-    added;
-and;
-a;
-summary;
-of;
-refactor;
-at;
-the;
-end: `` `typescript
-// Import necessary modules for executing child processes, fetch requests, and readline interface
-import { execSync } from 'child_process';
-import readline from 'readline';
-import { fetch } from 'node-fetch';
-
-// Define an asynchronous function to generate messages based on the provided prompt
-async function generateMessages(prompt: string): Promise<string[]> {
-  // ... (Existing code)
-}
-
-// Define an asynchronous function to ask for a user choice among the given suggestions
-async function askForChoice(options: { suggestions: string[] }): Promise<number> {
-  // ... (Existing code)
-}
-
-// Export an asynchronous function to suggest a commit message based on the given options (with the commit flag for final committing)
-export async function suggestCommitMessage({ commit = false }: { commit?: boolean }) {
-  try {
-    // ... (Existing code)
-  } catch (err) {
-    console.error('❌ Error in commit message suggestion:', err.message);
-  }
-}
-
-// Summary of refactor:
-// - Added comments to each block for better understanding.
-// - Extracted the functions generateMessages and askForChoice into separate blocks for code organization.
-` ``;

package/dist/commands/RefactorCmd.refactored.js

@@ -1,8 +0,0 @@
-"use strict";
-// Summary of refactor:
-// - Normalized file paths by adding './' if not present
-// - Parsed normalized file paths into their directory, name, and extension
-// - Generated a refactored file path using the original file's directory, name, and extension along with the '.refactored' suffix
-// - Handled the refactor operation for a given file path and options (apply flag to decide whether to overwrite the original file or not)
-// - If apply is set, attempted to read the refactored code from the refactored file path and overwrite the original file if it exists.
-// - If not, read the original code from the file, passed it through a pipeline for refactoring, saved the refactored code to a new file path, and provided an option to run again with '--apply' to overwrite the original.

package/dist/pipeline/modules/stripMarkdownModule.js

@@ -1,15 +0,0 @@
-export const stripMarkdownModule = {
-    name: 'stripMarkdown',
-    description: 'Remove surrounding markdown and explanations from LLM output',
-    async run({ code }) {
-        let cleaned = code.trim();
-        // Remove common intro text like "Here is the refactored code:"
-        cleaned = cleaned.replace(/^.*?(?=\n|```|import|function|const|let)/is, '');
-        // Remove triple backtick blocks and optional language tags
-        cleaned = cleaned.replace(/^```[a-z]*\n?/i, '');
-        cleaned = cleaned.replace(/```$/, '');
-        // Remove any leftover empty lines at top and bottom
-        cleaned = cleaned.trim();
-        return { code: cleaned };
-    }
-};