@magentrix-corp/magentrix-cli 1.3.16 → 1.3.17

package/utils/iris/validator.js

@@ -1,281 +1,281 @@
-import { existsSync, readdirSync, statSync } from 'node:fs';
-import path from 'node:path';
-
-/**
- * Required file patterns for a valid Iris build.
- */
-const REQUIRED_FILES = {
-    remoteEntry: {
-        pattern: /^remoteEntry\.js$/,
-        location: 'root',
-        description: 'remoteEntry.js (required at dist root)'
-    },
-    hostInit: {
-        pattern: /^hostInit.*\.js$/,
-        location: 'assets',
-        description: 'assets/hostInit*.js (required in assets folder)'
-    },
-    main: {
-        pattern: /^main.*\.js$/,
-        location: 'assets',
-        description: 'assets/main*.js (required in assets folder)'
-    },
-    index: {
-        pattern: /^index.*\.js$/,
-        location: 'assets',
-        description: 'assets/index*.js (required in assets folder)'
-    }
-};
-
-/**
- * Validate that a build output directory contains all required Iris files.
- *
- * @param {string} distPath - Path to the build output directory (e.g., ./dist)
- * @returns {{
- *   valid: boolean,
- *   errors: string[],
- *   warnings: string[],
- *   files: {
- *     remoteEntry: string | null,
- *     hostInit: string | null,
- *     main: string | null,
- *     index: string | null
- *   },
- *   assetsPath: string | null
- * }}
- */
-export function validateIrisBuild(distPath) {
-    const result = {
-        valid: true,
-        errors: [],
-        warnings: [],
-        files: {
-            remoteEntry: null,
-            hostInit: null,
-            main: null,
-            index: null
-        },
-        assetsPath: null
-    };
-
-    // Check if dist path exists
-    if (!existsSync(distPath)) {
-        result.valid = false;
-        result.errors.push(`Build output directory not found: ${distPath}`);
-        return result;
-    }
-
-    // Check if it's a directory
-    const distStat = statSync(distPath);
-    if (!distStat.isDirectory()) {
-        result.valid = false;
-        result.errors.push(`Build output path is not a directory: ${distPath}`);
-        return result;
-    }
-
-    // Get root files
-    let rootFiles;
-    try {
-        rootFiles = readdirSync(distPath);
-    } catch (err) {
-        result.valid = false;
-        result.errors.push(`Failed to read build directory: ${err.message}`);
-        return result;
-    }
-
-    // Check for remoteEntry.js in root
-    const remoteEntryFile = rootFiles.find(f => REQUIRED_FILES.remoteEntry.pattern.test(f));
-    if (remoteEntryFile) {
-        result.files.remoteEntry = path.join(distPath, remoteEntryFile);
-    } else {
-        result.valid = false;
-        result.errors.push(REQUIRED_FILES.remoteEntry.description);
-    }
-
-    // Check for assets directory
-    const assetsDir = rootFiles.find(f => f.toLowerCase() === 'assets');
-    if (!assetsDir) {
-        result.valid = false;
-        result.errors.push('assets/ directory not found in build output');
-        return result;
-    }
-
-    const assetsPath = path.join(distPath, assetsDir);
-    result.assetsPath = assetsPath;
-
-    // Check if assets is a directory
-    const assetsStat = statSync(assetsPath);
-    if (!assetsStat.isDirectory()) {
-        result.valid = false;
-        result.errors.push('assets is not a directory');
-        return result;
-    }
-
-    // Get assets files
-    let assetsFiles;
-    try {
-        assetsFiles = readdirSync(assetsPath);
-    } catch (err) {
-        result.valid = false;
-        result.errors.push(`Failed to read assets directory: ${err.message}`);
-        return result;
-    }
-
-    // Check for required files in assets
-    const hostInitFile = assetsFiles.find(f => REQUIRED_FILES.hostInit.pattern.test(f));
-    if (hostInitFile) {
-        result.files.hostInit = path.join(assetsPath, hostInitFile);
-    } else {
-        result.valid = false;
-        result.errors.push(REQUIRED_FILES.hostInit.description);
-    }
-
-    const mainFile = assetsFiles.find(f => REQUIRED_FILES.main.pattern.test(f));
-    if (mainFile) {
-        result.files.main = path.join(assetsPath, mainFile);
-    } else {
-        result.valid = false;
-        result.errors.push(REQUIRED_FILES.main.description);
-    }
-
-    const indexFile = assetsFiles.find(f => REQUIRED_FILES.index.pattern.test(f));
-    if (indexFile) {
-        result.files.index = path.join(assetsPath, indexFile);
-    } else {
-        result.valid = false;
-        result.errors.push(REQUIRED_FILES.index.description);
-    }
-
-    // Warnings for potential issues
-    if (rootFiles.includes('index.html')) {
-        result.warnings.push('Found index.html in root - this file is typically not needed for Iris apps');
-    }
-
-    return result;
-}
-
-/**
- * Format validation errors for display to the user.
- *
- * @param {ReturnType<typeof validateIrisBuild>} validation - Validation result
- * @returns {string} - Formatted error message
- */
-export function formatValidationErrors(validation) {
-    const lines = [
-        'Invalid Build Output',
-        '────────────────────────────────────────────────────',
-        '',
-        'The build output is missing required Iris files.',
-        '',
-        'Status:'
-    ];
-
-    // Show status of each required file
-    const fileStatus = [
-        {
-            name: 'remoteEntry.js',
-            found: validation.files.remoteEntry !== null,
-            foundName: validation.files.remoteEntry ? path.basename(validation.files.remoteEntry) : null
-        },
-        {
-            name: 'assets/hostInit*.js',
-            found: validation.files.hostInit !== null,
-            foundName: validation.files.hostInit ? path.basename(validation.files.hostInit) : null
-        },
-        {
-            name: 'assets/main*.js',
-            found: validation.files.main !== null,
-            foundName: validation.files.main ? path.basename(validation.files.main) : null
-        },
-        {
-            name: 'assets/index*.js',
-            found: validation.files.index !== null,
-            foundName: validation.files.index ? path.basename(validation.files.index) : null
-        }
-    ];
-
-    for (const file of fileStatus) {
-        if (file.found) {
-            lines.push(`  ✓ ${file.name} (found: ${file.foundName})`);
-        } else {
-            lines.push(`  ✗ ${file.name}`);
-        }
-    }
-
-    lines.push('');
-    lines.push('Expected structure:');
-    lines.push('  dist/');
-    lines.push('  ├── remoteEntry.js');
-    lines.push('  └── assets/');
-    lines.push('      ├── hostInit-[hash].js');
-    lines.push('      ├── main-[hash].js');
-    lines.push('      └── index-[hash].js');
-    lines.push('');
-    lines.push('Make sure your Vue.js project is configured for Module Federation.');
-
-    if (validation.warnings.length > 0) {
-        lines.push('');
-        lines.push('Warnings:');
-        for (const warning of validation.warnings) {
-            lines.push(`  ⚠ ${warning}`);
-        }
-    }
-
-    return lines.join('\n');
-}
-
-/**
- * Get a summary of found files for successful validation.
- *
- * @param {ReturnType<typeof validateIrisBuild>} validation - Validation result
- * @returns {string} - Summary of found files
- */
-export function getValidationSummary(validation) {
-    const files = [];
-
-    if (validation.files.remoteEntry) {
-        files.push(`  • ${path.basename(validation.files.remoteEntry)}`);
-    }
-    if (validation.files.hostInit) {
-        files.push(`  • assets/${path.basename(validation.files.hostInit)}`);
-    }
-    if (validation.files.main) {
-        files.push(`  • assets/${path.basename(validation.files.main)}`);
-    }
-    if (validation.files.index) {
-        files.push(`  • assets/${path.basename(validation.files.index)}`);
-    }
-
-    return `Found ${files.length} required files:\n${files.join('\n')}`;
-}
-
-/**
- * Validate an Iris app folder (already staged, not a dist folder).
- * This is used to validate apps in src/iris-apps/<slug>/.
- *
- * @param {string} appPath - Path to the app folder
- * @returns {{valid: boolean, errors: string[], slug: string | null}}
- */
-export function validateIrisAppFolder(appPath) {
-    const result = {
-        valid: true,
-        errors: [],
-        slug: null
-    };
-
-    if (!existsSync(appPath)) {
-        result.valid = false;
-        result.errors.push(`App folder not found: ${appPath}`);
-        return result;
-    }
-
-    result.slug = path.basename(appPath);
-
-    // Use the same validation as build output
-    const validation = validateIrisBuild(appPath);
-
-    result.valid = validation.valid;
-    result.errors = validation.errors;
-
-    return result;
-}
+import { existsSync, readdirSync, statSync } from 'node:fs';
+import path from 'node:path';
+
+/**
+ * Required file patterns for a valid Iris build.
+ */
+const REQUIRED_FILES = {
+    remoteEntry: {
+        pattern: /^remoteEntry\.js$/,
+        location: 'root',
+        description: 'remoteEntry.js (required at dist root)'
+    },
+    hostInit: {
+        pattern: /^hostInit.*\.js$/,
+        location: 'assets',
+        description: 'assets/hostInit*.js (required in assets folder)'
+    },
+    main: {
+        pattern: /^main.*\.js$/,
+        location: 'assets',
+        description: 'assets/main*.js (required in assets folder)'
+    },
+    index: {
+        pattern: /^index.*\.js$/,
+        location: 'assets',
+        description: 'assets/index*.js (required in assets folder)'
+    }
+};
+
+/**
+ * Validate that a build output directory contains all required Iris files.
+ *
+ * @param {string} distPath - Path to the build output directory (e.g., ./dist)
+ * @returns {{
+ *   valid: boolean,
+ *   errors: string[],
+ *   warnings: string[],
+ *   files: {
+ *     remoteEntry: string | null,
+ *     hostInit: string | null,
+ *     main: string | null,
+ *     index: string | null
+ *   },
+ *   assetsPath: string | null
+ * }}
+ */
+export function validateIrisBuild(distPath) {
+    const result = {
+        valid: true,
+        errors: [],
+        warnings: [],
+        files: {
+            remoteEntry: null,
+            hostInit: null,
+            main: null,
+            index: null
+        },
+        assetsPath: null
+    };
+
+    // Check if dist path exists
+    if (!existsSync(distPath)) {
+        result.valid = false;
+        result.errors.push(`Build output directory not found: ${distPath}`);
+        return result;
+    }
+
+    // Check if it's a directory
+    const distStat = statSync(distPath);
+    if (!distStat.isDirectory()) {
+        result.valid = false;
+        result.errors.push(`Build output path is not a directory: ${distPath}`);
+        return result;
+    }
+
+    // Get root files
+    let rootFiles;
+    try {
+        rootFiles = readdirSync(distPath);
+    } catch (err) {
+        result.valid = false;
+        result.errors.push(`Failed to read build directory: ${err.message}`);
+        return result;
+    }
+
+    // Check for remoteEntry.js in root
+    const remoteEntryFile = rootFiles.find(f => REQUIRED_FILES.remoteEntry.pattern.test(f));
+    if (remoteEntryFile) {
+        result.files.remoteEntry = path.join(distPath, remoteEntryFile);
+    } else {
+        result.valid = false;
+        result.errors.push(REQUIRED_FILES.remoteEntry.description);
+    }
+
+    // Check for assets directory
+    const assetsDir = rootFiles.find(f => f.toLowerCase() === 'assets');
+    if (!assetsDir) {
+        result.valid = false;
+        result.errors.push('assets/ directory not found in build output');
+        return result;
+    }
+
+    const assetsPath = path.join(distPath, assetsDir);
+    result.assetsPath = assetsPath;
+
+    // Check if assets is a directory
+    const assetsStat = statSync(assetsPath);
+    if (!assetsStat.isDirectory()) {
+        result.valid = false;
+        result.errors.push('assets is not a directory');
+        return result;
+    }
+
+    // Get assets files
+    let assetsFiles;
+    try {
+        assetsFiles = readdirSync(assetsPath);
+    } catch (err) {
+        result.valid = false;
+        result.errors.push(`Failed to read assets directory: ${err.message}`);
+        return result;
+    }
+
+    // Check for required files in assets
+    const hostInitFile = assetsFiles.find(f => REQUIRED_FILES.hostInit.pattern.test(f));
+    if (hostInitFile) {
+        result.files.hostInit = path.join(assetsPath, hostInitFile);
+    } else {
+        result.valid = false;
+        result.errors.push(REQUIRED_FILES.hostInit.description);
+    }
+
+    const mainFile = assetsFiles.find(f => REQUIRED_FILES.main.pattern.test(f));
+    if (mainFile) {
+        result.files.main = path.join(assetsPath, mainFile);
+    } else {
+        result.valid = false;
+        result.errors.push(REQUIRED_FILES.main.description);
+    }
+
+    const indexFile = assetsFiles.find(f => REQUIRED_FILES.index.pattern.test(f));
+    if (indexFile) {
+        result.files.index = path.join(assetsPath, indexFile);
+    } else {
+        result.valid = false;
+        result.errors.push(REQUIRED_FILES.index.description);
+    }
+
+    // Warnings for potential issues
+    if (rootFiles.includes('index.html')) {
+        result.warnings.push('Found index.html in root - this file is typically not needed for Iris apps');
+    }
+
+    return result;
+}
+
+/**
+ * Format validation errors for display to the user.
+ *
+ * @param {ReturnType<typeof validateIrisBuild>} validation - Validation result
+ * @returns {string} - Formatted error message
+ */
+export function formatValidationErrors(validation) {
+    const lines = [
+        'Invalid Build Output',
+        '────────────────────────────────────────────────────',
+        '',
+        'The build output is missing required Iris files.',
+        '',
+        'Status:'
+    ];
+
+    // Show status of each required file
+    const fileStatus = [
+        {
+            name: 'remoteEntry.js',
+            found: validation.files.remoteEntry !== null,
+            foundName: validation.files.remoteEntry ? path.basename(validation.files.remoteEntry) : null
+        },
+        {
+            name: 'assets/hostInit*.js',
+            found: validation.files.hostInit !== null,
+            foundName: validation.files.hostInit ? path.basename(validation.files.hostInit) : null
+        },
+        {
+            name: 'assets/main*.js',
+            found: validation.files.main !== null,
+            foundName: validation.files.main ? path.basename(validation.files.main) : null
+        },
+        {
+            name: 'assets/index*.js',
+            found: validation.files.index !== null,
+            foundName: validation.files.index ? path.basename(validation.files.index) : null
+        }
+    ];
+
+    for (const file of fileStatus) {
+        if (file.found) {
+            lines.push(`  ✓ ${file.name} (found: ${file.foundName})`);
+        } else {
+            lines.push(`  ✗ ${file.name}`);
+        }
+    }
+
+    lines.push('');
+    lines.push('Expected structure:');
+    lines.push('  dist/');
+    lines.push('  ├── remoteEntry.js');
+    lines.push('  └── assets/');
+    lines.push('      ├── hostInit-[hash].js');
+    lines.push('      ├── main-[hash].js');
+    lines.push('      └── index-[hash].js');
+    lines.push('');
+    lines.push('Make sure your Vue.js project is configured for Module Federation.');
+
+    if (validation.warnings.length > 0) {
+        lines.push('');
+        lines.push('Warnings:');
+        for (const warning of validation.warnings) {
+            lines.push(`  ⚠ ${warning}`);
+        }
+    }
+
+    return lines.join('\n');
+}
+
+/**
+ * Get a summary of found files for successful validation.
+ *
+ * @param {ReturnType<typeof validateIrisBuild>} validation - Validation result
+ * @returns {string} - Summary of found files
+ */
+export function getValidationSummary(validation) {
+    const files = [];
+
+    if (validation.files.remoteEntry) {
+        files.push(`  • ${path.basename(validation.files.remoteEntry)}`);
+    }
+    if (validation.files.hostInit) {
+        files.push(`  • assets/${path.basename(validation.files.hostInit)}`);
+    }
+    if (validation.files.main) {
+        files.push(`  • assets/${path.basename(validation.files.main)}`);
+    }
+    if (validation.files.index) {
+        files.push(`  • assets/${path.basename(validation.files.index)}`);
+    }
+
+    return `Found ${files.length} required files:\n${files.join('\n')}`;
+}
+
+/**
+ * Validate an Iris app folder (already staged, not a dist folder).
+ * This is used to validate apps in src/iris-apps/<slug>/.
+ *
+ * @param {string} appPath - Path to the app folder
+ * @returns {{valid: boolean, errors: string[], slug: string | null}}
+ */
+export function validateIrisAppFolder(appPath) {
+    const result = {
+        valid: true,
+        errors: [],
+        slug: null
+    };
+
+    if (!existsSync(appPath)) {
+        result.valid = false;
+        result.errors.push(`App folder not found: ${appPath}`);
+        return result;
+    }
+
+    result.slug = path.basename(appPath);
+
+    // Use the same validation as build output
+    const validation = validateIrisBuild(appPath);
+
+    result.valid = validation.valid;
+    result.errors = validation.errors;
+
+    return result;
+}