scai 0.1.15 → 0.1.17

package/README.md

@@ -30,8 +30,6 @@ We believe your code — and your workflow — should stay **yours**. scai runs
 ✅ Backed by open-source models  
 ✅ Designed for CLI-first developers
 
----
-
 ## 📦 Installation
 
 1. **Install [Ollama](https://ollama.com)**  
@@ -59,8 +57,6 @@ This will:
 - Start the Ollama background server
 - Download required models (`llama3`, etc.)
 
----
-
 ## 🧪 Usage Examples
 
 ### 💬 Suggest a commit message
@@ -108,7 +104,6 @@ To pipe input for summarization:
 cat <file> | scai summ
 ```
 
-
 ---
 
 ### 📝 Update the changelog
@@ -121,6 +116,23 @@ Analyzes the current Git diff and updates (or creates) a `CHANGELOG.md` file wit
 
 ---
 
+### 📦 Module Pipeline (Advanced Usage)
+
+For more advanced functionality, scai allows you to run custom pipelines with multiple modules to process code. You can specify multiple modules to be run, such as comment, summary, cleanup, and more.
+
+```bash
+scai <file> --modules comment,summary,cleanup
+```
+Like with regular Unix commands you can pipe this to a file
+
+```bash
+scai <file> --modules comment,summary > test.txt
+```
+Or to both stdout and a file with tee fx. 
+```bash
+scai <file> --modules comment,summary | tee test.txt
+```
+
 ## 🔐 License & Fair Use
 
 **scai is free to use** for individuals, teams, and companies — including in commercial work.
@@ -137,5 +149,3 @@ But you may not:
 - ❌ Claim ownership of the tool
 
 See [LICENSE](./LICENSE) for full terms.
-
----

package/dist/commands/ChangeLogUpdateCmd.js

@@ -2,7 +2,7 @@
 import { execSync } from 'child_process';
 import fs from 'fs/promises';
 import path from 'path';
-import { runPromptPipeline } from '../pipeline/runPipeline.js';
+import { runModulePipeline } from '../pipeline/runModulePipeline.js';
 import { changelogModule } from '../pipeline/modules/changeLogModule.js';
 export async function handleChangelogUpdate() {
     try {
@@ -14,7 +14,7 @@ export async function handleChangelogUpdate() {
             console.log("⚠️  No staged or unstaged changes to include in changelog.");
             return;
         }
-        const result = await runPromptPipeline([changelogModule], { code: diff });
+        const result = await runModulePipeline([changelogModule], { code: diff });
         if (!result.code.trim()) {
             console.log("✅ No significant changes for changelog.");
             return;

package/dist/commands/ModulePipelineCmd.js

@@ -0,0 +1,31 @@
+import { readFileSync } from 'fs';
+import { getModuleByName } from '../registry/moduleRegistry.js';
+import { runModulePipeline } from '../pipeline/runModulePipeline.js';
+export async function runModulePipelineFromCLI(file, options) {
+    if (!options.modules) {
+        console.error('❌ No modules specified. Use --modules or -m.');
+        process.exit(1);
+    }
+    const moduleNames = options.modules.split(',').map((m) => m.trim());
+    // Read file content
+    let fileContent = '';
+    try {
+        fileContent = readFileSync(file, 'utf-8');
+    }
+    catch (err) {
+        console.error(`❌ Could not read file: ${file}`);
+        process.exit(1);
+    }
+    const input = { code: fileContent, filepath: file };
+    // Retrieve modules from the registry
+    const resolvedModules = moduleNames.map((name) => {
+        const module = getModuleByName(name);
+        if (!module) {
+            console.error(`❌ Failed to load module: ${name}`);
+            process.exit(1);
+        }
+        return module;
+    });
+    // Run the module pipeline
+    await runModulePipeline(resolvedModules, input);
+}

package/dist/commands/RefactorCmd.js

@@ -1,6 +1,6 @@
 import fs from 'fs/promises';
 import path from 'path';
-import { runPromptPipeline } from '../pipeline/runPipeline.js';
+import { runModulePipeline } from '../pipeline/runModulePipeline.js';
 import { addCommentsModule } from '../pipeline/modules/commentModule.js';
 import { cleanupModule } from '../pipeline/modules/cleanupModule.js';
 export async function handleRefactor(filepath, options = {}) {
@@ -27,7 +27,7 @@ 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([addCommentsModule, cleanupModule], { code: originalCode });
+        const refactored = await runModulePipeline([addCommentsModule, cleanupModule], { code: originalCode });
         if (!refactored.code.trim())
             throw new Error('⚠️ Model returned empty result');
         // Save refactored output

package/dist/commands/SummaryCmd.js

@@ -1,6 +1,7 @@
 import fs from 'fs/promises';
-import { summaryModule } from '../pipeline/modules/summaryModule.js';
 import readline from 'readline';
+import { summaryModule } from '../pipeline/modules/summaryModule.js'; // Import summaryModule
+import { summarizeCode } from '../utils/summarizer.js'; // Import summarizeCode
 export async function summarizeFile(filepath) {
     let code = '';
     if (filepath) {
@@ -12,7 +13,6 @@ export async function summarizeFile(filepath) {
             return;
         }
     }
-    // ⬇️ Add this check right here
     else if (process.stdin.isTTY) {
         console.error('❌ No file provided and no piped input.\n👉 Usage: scai summ <file> or cat file | scai summ');
         return;
@@ -28,7 +28,11 @@ export async function summarizeFile(filepath) {
         }
     }
     if (code.trim()) {
-        await summaryModule.run({ code });
+        // Call the summary module to get the raw summary
+        const summary = await summaryModule.run({ code, filepath });
+        // Pass the summary text to the utility function for formatting
+        const formattedSummary = summarizeCode(summary.code);
+        console.log(formattedSummary);
     }
     else {
         console.error('❌ No code provided to summarize.');

package/dist/commands/TestGenCmd.js

@@ -1,11 +1,11 @@
 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';
+import { runModulePipeline } from '../pipeline/runModulePipeline.js';
 export async function generateTests(filepath) {
     try {
         const code = await fs.readFile(filepath, 'utf-8');
-        const result = await runPromptPipeline([generateTestsModule, cleanupModule], { code, filepath });
+        const result = await runModulePipeline([generateTestsModule, cleanupModule], { code, filepath });
         console.log('✅ Test generated and cleaned up.');
     }
     catch (err) {

package/dist/context/generateProjectContext.js

@@ -0,0 +1,104 @@
+import fs from 'fs/promises';
+import path from 'path';
+import fg from 'fast-glob';
+import { posix as pathPosix } from 'path';
+import { ModelConfig } from '../config/ModelConfig.js';
+const IGNORE = ['node_modules', 'dist', 'build', 'coverage', '.git', '**/*.test.*'];
+const EXTENSIONS_BY_LANG = {
+    ts: ['.ts', '.tsx'],
+    js: ['.js', '.jsx'],
+    java: ['.java'],
+    rust: ['.rs'],
+    python: ['.py'],
+};
+function getSummary(filename, lang) {
+    const base = path.basename(filename).toLowerCase();
+    const ext = path.extname(base);
+    if (base === 'package.json')
+        return 'Defines project metadata and dependencies.';
+    if (base === 'tsconfig.json')
+        return 'TypeScript compiler settings.';
+    if (base === 'pyproject.toml')
+        return 'Python build and dependency configuration.';
+    if (base === 'Cargo.toml')
+        return 'Rust project configuration.';
+    if (base === 'pom.xml')
+        return 'Maven config for a Java project.';
+    if (base === 'README.md')
+        return 'Project documentation.';
+    if (base.startsWith('index'))
+        return 'Entry point module.';
+    if (lang === 'ts' || lang === 'js') {
+        if (base.includes('service'))
+            return 'Service logic module.';
+        if (base.includes('util'))
+            return 'Utility/helper module.';
+        if (base.includes('controller'))
+            return 'Handles request/response logic.';
+        if (base.includes('router'))
+            return 'Routing definitions.';
+    }
+    if (lang === 'java') {
+        if (base.includes('controller'))
+            return 'Java controller class.';
+        if (base.includes('service'))
+            return 'Business logic in Java.';
+    }
+    if (lang === 'python') {
+        if (base.includes('main'))
+            return 'Main execution script.';
+        if (base.includes('config'))
+            return 'Configuration or settings.';
+    }
+    if (lang === 'rust') {
+        if (base === 'main.rs')
+            return 'Main Rust binary entry point.';
+        if (base === 'lib.rs')
+            return 'Rust library root module.';
+    }
+    return `Generic ${ext.replace('.', '')} file.`;
+}
+function insertNested(tree, parts, summary) {
+    const name = parts.pop();
+    let curr = tree;
+    for (const dir of parts) {
+        if (!curr[dir])
+            curr[dir] = {};
+        curr = curr[dir];
+    }
+    curr[name] = summary;
+}
+export async function generateProjectContext(root = process.cwd()) {
+    const lang = ModelConfig.getLanguage();
+    const extensions = EXTENSIONS_BY_LANG[lang];
+    const patterns = extensions.map((ext) => `**/*${ext}`);
+    // Add language-relevant config files
+    if (lang === 'ts')
+        patterns.push('tsconfig.json', 'package.json');
+    if (lang === 'js')
+        patterns.push('package.json');
+    if (lang === 'java')
+        patterns.push('pom.xml');
+    if (lang === 'python')
+        patterns.push('pyproject.toml', '*.py');
+    if (lang === 'rust')
+        patterns.push('Cargo.toml', '*.rs');
+    const files = await fg(patterns, {
+        cwd: root,
+        ignore: IGNORE,
+    });
+    const flat = {};
+    const tree = {};
+    for (const file of files) {
+        const summary = getSummary(file, lang);
+        flat[file] = summary;
+        insertNested(tree, pathPosix.normalize(file).split('/'), summary);
+    }
+    await fs.mkdir('.scai', { recursive: true });
+    await fs.writeFile('.scai/context.flat.json', JSON.stringify(flat, null, 2));
+    await fs.writeFile('.scai/context.tree.json', JSON.stringify(tree, null, 2));
+    console.log(`✅ Context generated:
+  - .scai/context.flat.json
+  - .scai/context.tree.json
+  - Language used: ${lang}`);
+}

package/dist/context/loadProjectContext.js

@@ -0,0 +1 @@
+"use strict";

package/dist/index.js

@@ -1,8 +1,10 @@
 #!/usr/bin/env node
 import { Command } from "commander";
+// Importing package.json for version
 import { createRequire } from 'module';
 const require = createRequire(import.meta.url);
 const { version } = require('../package.json');
+// Importing commands
 import { checkEnv } from "./commands/EnvCmd.js";
 import { checkGit } from "./commands/GitCmd.js";
 import { suggestCommitMessage } from "./commands/CommitSuggesterCmd.js";
@@ -12,6 +14,8 @@ import { bootstrap } from './modelSetup.js';
 import { ModelConfig } from './config/ModelConfig.js';
 import { summarizeFile } from "./commands/SummaryCmd.js";
 import { handleChangelogUpdate } from './commands/ChangeLogUpdateCmd.js';
+import { runModulePipelineFromCLI } from './commands/ModulePipelineCmd.js';
+import { generateProjectContext } from './context/generateProjectContext.js';
 // Create the CLI instance
 const cmd = new Command('scai')
     .version(version)
@@ -25,6 +29,12 @@ cmd
     await bootstrap();
     console.log('✅ Model initialization completed!');
 });
+cmd
+    .command('context')
+    .description('Generate a summary-based context map of your project')
+    .action(async () => {
+    await generateProjectContext(); // Your new scanner module
+});
 cmd
     .command('sugg')
     .description('Suggest a commit message from staged changes')
@@ -63,6 +73,16 @@ cmd
     .action(() => {
     ModelConfig.logCurrentConfig();
 });
+cmd
+    .arguments('<file>')
+    .option('-m, --modules <modules>', 'Comma-separated list of modules to run (e.g., comments,cleanup,summary)')
+    .action((file, options) => {
+    if (!options.modules) {
+        console.error('❌ You must specify modules with -m or --modules');
+        process.exit(1);
+    }
+    runModulePipelineFromCLI(file, options);
+});
 // ✅ Now that commands are defined, parse args
 cmd.parse(process.argv);
 // ✅ Apply global options after parsing

package/dist/pipeline/modules/commentModule.js

@@ -9,12 +9,12 @@ export const addCommentsModule = {
         const prompt = `
 You are a senior ${lang.toUpperCase()} engineer reviewing source code.
 
-Your task is to add clear and helpful single-line // comments to complex or non-obvious parts of the code.
+Your task is to add clear and insightful single-line comments to the code.
 
 ⚠️ VERY IMPORTANT RULES:
 - You MUST return the ENTIRE original code.
 - You MUST NOT remove, replace, reformat, or alter ANY code.
-- Only add single-line // comments in appropriate places.
+- Only add single-line // comments to complex or non-obvious parts of the code.
 - Do NOT wrap the code in markdown or code blocks.
 - The code should be valid ${lang.toUpperCase()} after your changes.
 

package/dist/pipeline/modules/commitSuggesterModule.js

@@ -6,7 +6,7 @@ export const commitSuggesterModule = {
     async run({ code }) {
         const model = ModelConfig.getModel();
         const prompt = `
-Suggest 3 concise, conventional Git commit messages based on this diff.
+Suggest ALWAYS 3 concise, conventional Git commit messages based on the input code diff.
 Use this format ONLY:
 
 1. feat: ...

package/dist/pipeline/modules/summaryModule.js

@@ -1,18 +1,42 @@
 import { ModelConfig } from '../../config/ModelConfig.js';
 import { generate } from '../../lib/generate.js';
+import fs from 'fs/promises';
+import path from 'path';
 export const summaryModule = {
     name: 'summary',
     description: 'Prints a summary of changes to the terminal',
-    async run({ code }) {
+    async run({ code, filepath }) {
         const model = ModelConfig.getModel();
         const lang = ModelConfig.getLanguage();
+        let contextString = '';
+        // Try to load and filter the flat context
+        try {
+            const raw = await fs.readFile('./.scai/context.flat.json', 'utf-8');
+            const flatContext = JSON.parse(raw);
+            if (filepath) {
+                const dir = path.dirname(filepath).replace(/\\/g, '/'); // Normalize slashes
+                console.log("Dir: ", dir);
+                const contextSubset = Object.entries(flatContext)
+                    .filter(([file]) => file.startsWith(dir))
+                    .slice(0, 10); // limit if needed
+                if (contextSubset.length) {
+                    contextString = '📁 Local Context:\n' + contextSubset
+                        .map(([file, summary]) => `- ${file}: ${summary}`)
+                        .join('\n');
+                    console.log("Context string input to prompt: ", contextString);
+                }
+            }
+        }
+        catch (err) {
+            console.warn('⚠️ Context file not found or failed to parse.');
+        }
         const prompt = `
 You are a senior ${lang.toUpperCase()} engineer.
 
-Take the following source code and do NOT modify it in any way. Your task is:
+Project Overview:
+${contextString ? contextString + '\n\n' : ''}
 
-1. Output the original code exactly as it is.
-2. After the code, append a short summary in this format:
+Take the following source code and do NOT modify it in any way. Your task is:
 
 // Summary of code:
 // - [What the code does at a high level]
@@ -20,9 +44,8 @@ Take the following source code and do NOT modify it in any way. Your task is:
 // - [Any interesting logic or patterns]
 
 ⚠️ IMPORTANT:
-- Do NOT omit or alter any part of the original code.
-- Do NOT insert comments inside the code.
-- Only append the summary AFTER the full code.
+- Do NOT include the original code in your summary
+- Remove the original code from you output
 
 --- CODE START ---
 ${code}
@@ -36,7 +59,6 @@ ${code}
         else {
             console.warn('⚠️ No summary generated.');
         }
-        // Return unchanged input for composability
-        return { code };
+        return { code }; // passthrough
     }
 };

package/dist/pipeline/{runPipeline.js → runModulePipeline.js}

@@ -1,4 +1,4 @@
-export async function runPromptPipeline(modules, input) {
+export async function runModulePipeline(modules, input) {
     let current = input;
     // Add flag or condition for logging (optional)
     const isDebug = true;

package/dist/registry/moduleRegistry.js

@@ -0,0 +1,21 @@
+import { addCommentsModule } from '../pipeline/modules/commentModule.js';
+import { cleanupModule } from '../pipeline/modules/cleanupModule.js';
+import { summaryModule } from '../pipeline/modules/summaryModule.js';
+import { generateTestsModule } from '../pipeline/modules/generateTestsModule.js';
+import { commitSuggesterModule } from '../pipeline/modules/commitSuggesterModule.js';
+import { changelogModule } from '../pipeline/modules/changeLogModule.js';
+// Add more as needed...
+const builtInModules = {
+    comments: addCommentsModule,
+    cleanup: cleanupModule,
+    summary: summaryModule,
+    tests: generateTestsModule,
+    suggest: commitSuggesterModule,
+    changelog: changelogModule,
+};
+export function getModuleByName(name) {
+    return builtInModules[name];
+}
+export function listAvailableModules() {
+    return Object.keys(builtInModules);
+}

package/dist/utils/summarizer.js

@@ -0,0 +1,10 @@
+import { wrapText } from "./textWrapper.js";
+// src/utils/summarizer.ts
+export function summarizeCode(summaryText) {
+    // Get the terminal width (default to 80 if not available)
+    const terminalWidth = process.stdout.columns || 80;
+    // Use two-thirds of the terminal width for the wrapping
+    const twoThirdsTerminalWidth = Math.floor((terminalWidth * 2) / 3);
+    // Wrap the summary output to fit within two-thirds of the terminal width
+    return wrapText(summaryText, twoThirdsTerminalWidth);
+}

package/dist/utils/textWrapper.js

@@ -0,0 +1,18 @@
+export function wrapText(text, maxWidth) {
+    const words = text.split(' ');
+    let wrappedText = '';
+    let currentLine = '';
+    words.forEach(word => {
+        // Check if adding the word would exceed the max width
+        if ((currentLine + word).length > maxWidth) {
+            wrappedText += currentLine + '\n'; // Add the current line and start a new one
+            currentLine = word + ' '; // Start the new line with the current word
+        }
+        else {
+            currentLine += word + ' '; // Add the word to the current line
+        }
+    });
+    // Append the last line if any
+    wrappedText += currentLine;
+    return wrappedText;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "scai",
-  "version": "0.1.15",
+  "version": "0.1.17",
   "type": "module",
   "bin": {
     "scai": "./dist/index.js"
@@ -25,6 +25,7 @@
   },
   "dependencies": {
     "commander": "^11.0.0",
+    "fast-glob": "^3.3.3",
     "ora": "^8.2.0"
   },
   "devDependencies": {