msfs-layout-generator 0.1.2 → 0.1.3

package/dist/cli.js

@@ -40,7 +40,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const commander_1 = require("commander");
 const chalk_1 = __importDefault(require("chalk"));
 const path = __importStar(require("path"));
-const doProcessLayoutFileCli_1 = require("./utils/doProcessLayoutFileCli");
+const processLayout_1 = require("./utils/processLayout");
 // Define the program
 const program = new commander_1.Command();
 // Helper function for consistent logging
@@ -135,7 +135,7 @@ async function handleAction(directories, options) {
                 throw new Error(`Directory does not exist`);
             }
             // Run the main processing function
-            const result = await (0, doProcessLayoutFileCli_1.doProcessLayoutFileCli)(fullPath, {
+            const result = await (0, processLayout_1.doProcessLayoutFileCli)(fullPath, {
                 force,
                 quiet,
                 debug,

package/dist/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateLayout = void 0;
-const doProcessLayoutFile_1 = require("./utils/doProcessLayoutFile");
+const processLayout_1 = require("./utils/processLayout");
 /**
  * Process an MSFS package directory to generate/update layout.json
  *
@@ -27,4 +27,4 @@ const doProcessLayoutFile_1 = require("./utils/doProcessLayoutFile");
  *   console.error("Failed:", error.message);
  * }
  */
-exports.generateLayout = doProcessLayoutFile_1.doProcessLayoutFile;
+exports.generateLayout = processLayout_1.doProcessLayoutFile;

package/dist/types/index.d.ts

@@ -24,3 +24,4 @@
  * }
  */
 export declare const generateLayout: (layoutPath: string) => Promise<void>;
+export type { ProcessOptions, ProcessResult } from "@/index.d";

package/dist/types/utils/processLayout.d.ts

@@ -0,0 +1,12 @@
+import { ProcessOptions, ProcessResult } from "@/index.d";
+/**
+ * Unified function to process layout files for MSFS packages
+ * Can be used both programmatically and via CLI
+ *
+ * @param packageDir - Path to MSFS package directory
+ * @param options - Processing options
+ * @returns Promise<void> if returnResult=false, Promise<ProcessResult> if returnResult=true
+ */
+export declare const processLayout: (packageDir: string, options?: ProcessOptions) => Promise<void | ProcessResult>;
+export declare const doProcessLayoutFile: (layoutPath: string) => Promise<void>;
+export declare const doProcessLayoutFileCli: (packageDir: string, options?: Omit<ProcessOptions, "returnResult">) => Promise<ProcessResult>;

package/dist/utils/{doProcessLayoutFileCli.js → processLayout.js}

@@ -33,38 +33,46 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.doProcessLayoutFileCli = void 0;
+exports.doProcessLayoutFileCli = exports.doProcessLayoutFile = exports.processLayout = void 0;
 const path = __importStar(require("node:path"));
 const getAllFiles_1 = require("./getAllFiles");
 const doExcludeFile_1 = require("./doExcludeFile");
 const promises_1 = require("fs/promises");
 const getWindowsFileTime_1 = require("./getWindowsFileTime");
 const doUpdateManifest_1 = require("./doUpdateManifest");
-const doProcessLayoutFileCli = async (packageDir, options = {}) => {
-    const { force = false, quiet = false, debug = false, checkManifest = true, skipManifestUpdate = false } = options;
+/**
+ * Unified function to process layout files for MSFS packages
+ * Can be used both programmatically and via CLI
+ *
+ * @param packageDir - Path to MSFS package directory
+ * @param options - Processing options
+ * @returns Promise<void> if returnResult=false, Promise<ProcessResult> if returnResult=true
+ */
+const processLayout = async (packageDir, options = {}) => {
+    const { force = false, quiet = false, debug = false, checkManifest = true, skipManifestUpdate = false, returnResult = false // Default: behave like old doProcessLayoutFile
+     } = options;
     const layoutPathFile = path.join(packageDir, 'layout.json');
     const manifestPath = path.join(packageDir, 'manifest.json');
+    // Helper logging function
+    const log = (message, type = 'info') => {
+        if (quiet)
+            return;
+        const prefixes = {
+            info: 'ℹ',
+            warn: '⚠',
+            error: '✗',
+            success: '✓'
+        };
+        console.log(`${prefixes[type]} ${message}`);
+    };
     // Validate input directory exists
     try {
         await (0, promises_1.access)(packageDir, promises_1.constants.F_OK);
     }
     catch {
-        return {
-            fileCount: 0,
-            totalSize: 0,
-            layoutPath: layoutPathFile,
-            manifestPath,
-            skippedFiles: 0,
-            success: false,
-            message: `Directory does not exist: ${packageDir}`
-        };
-    }
-    // Check for manifest.json if required
-    if (checkManifest) {
-        try {
-            await (0, promises_1.access)(manifestPath, promises_1.constants.F_OK);
-        }
-        catch {
+        const error = `Directory does not exist: ${packageDir}`;
+        log(error, 'error');
+        if (returnResult) {
             return {
                 fileCount: 0,
                 totalSize: 0,
@@ -72,14 +80,54 @@ const doProcessLayoutFileCli = async (packageDir, options = {}) => {
                 manifestPath,
                 skippedFiles: 0,
                 success: false,
-                message: `manifest.json not found in ${packageDir}`
+                message: error
             };
         }
+        throw new Error(error);
+    }
+    // Check for manifest.json if required
+    if (checkManifest) {
+        try {
+            await (0, promises_1.access)(manifestPath, promises_1.constants.F_OK);
+        }
+        catch {
+            const error = `manifest.json not found in ${packageDir}`;
+            log(error, 'error');
+            if (returnResult) {
+                return {
+                    fileCount: 0,
+                    totalSize: 0,
+                    layoutPath: layoutPathFile,
+                    manifestPath,
+                    skippedFiles: 0,
+                    success: false,
+                    message: error
+                };
+            }
+            throw new Error(error);
+        }
     }
     // Check if layout.json already exists
+    let shouldProceed = true;
+    let skipReason = '';
     try {
         await (0, promises_1.access)(layoutPathFile, promises_1.constants.F_OK);
         if (!force) {
+            skipReason = 'layout.json already exists. Use --force to overwrite.';
+            shouldProceed = false;
+        }
+        else if (debug) {
+            log('layout.json exists, will overwrite due to --force flag', 'info');
+        }
+    }
+    catch {
+        // layout.json doesn't exist, that's fine
+        if (debug) {
+            log('No existing layout.json found, creating new one', 'info');
+        }
+    }
+    if (!shouldProceed) {
+        if (returnResult) {
             return {
                 fileCount: 0,
                 totalSize: 0,
@@ -87,45 +135,44 @@ const doProcessLayoutFileCli = async (packageDir, options = {}) => {
                 manifestPath,
                 skippedFiles: 0,
                 success: false,
-                message: `layout.json already exists. Use --force to overwrite.`
+                message: skipReason
             };
         }
-        if (debug && !quiet) {
-            console.log(`Debug: layout.json exists, will overwrite due to --force flag`);
-        }
-    }
-    catch {
-        // layout.json doesn't exist, that's fine
-        if (debug && !quiet) {
-            console.log(`Debug: No existing layout.json found, creating new one`);
-        }
+        log(skipReason, 'warn');
+        return;
     }
+    // Main processing logic
     let totalPackageSize = 0;
     const layout = { content: [] };
     let hasLongPath = false;
     let excludedCount = 0;
     try {
         const allFiles = await (0, getAllFiles_1.getAllFiles)(packageDir);
-        if (debug && !quiet) {
-            console.log(`Debug: Found ${allFiles.length} total files in ${packageDir}`);
+        if (debug) {
+            log(`Found ${allFiles.length} total files in ${packageDir}`, 'info');
         }
         if (allFiles.length === 0) {
-            return {
-                fileCount: 0,
-                totalSize: 0,
-                layoutPath: layoutPathFile,
-                manifestPath,
-                skippedFiles: 0,
-                success: false,
-                message: 'No files found in package directory'
-            };
+            const error = 'No files found in package directory';
+            log(error, 'error');
+            if (returnResult) {
+                return {
+                    fileCount: 0,
+                    totalSize: 0,
+                    layoutPath: layoutPathFile,
+                    manifestPath,
+                    skippedFiles: 0,
+                    success: false,
+                    message: error
+                };
+            }
+            throw new Error(error);
         }
         for (const file of allFiles) {
             // Check for long file paths (Windows limitation)
             if (file.length > 259) {
                 hasLongPath = true;
-                if (debug && !quiet) {
-                    console.log(`Debug: Skipping long path: ${file}`);
+                if (debug) {
+                    log(`Skipping long path: ${file}`, 'info');
                 }
                 continue;
             }
@@ -136,8 +183,8 @@ const doProcessLayoutFileCli = async (packageDir, options = {}) => {
                 totalPackageSize += stats.size;
                 if (isExcluded) {
                     excludedCount++;
-                    if (debug && !quiet) {
-                        console.log(`Debug: Excluding file: ${relativePath}`);
+                    if (debug) {
+                        log(`Excluding file: ${relativePath}`, 'info');
                     }
                     continue;
                 }
@@ -149,25 +196,30 @@ const doProcessLayoutFileCli = async (packageDir, options = {}) => {
                 layout.content.push(content);
             }
             catch (error) {
-                if (debug && !quiet) {
-                    console.log(`Debug: Error processing file ${file}: ${error.message}`);
+                if (debug) {
+                    log(`Error processing file ${file}: ${error.message}`, 'info');
                 }
                 excludedCount++;
             }
         }
-        if (hasLongPath && !quiet) {
-            console.log(`Warning: One or more file paths exceed 259 characters and were skipped.`);
+        if (hasLongPath) {
+            log('One or more file paths exceed 259 characters and were skipped.', 'warn');
         }
         if (layout.content.length === 0) {
-            return {
-                fileCount: 0,
-                totalSize: 0,
-                layoutPath: layoutPathFile,
-                manifestPath,
-                skippedFiles: excludedCount,
-                success: false,
-                message: 'No valid files to include in layout.json'
-            };
+            const error = 'No valid files to include in layout.json';
+            log(error, 'error');
+            if (returnResult) {
+                return {
+                    fileCount: 0,
+                    totalSize: 0,
+                    layoutPath: layoutPathFile,
+                    manifestPath,
+                    skippedFiles: excludedCount,
+                    success: false,
+                    message: error
+                };
+            }
+            throw new Error(error);
         }
         // Sort content by path for consistent output
         layout.content.sort((a, b) => a.path.localeCompare(b.path));
@@ -182,39 +234,48 @@ const doProcessLayoutFileCli = async (packageDir, options = {}) => {
             try {
                 await (0, promises_1.access)(manifestPath, promises_1.constants.F_OK);
                 await (0, doUpdateManifest_1.doUpdateManifest)(manifestPath, totalPackageSize);
-                if (debug && !quiet) {
-                    console.log(`Debug: Updated manifest.json with total_package_size`);
+                if (debug) {
+                    log('Updated manifest.json with total_package_size', 'info');
                 }
             }
             catch {
                 // manifest doesn't exist, skip
-                if (debug && !quiet) {
-                    console.log(`Debug: manifest.json not found, skipping update`);
+                if (debug) {
+                    log('manifest.json not found, skipping update', 'info');
                 }
             }
         }
-        if (!quiet) {
-            console.log(`Successfully updated layout.json with ${layout.content.length} files`);
+        log(`Successfully updated layout.json with ${layout.content.length} files`, 'success');
+        if (returnResult) {
+            return {
+                fileCount: layout.content.length,
+                totalSize: totalPackageSize,
+                layoutPath: layoutPathFile,
+                manifestPath,
+                skippedFiles: excludedCount,
+                success: true
+            };
         }
-        return {
-            fileCount: layout.content.length,
-            totalSize: totalPackageSize,
-            layoutPath: layoutPathFile,
-            manifestPath,
-            skippedFiles: excludedCount,
-            success: true
-        };
     }
     catch (error) {
-        return {
-            fileCount: 0,
-            totalSize: 0,
-            layoutPath: layoutPathFile,
-            manifestPath,
-            skippedFiles: excludedCount,
-            success: false,
-            message: `Error processing ${packageDir}: ${error.message}`
-        };
+        const errorMsg = `Error processing ${packageDir}: ${error.message}`;
+        log(errorMsg, 'error');
+        if (returnResult) {
+            return {
+                fileCount: 0,
+                totalSize: 0,
+                layoutPath: layoutPathFile,
+                manifestPath,
+                skippedFiles: excludedCount,
+                success: false,
+                message: errorMsg
+            };
+        }
+        throw error;
     }
 };
+exports.processLayout = processLayout;
+const doProcessLayoutFile = (layoutPath) => (0, exports.processLayout)(layoutPath, { 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.1.2",
+  "version": "0.1.3",
   "description": "Generate layout.json for MSFS community packages",
   "repository": {
     "type": "git",

package/dist/types/utils/doProcessLayoutFile.d.ts

@@ -1 +0,0 @@
-export declare const doProcessLayoutFile: (layoutPath: string) => Promise<void>;

package/dist/types/utils/doProcessLayoutFileCli.d.ts

@@ -1,17 +0,0 @@
-export interface ProcessOptions {
-    force?: boolean;
-    quiet?: boolean;
-    debug?: boolean;
-    checkManifest?: boolean;
-    skipManifestUpdate?: boolean;
-}
-export interface ProcessResult {
-    fileCount: number;
-    totalSize: number;
-    layoutPath: string;
-    manifestPath: string;
-    skippedFiles: number;
-    success: boolean;
-    message?: string;
-}
-export declare const doProcessLayoutFileCli: (packageDir: string, options?: ProcessOptions) => Promise<ProcessResult>;

package/dist/utils/doProcessLayoutFile.js

@@ -1,109 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.doProcessLayoutFile = void 0;
-const path = __importStar(require("node:path"));
-const getAllFiles_1 = require("./getAllFiles");
-const doExcludeFile_1 = require("./doExcludeFile");
-const promises_1 = require("fs/promises");
-const getWindowsFileTime_1 = require("./getWindowsFileTime");
-const doUpdateManifest_1 = require("./doUpdateManifest");
-const doProcessLayoutFile = async (layoutPath) => {
-    const layoutPathFile = path.join(layoutPath, 'layout.json');
-    const directory = await (0, promises_1.readdir)(layoutPath);
-    if (!directory.includes('layout.json')) {
-        console.log(`No layout.json is found in "${layoutPath}". A new layout will be created.`);
-        await (0, promises_1.writeFile)(layoutPathFile, "", 'utf8');
-    }
-    let totalPackageSize = 0;
-    const layout = { content: [] };
-    try {
-        const allFiles = await (0, getAllFiles_1.getAllFiles)(layoutPath);
-        let hasLongPath = false;
-        for (const file of allFiles) {
-            if (file.length > 259) {
-                hasLongPath = true;
-                continue;
-            }
-            const relativePath = path.relative(layoutPath, file).split(path.sep).join('/');
-            const isExcluded = (0, doExcludeFile_1.doExcludeFile)(relativePath);
-            try {
-                const stats = await (0, promises_1.stat)(file);
-                totalPackageSize += stats.size;
-                if (isExcluded) {
-                    continue;
-                }
-                const content = {
-                    path: relativePath,
-                    size: stats.size,
-                    date: (0, getWindowsFileTime_1.getWindowsFileTime)(stats.mtime)
-                };
-                layout.content.push(content);
-            }
-            catch (error) {
-                console.log(`Error processing file ${file}: ${error.message}`);
-            }
-        }
-        if (hasLongPath) {
-            console.log(`Warning: One or more file paths in the folder containing "${layoutPath}" are 260 characters or greater in length. Some files may have been skipped.`);
-        }
-        if (layout.content.length === 0) {
-            console.log(`No files were found in the folder containing "${layoutPath}". The layout.json will not be updated.`);
-            return;
-        }
-        // Sort content by path for consistent output
-        layout.content.sort((a, b) => a.path.localeCompare(b.path));
-        // Write layout.json with LF line endings
-        const json = JSON.stringify(layout, null, 2).replace(/\r\n/g, '\n');
-        await (0, promises_1.writeFile)(layoutPathFile, json, 'utf8');
-        // Add layout.json size to total
-        const layoutStats = await (0, promises_1.stat)(layoutPath);
-        totalPackageSize += layoutStats.size;
-        // Update manifest.json if it exists
-        const manifestPath = path.join(layoutPath, 'manifest.json');
-        try {
-            await (0, promises_1.access)(manifestPath, promises_1.constants.F_OK);
-            await (0, doUpdateManifest_1.doUpdateManifest)(manifestPath, totalPackageSize);
-        }
-        catch {
-            // manifest doesn't exist, skip
-        }
-        console.log(`Successfully updated ${layoutPath} with ${layout.content.length} files`);
-    }
-    catch (error) {
-        console.log(`Error processing ${layoutPathFile}: ${error.message}`);
-    }
-};
-exports.doProcessLayoutFile = doProcessLayoutFile;