msfs-layout-generator 0.2.1 → 0.3.0

package/README.MD

@@ -4,7 +4,8 @@
 ![downloads](https://img.shields.io/npm/d18m/msfs-layout-generator) ![npm](https://img.shields.io/npm/v/msfs-layout-generator) ![types](https://img.shields.io/npm/types/msfs-layout-generator) ![License](https://img.shields.io/badge/License-MIT-yellow.svg)
 
 A tool for **Microsoft Flight Simulator (MSFS)** developers to automatically generate and update `layout.json` files for their add-ons.
-  
+
+![terminal](.github/readme.png)
 ---  
 
 ## ✨ Features
@@ -12,6 +13,9 @@ A tool for **Microsoft Flight Simulator (MSFS)** developers to automatically gen
 - **Automatic Layout Generation**    
   Scans package directories and creates `layout.json` with file metadata
 
+- **Watch changes in Package Directory**    
+  Scans all changes in provided directory and updates `layout.json` accordingly
+
 - **Manifest Integration**    
   Automatically updates `total_package_size` in `manifest.json`
 - **Multiple Processing Modes**    

package/dist/cli.js

@@ -40,6 +40,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const commander_1 = require("commander");
 const chalk_1 = __importDefault(require("chalk"));
 const path = __importStar(require("path"));
+const fs = __importStar(require("fs"));
+const chokidar_1 = __importDefault(require("chokidar"));
 const processLayout_1 = require("./utils/processLayout");
 // Define the program
 const program = new commander_1.Command();
@@ -65,6 +67,10 @@ const logger = {
  * msfs-layout "package1" "package2" "package3"
  *
  * @example
+ * // Watch directory for changes
+ * msfs-layout "./my-package" --watch
+ *
+ * @example
  * // Show help
  * msfs-layout --help
  */
@@ -77,6 +83,7 @@ program
     .option('-q, --quiet', 'Suppress non-essential output')
     .option('-d, --debug', 'Enable debug logging for troubleshooting')
     .option('--no-manifest-check', 'Skip manifest.json existence check')
+    .option('-w, --watch', 'Watch directory for changes and regenerate automatically')
     .action(async (directories, options) => {
     await handleAction(directories, options);
 })
@@ -97,15 +104,20 @@ ${chalk_1.default.bold('Examples:')}
   ${chalk_1.default.dim('# Quiet mode - minimal output')}
   msfs-layout ./my-package --quiet
 
+  ${chalk_1.default.dim('# Watch directory for changes')}
+  msfs-layout ./my-package --watch
+
 ${chalk_1.default.bold('Notes:')}
   • Each directory should contain a ${chalk_1.default.cyan('manifest.json')} file
   • Creates/updates ${chalk_1.default.cyan('layout.json')} in the same directory
   • Automatically excludes ${chalk_1.default.yellow('_CVT_')} directories
   • Updates ${chalk_1.default.cyan('total_package_size')} in manifest.json
+  • Watch mode works with a ${chalk_1.default.yellow('single directory')} only
+  • Use ${chalk_1.default.cyan('Ctrl+C')} to exit watch mode
   `);
 // Handle the main action
 async function handleAction(directories, options) {
-    const { force, quiet, debug, manifestCheck } = options;
+    const { force, quiet, debug, manifestCheck, watch } = options;
     // Show header if not in quiet mode
     if (!quiet) {
         logger.header(`msfs-layout-generator`);
@@ -117,6 +129,16 @@ async function handleAction(directories, options) {
         logger.info('Use msfs-layout --help for usage information.');
         process.exit(1);
     }
+    if (watch && directories.length > 1) {
+        logger.error('Watch mode only supports a single directory.');
+        logger.info('Please specify only one directory when using --watch flag.');
+        process.exit(1);
+    }
+    // Handle watch mode
+    if (watch) {
+        await handleWatchMode(directories[0], { force, quiet, debug, manifestCheck });
+        return;
+    }
     const errors = [];
     const successes = [];
     let totalFilesProcessed = 0;
@@ -131,8 +153,8 @@ async function handleAction(directories, options) {
                 logger.dim(`  Debug: Resolved path: ${fullPath}`);
             }
             // Check if directory exists
-            if (!require('fs').existsSync(fullPath)) {
-                throw new Error(`Directory does not exist`);
+            if (!fs.existsSync(fullPath)) {
+                new Error(`Directory does not exist`);
             }
             // Run the main processing function
             const result = await (0, processLayout_1.doProcessLayoutFileCli)(fullPath, {
@@ -191,7 +213,134 @@ async function handleAction(directories, options) {
         process.exit(1);
     }
 }
-// Helper function to format file sizes
+async function handleWatchMode(dir, options) {
+    const { quiet, debug, manifestCheck, watchInterval, watchDebounce } = options;
+    const fullPath = path.resolve(dir);
+    if (!fs.existsSync(fullPath)) {
+        logger.error(`Directory does not exist: ${fullPath}`);
+        process.exit(1);
+    }
+    if (!quiet) {
+        logger.info(`Watching: ${chalk_1.default.underline(fullPath)}`);
+        logger.info(`Press ${chalk_1.default.yellow('Ctrl+C')} to stop watching`);
+        console.log();
+    }
+    if (!quiet) {
+        logger.info(`Running initial processing...`);
+    }
+    try {
+        await (0, processLayout_1.doProcessLayoutFileCli)(fullPath, {
+            force: true,
+            quiet,
+            debug,
+            checkManifest: manifestCheck
+        });
+        console.log();
+    }
+    catch (error) {
+        logger.error(`Initial processing failed: ${error.message}`);
+        if (debug && error.stack) {
+            logger.dim(error.stack);
+        }
+        process.exit(1);
+    }
+    let debounceTimer;
+    let isProcessing = false;
+    let changeCount = 0;
+    const watcher = chokidar_1.default.watch(fullPath, {
+        ignored: [
+            path.join(fullPath, 'layout.json'),
+            path.join(fullPath, 'manifest.json')
+        ],
+        ignoreInitial: true,
+        persistent: true,
+        interval: parseInt(watchInterval),
+        depth: 99
+    });
+    const processChanges = async () => {
+        if (isProcessing) {
+            if (debug) {
+                logger.dim('Skipping - already processing');
+            }
+            return;
+        }
+        clearTimeout(debounceTimer);
+        debounceTimer = setTimeout(async () => {
+            isProcessing = true;
+            changeCount++;
+            try {
+                await (0, processLayout_1.doProcessLayoutFileCli)(fullPath, {
+                    force: true,
+                    quiet: true
+                });
+            }
+            catch (error) {
+                const timestamp = new Date().toLocaleTimeString();
+                if (!quiet) {
+                    logger.error(`[${timestamp}] Failed to regenerate: ${error.message}`);
+                    if (debug && error.stack) {
+                        logger.dim(error.stack);
+                    }
+                }
+            }
+            finally {
+                isProcessing = false;
+            }
+        }, parseInt(watchDebounce));
+    };
+    const timestamp = new Date().toLocaleTimeString();
+    watcher
+        .on('add', (filePath) => {
+        if (!quiet) {
+            logger.dim(`[${timestamp}] File added: ${path.relative(fullPath, filePath)}`);
+        }
+        processChanges();
+    })
+        .on('change', (filePath) => {
+        if (!quiet) {
+            logger.dim(`[${timestamp}] File changed: ${path.relative(fullPath, filePath)}`);
+        }
+        processChanges();
+    })
+        .on('unlink', (filePath) => {
+        if (!quiet) {
+            logger.dim(`[${timestamp}] File removed: ${path.relative(fullPath, filePath)}`);
+        }
+        processChanges();
+    })
+        .on('addDir', (dirPath) => {
+        if (!quiet) {
+            logger.dim(`[${timestamp}] Directory added: ${path.relative(fullPath, dirPath)}`);
+        }
+        processChanges();
+    })
+        .on('unlinkDir', (dirPath) => {
+        if (!quiet) {
+            logger.dim(`[${timestamp}] Directory removed: ${path.relative(fullPath, dirPath)}`);
+        }
+        processChanges();
+    })
+        .on('error', (error) => {
+        if (error instanceof Error) {
+            logger.error(`Watcher error: ${error.message}`);
+        }
+    });
+    process.on('SIGINT', async () => {
+        if (!quiet) {
+            console.log();
+            logger.info('Stopping watch mode...');
+        }
+        await watcher.close();
+        if (!quiet) {
+            logger.success(`Watch mode stopped`);
+            logger.info(`Total changes processed: ${changeCount}`);
+        }
+        process.exit(0);
+    });
+    await new Promise(() => {
+        // This promise never resolves keeping the process alive
+    });
+}
 function formatFileSize(bytes) {
     if (bytes === 0)
         return '0 Bytes';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "msfs-layout-generator",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Generate layout.json for MSFS community packages",
   "repository": {
     "type": "git",
@@ -41,6 +41,7 @@
   },
   "dependencies": {
     "chalk": "^5.6.2",
+    "chokidar": "^5.0.0",
     "commander": "^14.0.2",
     "glob": "^13.0.0"
   }