scai 0.1.16 → 0.1.17

package/README.md

@@ -123,6 +123,15 @@ For more advanced functionality, scai allows you to run custom pipelines with mu
 ```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
 

package/dist/commands/SummaryCmd.js

@@ -29,7 +29,7 @@ export async function summarizeFile(filepath) {
     }
     if (code.trim()) {
         // Call the summary module to get the raw summary
-        const summary = await summaryModule.run({ code });
+        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);

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

@@ -15,6 +15,7 @@ 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)
@@ -28,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')

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 ALWAYS 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "scai",
-  "version": "0.1.16",
+  "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": {