@aramassa/ai-rules 0.3.4 → 0.4.0

package/artifact/chatmodes/Planning.md

@@ -7,7 +7,6 @@ tools:
   - "searchResults"
   - "editFiles"
   - "search"
-  - "add_issue_comment"
   - "add_sub_issue"
   - "create_issue"
   - "get_code_scanning_alert"

package/dist/cli.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAqjBA;;GAEG;AACH,wBAAsB,wBAAwB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,MAAY,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAyBpG"}
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAujBA;;GAEG;AACH,wBAAsB,wBAAwB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,MAAY,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAyBpG"}

package/dist/cli.js

@@ -18241,6 +18241,7 @@ function setupProgram() {
         .option('--env-file <path>', 'Path to .env file for template variables')
         .option('--debug', 'Enable debug logging')
         .option('--verbose', 'Enable verbose logging (alias for --debug)')
+        .option('--dry-run', 'Preview input/output files without writing')
         .action(async (options) => {
         await handleExtractCommand(options);
     });
@@ -18364,6 +18365,121 @@ function convertFiltersToAttrFilters(filters) {
 /**
  * Common logic for loading and filtering markdown files
  */
+/**
+ * Displays dry-run preview for recipe processing
+ */
+async function displayRecipeDryRunPreview(recipePath, recipeData, expandedRecipe, baseOptions, debugLogger, cliBaseDir, cliOutFile, cliSrc) {
+    console.log('=== Recipe Dry-Run Preview ===\n');
+    const presetName = recipePath.startsWith(':') ? recipePath : undefined;
+    if (presetName) {
+        console.log(`📦 Recipe: ${presetName} (${expandedRecipe.length} steps)`);
+    }
+    else {
+        console.log(`📦 Recipe: ${recipePath} (${expandedRecipe.length} steps)`);
+    }
+    const recipeBaseDir = recipeData.config?.baseDir;
+    let totalInputFiles = 0;
+    let totalIncludedFiles = 0;
+    let totalExcludedFiles = 0;
+    const outputFiles = [];
+    for (const [index, item] of expandedRecipe.entries()) {
+        console.log(`\nStep ${index + 1}: ${item.title || `Untitled Step ${index + 1}`}`);
+        // Resolve paths and options for this item
+        const itemOut = cliOutFile || item.out || baseOptions.outFile;
+        const outputFile = resolveOutputPath(itemOut, cliBaseDir, item._importBaseDir, recipeBaseDir, resolveRecipePath(recipePath));
+        const itemTypes = item.type ? parseCommaSeparated(item.type) : baseOptions.types;
+        const itemLanguages = item.language ? parseCommaSeparated(item.language) : baseOptions.languages;
+        let combinedAttrFilters = [...baseOptions.attrFilters];
+        if (item.filters) {
+            const itemAttrFilters = convertFiltersToAttrFilters(item.filters);
+            combinedAttrFilters = combinedAttrFilters.concat(itemAttrFilters);
+        }
+        const itemSrcDir = resolveItemSrcDir(cliSrc, item.src, item._importSrc);
+        console.log(`   📂 Source: ${itemSrcDir}`);
+        console.log(`   🔍 Filters: type=${itemTypes?.join(',') || '(none)'}, language=${itemLanguages?.join(',') || '(none)'}`);
+        if (combinedAttrFilters.length > 0) {
+            console.log(`             attributes=${combinedAttrFilters.join(', ')}`);
+        }
+        try {
+            const { allFiles, filteredFiles } = await loadAndFilterFilesWithDetails(itemSrcDir, itemTypes, itemLanguages, combinedAttrFilters, debugLogger);
+            totalInputFiles += allFiles.length;
+            totalIncludedFiles += filteredFiles.length;
+            totalExcludedFiles += (allFiles.length - filteredFiles.length);
+            console.log(`\n   📄 Input Files Analysis:`);
+            if (filteredFiles.length > 0) {
+                console.log(`      ✓ INCLUDED (${filteredFiles.length} files):`);
+                filteredFiles.forEach(file => {
+                    console.log(`        - ${file.path}`);
+                });
+            }
+            const excludedFiles = allFiles.filter(f => !filteredFiles.includes(f));
+            // Note: Individual excluded files are not displayed to keep output concise
+            // Only the count is shown in the summary below
+            console.log(`\n   📝 Output: ${outputFile}`);
+            if (!outputFiles.includes(outputFile)) {
+                outputFiles.push(outputFile);
+            }
+        }
+        catch (error) {
+            console.log(`   ❌ Error scanning files: ${error instanceof Error ? error.message : String(error)}`);
+        }
+    }
+    console.log(`\n📈 Overall Summary:`);
+    console.log(`   - Total steps: ${expandedRecipe.length}`);
+    console.log(`   - Total input files: ${totalInputFiles} (${totalIncludedFiles} included, ${totalExcludedFiles} excluded)`);
+    console.log(`   - Total output files: ${outputFiles.length}`);
+    console.log(`\n⚠️  Dry-run mode: No files will be written`);
+}
+/**
+ * Formats file size in a human-readable format
+ */
+function formatFileSize(sizeInBytes) {
+    if (sizeInBytes < 1024)
+        return `${sizeInBytes}B`;
+    if (sizeInBytes < 1024 * 1024)
+        return `${(sizeInBytes / 1024).toFixed(1)}KB`;
+    return `${(sizeInBytes / (1024 * 1024)).toFixed(1)}MB`;
+}
+/**
+ * Displays dry-run preview for single extraction
+ */
+function displayDryRunPreview(srcDir, outFile, allFiles, filteredFiles, types, languages, attrFilters = [], verbose = false) {
+    console.log('=== Extract Command Dry-Run Preview ===\n');
+    console.log(`📂 Source Directory: ${srcDir}`);
+    console.log('🔍 Filters Applied:');
+    console.log(`   - Type: ${types?.length ? types.join(', ') : '(none)'}`);
+    console.log(`   - Language: ${languages?.length ? languages.join(', ') : '(none)'}`);
+    console.log(`   - Attributes: ${attrFilters.length ? attrFilters.join(', ') : '(none)'}\n`);
+    console.log('📄 Input Files Analysis:');
+    if (filteredFiles.length > 0) {
+        console.log(`   ✓ INCLUDED (${filteredFiles.length} files):`);
+        filteredFiles.forEach(file => {
+            const attrs = Object.entries(file.attrs)
+                .filter(([key]) => key !== 'content')
+                .map(([key, value]) => `${key}: ${Array.isArray(value) ? value.join(',') : value}`)
+                .join(', ');
+            console.log(`     - ${file.path}`);
+            if (verbose && attrs) {
+                console.log(`       → ${attrs}`);
+            }
+            else if (attrs) {
+                console.log(`       → ${attrs}`);
+            }
+        });
+    }
+    const excludedFiles = allFiles.filter(f => !filteredFiles.includes(f));
+    // Note: Individual excluded files are not displayed to keep output concise
+    // Only the count is shown in the summary below
+    const totalSize = filteredFiles.reduce((sum, f) => sum + f.content.length, 0);
+    console.log(`\n📈 Processing Summary:`);
+    console.log(`   - Total files scanned: ${allFiles.length}`);
+    console.log(`   - Files matching filters: ${filteredFiles.length}`);
+    console.log(`   - Files excluded: ${excludedFiles.length}`);
+    console.log(`\n📝 Output Files:`);
+    console.log(`   → ${outFile}`);
+    console.log(`     └─ Will merge ${filteredFiles.length} input files (estimated size: ~${formatFileSize(totalSize)})`);
+    console.log(`\n⚠️  Dry-run mode: No files will be written`);
+}
 async function loadAndFilterFiles(srcDir, types, languages, attrFilters = [], debugLogger) {
     debugLogger?.log(`Starting file scan in directory: ${srcDir}`);
     debugLogger?.time('MarkdownFileScanner.parseMarkdownFiles');
@@ -18391,6 +18507,37 @@ async function loadAndFilterFiles(srcDir, types, languages, attrFilters = [], de
     }
     return filtered;
 }
+/**
+ * Extended version of loadAndFilterFiles that returns both all files and filtered files
+ * Used for dry-run mode to show exclusion details
+ */
+async function loadAndFilterFilesWithDetails(srcDir, types, languages, attrFilters = [], debugLogger) {
+    debugLogger?.log(`Starting file scan in directory: ${srcDir}`);
+    debugLogger?.time('MarkdownFileScanner.parseMarkdownFiles');
+    const files = await MarkdownFileScanner.parseMarkdownFiles(srcDir);
+    debugLogger?.timeEnd('MarkdownFileScanner.parseMarkdownFiles');
+    debugLogger?.log(`Total markdown files found: ${files.length}`);
+    if (debugLogger?.isEnabled) {
+        debugLogger.log('Files discovered:');
+        files.forEach((file, index) => {
+            debugLogger.log(`  ${index + 1}. ${file.path}`);
+            debugLogger.log(`     Frontmatter attributes:`, Object.keys(file.attrs));
+        });
+    }
+    debugLogger?.time('File filtering');
+    const filtered = filterFiles(files, { types, languages, attrFilters });
+    debugLogger?.timeEnd('File filtering');
+    debugLogger?.log(`Files after filtering: ${filtered.length}`);
+    if (debugLogger?.isEnabled && filtered.length !== files.length) {
+        const excludedCount = files.length - filtered.length;
+        debugLogger.log(`Excluded ${excludedCount} files due to filtering`);
+        const excludedFiles = files.filter(f => !filtered.includes(f));
+        excludedFiles.forEach(file => {
+            debugLogger.log(`  Excluded: ${file.path} (attributes: ${JSON.stringify(file.attrs)})`);
+        });
+    }
+    return { allFiles: files, filteredFiles: filtered };
+}
 /**
  * Handles content mode processing (append/prepend/overwrite)
  */
@@ -18458,7 +18605,7 @@ function applyTemplateToObject(obj, templateOptions, templateEngine) {
 }
 async function processSingle(options, debugLogger) {
     CliOptionValidator.validateExtractOptions(options);
-    const { srcDir, outFile, types, languages, attrFilters, title, mode, attr, vars, envFile } = options;
+    const { srcDir, outFile, types, languages, attrFilters, title, mode, attr, vars, envFile, dryRun } = options;
     // Resolve template variables first
     const templateEngine = new TemplateEngine();
     const variableResolver = new VariableResolver();
@@ -18483,6 +18630,17 @@ async function processSingle(options, debugLogger) {
     debugLogger.time('File scanning and filtering');
     debugLogger.log(`Scanning directory: ${srcDir}`);
     debugLogger.log('Applied filters:', { types, languages, attrFilters });
+    // In dry-run mode, we need both all files and filtered files to show exclusion details
+    if (dryRun) {
+        const { allFiles, filteredFiles } = await loadAndFilterFilesWithDetails(srcDir, types, languages, attrFilters, debugLogger);
+        debugLogger.timeEnd('File scanning and filtering');
+        debugLogger.log(`Found ${filteredFiles.length} files after filtering`);
+        // Check if verbose mode is enabled (via debug flag)
+        const verbose = debugLogger.isEnabled;
+        // Display dry-run preview and exit
+        displayDryRunPreview(srcDir, outFile, allFiles, filteredFiles, types, languages, attrFilters, verbose);
+        return;
+    }
     const filtered = await loadAndFilterFiles(srcDir, types, languages, attrFilters, debugLogger);
     debugLogger.timeEnd('File scanning and filtering');
     debugLogger.log(`Found ${filtered.length} files after filtering`);
@@ -18675,6 +18833,7 @@ async function handleExtractCommand(options) {
         debug: isDebugMode,
         vars: options.vars,
         envFile: options.envFile,
+        dryRun: options.dryRun,
     };
     debugLogger.log('Resolved extract options:', extractOptions);
     if (options.recipe && options.recipe.length > 0) {
@@ -18871,6 +19030,11 @@ async function processRecipe(recipePath, baseOptions, contentTracker, debugLogge
         const expandedRecipe = await expandRecipeImports(data.recipe, resolvedPath, debugLogger);
         debugLogger?.timeEnd('Recipe import expansion');
         debugLogger?.log(`After import expansion: ${expandedRecipe.length} items`);
+        // If dry-run mode, display preview and exit
+        if (baseOptions.dryRun) {
+            await displayRecipeDryRunPreview(recipePath, data, expandedRecipe, baseOptions, debugLogger, cliBaseDir, cliOutFile, cliSrc);
+            return;
+        }
         // Initialize local tracker if not provided (for single recipe mode)
         const localTracker = contentTracker || new ContentTracker();
         for (const [index, item] of expandedRecipe.entries()) {
@@ -18983,6 +19147,7 @@ async function processRecipe(recipePath, baseOptions, contentTracker, debugLogge
                 debug: baseOptions.debug,
                 vars: itemVars,
                 envFile: envFile,
+                dryRun: baseOptions.dryRun,
             };
             debugLogger?.time(`Processing single extraction for item ${index + 1}`);
             await processSingle(options, debugLogger || new DebugLogger(false));

package/dist/optionValidator.d.ts

@@ -15,6 +15,7 @@ export interface ExtractOptions {
     debug?: boolean;
     vars?: string;
     envFile?: string;
+    dryRun?: boolean;
 }
 export interface StatsOptions {
     srcDir: string;

package/dist/optionValidator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"optionValidator.d.ts","sourceRoot":"","sources":["../src/optionValidator.ts"],"names":[],"mappings":"AAAA,oBAAY,SAAS;IACnB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,SAAS,cAAc;CACxB;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,SAAS,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAIpC;WAEY,sBAAsB,CAAC,OAAO,EAAE,cAAc,GAAG,IAAI;WAYrD,oBAAoB,CAAC,OAAO,EAAE,YAAY,GAAG,IAAI;CAKhE"}
+{"version":3,"file":"optionValidator.d.ts","sourceRoot":"","sources":["../src/optionValidator.ts"],"names":[],"mappings":"AAAA,oBAAY,SAAS;IACnB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,SAAS,cAAc;CACxB;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,SAAS,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAIpC;WAEY,sBAAsB,CAAC,OAAO,EAAE,cAAc,GAAG,IAAI;WAYrD,oBAAoB,CAAC,OAAO,EAAE,YAAY,GAAG,IAAI;CAKhE"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aramassa/ai-rules",
-  "version": "0.3.4",
+  "version": "0.4.0",
   "description": "This repository collects guidelines and instructions for developing AI agents. It contains documents covering communication rules, coding standards, testing strategies, and general operational practices.",
   "workspaces": [
     "packages/extract",