msfs-layout-generator 0.3.3 → 0.3.5

package/dist/cli.js

@@ -84,6 +84,8 @@ program
     .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')
+    .option('--watch-debounce <ms>', 'Debounce delay in watch mode (default: 750ms)', '750')
+    .option('--watch-interval <ms>', 'Polling interval in watch mode when polling is used (default: 100)', '100')
     .action(async (directories, options) => {
     await handleAction(directories, options);
 })
@@ -244,8 +246,11 @@ async function handleWatchMode(dir, options) {
         }
         process.exit(1);
     }
+    const debounceMs = Number.parseInt(watchDebounce ?? '750', 10);
+    const intervalMs = Number.parseInt(watchInterval ?? '100', 10);
     let debounceTimer;
     let isProcessing = false;
+    let hasPendingChanges = false;
     let changeCount = 0;
     const watcher = chokidar_1.default.watch(fullPath, {
         ignored: [
@@ -254,39 +259,46 @@ async function handleWatchMode(dir, options) {
         ],
         ignoreInitial: true,
         persistent: true,
-        interval: parseInt(watchInterval),
+        interval: Number.isFinite(intervalMs) ? intervalMs : 100,
         depth: 99
     });
-    const processChanges = async () => {
+    const processQueuedChanges = async () => {
         if (isProcessing) {
-            if (debug) {
-                logger.dim('Skipping - already processing');
-            }
+            // Keep a rerun request so events arriving during a write/copy are not lost.
+            hasPendingChanges = true;
             return;
         }
-        clearTimeout(debounceTimer);
-        debounceTimer = setTimeout(async () => {
-            isProcessing = true;
-            changeCount++;
-            try {
+        isProcessing = true;
+        try {
+            do {
+                hasPendingChanges = false;
+                changeCount++;
                 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);
-                    }
+            } while (hasPendingChanges);
+        }
+        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));
+        }
+        finally {
+            isProcessing = false;
+        }
+    };
+    const scheduleProcessing = () => {
+        if (debounceTimer) {
+            clearTimeout(debounceTimer);
+        }
+        debounceTimer = setTimeout(() => {
+            void processQueuedChanges();
+        }, Number.isFinite(debounceMs) ? debounceMs : 750);
     };
     const timestamp = new Date().toLocaleTimeString();
     watcher
@@ -294,31 +306,31 @@ async function handleWatchMode(dir, options) {
         if (!quiet) {
             logger.dim(`[${timestamp}] File added: ${path.relative(fullPath, filePath)}`);
         }
-        processChanges();
+        scheduleProcessing();
     })
         .on('change', (filePath) => {
         if (!quiet) {
             logger.dim(`[${timestamp}] File changed: ${path.relative(fullPath, filePath)}`);
         }
-        processChanges();
+        scheduleProcessing();
     })
         .on('unlink', (filePath) => {
         if (!quiet) {
             logger.dim(`[${timestamp}] File removed: ${path.relative(fullPath, filePath)}`);
         }
-        processChanges();
+        scheduleProcessing();
     })
         .on('addDir', (dirPath) => {
         if (!quiet) {
             logger.dim(`[${timestamp}] Directory added: ${path.relative(fullPath, dirPath)}`);
         }
-        processChanges();
+        scheduleProcessing();
     })
         .on('unlinkDir', (dirPath) => {
         if (!quiet) {
             logger.dim(`[${timestamp}] Directory removed: ${path.relative(fullPath, dirPath)}`);
         }
-        processChanges();
+        scheduleProcessing();
     })
         .on('error', (error) => {
         if (error instanceof Error) {

package/dist/index.d.ts

@@ -2,8 +2,8 @@ import { processLayout } from "./utils/processLayout";
 /**
  * Process an MSFS package directory to generate/update layout.json (simple API).
  *
- * This is a convenience wrapper around {@link processLayout} that uses default
- * options and throws on errors. For more control, use {@link processLayout} directly.
+ * This is a convenience wrapper around {@link processLayout} that throws on errors.
+ * You can pass the same processing options except `returnResult`.
  *
  * @param packageDir - Path to the MSFS package directory (must contain manifest.json)
  * @returns Promise that resolves when layout.json has been generated
@@ -16,6 +16,10 @@ import { processLayout } from "./utils/processLayout";
  * await generateLayout("F:\\fs20\\Community\\my-package");
  *
  * @example
+ * // Overwrite existing layout.json
+ * await generateLayout("./my-package", { force: true });
+ *
+ * @example
  * // With error handling
  * try {
  *   await generateLayout("./my-package");
@@ -24,6 +28,6 @@ import { processLayout } from "./utils/processLayout";
  *   console.error("Failed:", error.message);
  * }
  */
-export declare const generateLayout: (layoutPath: string) => Promise<void>;
+export declare const generateLayout: (packageDir: string, options?: Omit<import("./types").ProcessOptions, "returnResult">) => Promise<void>;
 export { processLayout };
 export type { Content, Layout, Manifest, ProcessOptions, ProcessResult } from "./types";

package/dist/index.js

@@ -6,8 +6,8 @@ Object.defineProperty(exports, "processLayout", { enumerable: true, get: functio
 /**
  * Process an MSFS package directory to generate/update layout.json (simple API).
  *
- * This is a convenience wrapper around {@link processLayout} that uses default
- * options and throws on errors. For more control, use {@link processLayout} directly.
+ * This is a convenience wrapper around {@link processLayout} that throws on errors.
+ * You can pass the same processing options except `returnResult`.
  *
  * @param packageDir - Path to the MSFS package directory (must contain manifest.json)
  * @returns Promise that resolves when layout.json has been generated
@@ -20,6 +20,10 @@ Object.defineProperty(exports, "processLayout", { enumerable: true, get: functio
  * await generateLayout("F:\\fs20\\Community\\my-package");
  *
  * @example
+ * // Overwrite existing layout.json
+ * await generateLayout("./my-package", { force: true });
+ *
+ * @example
  * // With error handling
  * try {
  *   await generateLayout("./my-package");

package/dist/utils/getAllFiles.js

@@ -41,22 +41,31 @@ const getAllFiles = async (dirPath) => {
     const files = [];
     async function readDirectory(currentPath) {
         try {
-            for (const item of await (0, promises_1.readdir)(currentPath)) {
-                const itemPath = path.join(currentPath, item);
-                const receivedFile = await (0, promises_1.stat)(itemPath);
-                if (receivedFile.isDirectory()) {
+            const directs = await (0, promises_1.readdir)(currentPath, { withFileTypes: true });
+            for (const dirent of directs) {
+                const itemPath = path.join(currentPath, dirent.name);
+                if (dirent.isDirectory()) {
                     await readDirectory(itemPath);
                 }
-                else {
+                else if (dirent.isFile()) {
                     files.push(itemPath);
                 }
+                else if (dirent.isSymbolicLink()) {
+                    const stats = await (0, promises_1.stat)(itemPath);
+                    if (stats.isDirectory()) {
+                        await readDirectory(itemPath);
+                    }
+                    else {
+                        files.push(itemPath);
+                    }
+                }
             }
         }
         catch (e) {
             if (e instanceof Error) {
-                throw new _errors_1.ReadingDirError(`Failed to read directory ${path}: ${e.message}.`);
+                throw new _errors_1.ReadingDirError(`Failed to read directory ${currentPath}: ${e.message}.`);
             }
-            throw new _errors_1.ReadingDirError(`Failed to read directory. Path: ${path}`);
+            throw new _errors_1.ReadingDirError(`Failed to read directory. Path: ${currentPath}`);
         }
     }
     await readDirectory(dirPath);

package/dist/utils/processLayout.d.ts

@@ -42,5 +42,5 @@ import { ProcessOptions, ProcessResult } from "../types";
  * });
  */
 export declare const processLayout: (packageDir: string, options?: ProcessOptions) => Promise<void | ProcessResult>;
-export declare const doProcessLayoutFile: (layoutPath: string) => Promise<void>;
+export declare const doProcessLayoutFile: (packageDir: string, options?: Omit<ProcessOptions, "returnResult">) => Promise<void>;
 export declare const doProcessLayoutFileCli: (packageDir: string, options?: Omit<ProcessOptions, "returnResult">) => Promise<ProcessResult>;

package/dist/utils/processLayout.js

@@ -202,15 +202,16 @@ const processLayout = async (packageDir, options = {}) => {
             throw new Error(error);
         }
         for (const file of allFiles) {
-            // Check for long file paths (Windows limitation)
-            if (file.length > 259) {
+            const relativePath = path.relative(packageDir, file).split(path.sep).join('/');
+            // Windows MAX_PATH checks should only be enforced on Windows hosts.
+            if (process.platform === 'win32' && file.length > 259) {
                 hasLongPath = true;
+                excludedCount++;
                 if (debug) {
                     log(`Skipping long path: ${file}`, 'info');
                 }
                 continue;
             }
-            const relativePath = path.relative(packageDir, file).split(path.sep).join('/');
             const isExcluded = (0, doExcludeFile_1.doExcludeFile)(relativePath);
             try {
                 const stats = await (0, promises_1.stat)(file);
@@ -230,9 +231,8 @@ const processLayout = async (packageDir, options = {}) => {
                 layout.content.push(content);
             }
             catch (error) {
-                if (debug) {
-                    log(`Error processing file ${file}: ${error.message}`, 'info');
-                }
+                const msg = `Error processing file ${file}: ${error.message}`;
+                log(msg, debug ? 'info' : 'warn');
                 excludedCount++;
             }
         }
@@ -309,7 +309,7 @@ const processLayout = async (packageDir, options = {}) => {
     }
 };
 exports.processLayout = processLayout;
-const doProcessLayoutFile = (layoutPath) => (0, exports.processLayout)(layoutPath, { returnResult: false });
+const doProcessLayoutFile = (packageDir, options = {}) => (0, exports.processLayout)(packageDir, { ...options, returnResult: false });
 exports.doProcessLayoutFile = doProcessLayoutFile;
 const doProcessLayoutFileCli = (packageDir, options = {}) => (0, exports.processLayout)(packageDir, { ...options, returnResult: true });
 exports.doProcessLayoutFileCli = doProcessLayoutFileCli;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "msfs-layout-generator",
-  "version": "0.3.3",
+  "version": "0.3.5",
   "description": "Generate layout.json for MSFS community packages",
   "repository": {
     "type": "git",