@magentrix-corp/magentrix-cli 1.3.16 → 1.3.17

package/utils/logger.js

@@ -1,291 +1,291 @@
-import fs from 'fs';
-import path from 'path';
-import chalk from 'chalk';
-import Config from './config.js';
-import inquirer from 'inquirer';
-
-const config = new Config();
-
-/**
- * Logger utility for tracking errors, warnings, and operations during pull/publish.
- * Logs are stored in .magentrix/logs/ directory.
- */
-
-export class Logger {
-    constructor(operationName = 'operation') {
-        this.operationName = operationName;
-        this.logDir = '.magentrix/logs';
-        this.timestamp = new Date().toISOString().replace(/[:.]/g, '-').split('.')[0];
-        this.logFile = path.join(this.logDir, `${operationName}-${this.timestamp}.log`);
-        this.errors = [];
-        this.warnings = [];
-        this.infos = [];
-        this.loggingEnabled = null; // Will be determined on first write
-
-        // Check if logging is enabled in config
-        this.checkLoggingPreference();
-    }
-
-    /**
-     * Check user's logging preference from config
-     */
-    checkLoggingPreference() {
-        const preference = config.read('saveLogs', { global: true });
-
-        if (preference !== undefined && preference !== null) {
-            this.loggingEnabled = preference === true || preference === 'true';
-        }
-        // If undefined, we'll prompt on first write
-    }
-
-    /**
-     * Prompt user about logging preference (only once)
-     */
-    async promptLoggingPreference() {
-        console.log('');
-        console.log(chalk.cyan('📋 Log File Settings'));
-        console.log(chalk.gray('Magentrix CLI can save detailed operation logs for debugging.'));
-        console.log('');
-
-        const answer = await inquirer.prompt([
-            {
-                type: 'confirm',
-                name: 'saveLogs',
-                message: 'Would you like to save operation logs to files?',
-                default: true
-            }
-        ]);
-
-        this.loggingEnabled = answer.saveLogs;
-        config.save('saveLogs', answer.saveLogs, { global: true });
-
-        if (answer.saveLogs) {
-            console.log(chalk.green('✓ Logs will be saved to .magentrix/logs/'));
-        } else {
-            console.log(chalk.gray('Logs disabled. You can enable them anytime with: magentrix config set logs true'));
-        }
-        console.log('');
-    }
-
-    /**
-     * Initialize log file if logging is enabled
-     */
-    async initLogFile() {
-        if (this.loggingEnabled === null) {
-            // First time - prompt user
-            await this.promptLoggingPreference();
-        }
-
-        if (this.loggingEnabled) {
-            // Ensure log directory exists
-            if (!fs.existsSync(this.logDir)) {
-                fs.mkdirSync(this.logDir, { recursive: true });
-            }
-
-            // Initialize log file
-            this.writeToFile(`=== ${this.operationName.toUpperCase()} LOG ===`);
-            this.writeToFile(`Started: ${new Date().toISOString()}`);
-            this.writeToFile(`Working Directory: ${process.cwd()}`);
-            this.writeToFile('');
-        }
-    }
-
-    /**
-     * Write a line to the log file (internal method)
-     */
-    writeToFile(message) {
-        if (this.loggingEnabled) {
-            fs.appendFileSync(this.logFile, message + '\n');
-        }
-    }
-
-    /**
-     * Log an info message
-     */
-    info(message, details = null) {
-        const timestamp = new Date().toISOString();
-        const entry = { timestamp, level: 'INFO', message, details };
-        this.infos.push(entry);
-
-        this.writeToFile(`[${timestamp}] INFO: ${message}`);
-        if (details) {
-            this.writeToFile(`  Details: ${typeof details === 'object' ? JSON.stringify(details, null, 2) : details}`);
-        }
-    }
-
-    /**
-     * Log a warning message
-     */
-    warning(message, details = null) {
-        const timestamp = new Date().toISOString();
-        const entry = { timestamp, level: 'WARNING', message, details };
-        this.warnings.push(entry);
-
-        this.writeToFile(`[${timestamp}] WARNING: ${message}`);
-        if (details) {
-            this.writeToFile(`  Details: ${typeof details === 'object' ? JSON.stringify(details, null, 2) : details}`);
-        }
-    }
-
-    /**
-     * Log an error message
-     * @param {string} message - Error message
-     * @param {Error|null} error - Error object
-     * @param {object|null} details - Additional details
-     * @param {string|null} hint - Helpful hint for resolving the error
-     */
-    error(message, error = null, details = null, hint = null) {
-        const timestamp = new Date().toISOString();
-        const entry = {
-            timestamp,
-            level: 'ERROR',
-            message,
-            error: error ? error.toString() : null,
-            stack: error?.stack || null,
-            details,
-            hint
-        };
-        this.errors.push(entry);
-
-        this.writeToFile(`[${timestamp}] ERROR: ${message}`);
-        if (error) {
-            this.writeToFile(`  Error: ${error.toString()}`);
-            if (error.stack) {
-                this.writeToFile(`  Stack: ${error.stack}`);
-            }
-        }
-        if (details) {
-            this.writeToFile(`  Details: ${typeof details === 'object' ? JSON.stringify(details, null, 2) : details}`);
-        }
-    }
-
-    /**
-     * Get a summary of the log
-     */
-    getSummary() {
-        return {
-            errors: this.errors.length,
-            warnings: this.warnings.length,
-            infos: this.infos.length,
-            logFile: this.logFile
-        };
-    }
-
-    /**
-     * Get the most recent errors (for preview)
-     */
-    getRecentErrors(count = 3) {
-        return this.errors.slice(-count);
-    }
-
-    /**
-     * Get the most recent warnings (for preview)
-     */
-    getRecentWarnings(count = 3) {
-        return this.warnings.slice(-count);
-    }
-
-    /**
-     * Display a summary to the console
-     */
-    displaySummary() {
-        const summary = this.getSummary();
-
-        if (summary.errors > 0 || summary.warnings > 0) {
-            console.log('');
-            console.log(chalk.bold('Issues Summary:'));
-
-            if (summary.errors > 0) {
-                console.log(chalk.red(`  ✗ ${summary.errors} error(s)`));
-
-                // Show preview of recent errors
-                const recentErrors = this.getRecentErrors(3);
-                recentErrors.forEach((err, idx) => {
-                    console.log(chalk.red(`    ${idx + 1}. ${err.message}`));
-                    if (err.hint) {
-                        console.log(chalk.yellow(`       ${err.hint}`));
-                    }
-                });
-
-                if (summary.errors > 3) {
-                    console.log(chalk.gray(`    ... and ${summary.errors - 3} more`));
-                }
-            }
-
-            if (summary.warnings > 0) {
-                console.log(chalk.yellow(`  ⚠ ${summary.warnings} warning(s)`));
-
-                // Show preview of recent warnings
-                const recentWarnings = this.getRecentWarnings(2);
-                recentWarnings.forEach((warn, idx) => {
-                    console.log(chalk.yellow(`    ${idx + 1}. ${warn.message}`));
-                });
-
-                if (summary.warnings > 2) {
-                    console.log(chalk.gray(`    ... and ${summary.warnings - 2} more`));
-                }
-            }
-
-            // Only show log file path if logging is enabled
-            if (this.loggingEnabled) {
-                console.log('');
-                console.log(chalk.cyan(`📄 Full log: ${chalk.white(summary.logFile)}`));
-                console.log(chalk.gray(`   View with: cat ${summary.logFile}`));
-            }
-            console.log('');
-        }
-    }
-
-    /**
-     * Finalize the log file
-     */
-    close() {
-        this.writeToFile('');
-        this.writeToFile(`Completed: ${new Date().toISOString()}`);
-        this.writeToFile(`Summary: ${this.errors.length} errors, ${this.warnings.length} warnings, ${this.infos.length} info messages`);
-        this.writeToFile('=== END LOG ===');
-    }
-
-    /**
-     * Clean up old log files (keep only last N logs)
-     */
-    static cleanupOldLogs(keepCount = 10) {
-        const logDir = '.magentrix/logs';
-
-        if (!fs.existsSync(logDir)) {
-            return;
-        }
-
-        try {
-            const files = fs.readdirSync(logDir)
-                .filter(f => f.endsWith('.log'))
-                .map(f => ({
-                    name: f,
-                    path: path.join(logDir, f),
-                    time: fs.statSync(path.join(logDir, f)).mtime.getTime()
-                }))
-                .sort((a, b) => b.time - a.time); // Sort by newest first
-
-            // Delete files beyond keepCount
-            if (files.length > keepCount) {
-                const toDelete = files.slice(keepCount);
-                toDelete.forEach(file => {
-                    try {
-                        fs.unlinkSync(file.path);
-                    } catch (err) {
-                        // Ignore errors when deleting old logs
-                    }
-                });
-            }
-        } catch (err) {
-            // Ignore errors in cleanup
-        }
-    }
-}
-
-/**
- * Create a logger instance for an operation
- */
-export function createLogger(operationName) {
-    return new Logger(operationName);
-}
+import fs from 'fs';
+import path from 'path';
+import chalk from 'chalk';
+import Config from './config.js';
+import inquirer from 'inquirer';
+
+const config = new Config();
+
+/**
+ * Logger utility for tracking errors, warnings, and operations during pull/publish.
+ * Logs are stored in .magentrix/logs/ directory.
+ */
+
+export class Logger {
+    constructor(operationName = 'operation') {
+        this.operationName = operationName;
+        this.logDir = '.magentrix/logs';
+        this.timestamp = new Date().toISOString().replace(/[:.]/g, '-').split('.')[0];
+        this.logFile = path.join(this.logDir, `${operationName}-${this.timestamp}.log`);
+        this.errors = [];
+        this.warnings = [];
+        this.infos = [];
+        this.loggingEnabled = null; // Will be determined on first write
+
+        // Check if logging is enabled in config
+        this.checkLoggingPreference();
+    }
+
+    /**
+     * Check user's logging preference from config
+     */
+    checkLoggingPreference() {
+        const preference = config.read('saveLogs', { global: true });
+
+        if (preference !== undefined && preference !== null) {
+            this.loggingEnabled = preference === true || preference === 'true';
+        }
+        // If undefined, we'll prompt on first write
+    }
+
+    /**
+     * Prompt user about logging preference (only once)
+     */
+    async promptLoggingPreference() {
+        console.log('');
+        console.log(chalk.cyan('📋 Log File Settings'));
+        console.log(chalk.gray('Magentrix CLI can save detailed operation logs for debugging.'));
+        console.log('');
+
+        const answer = await inquirer.prompt([
+            {
+                type: 'confirm',
+                name: 'saveLogs',
+                message: 'Would you like to save operation logs to files?',
+                default: true
+            }
+        ]);
+
+        this.loggingEnabled = answer.saveLogs;
+        config.save('saveLogs', answer.saveLogs, { global: true });
+
+        if (answer.saveLogs) {
+            console.log(chalk.green('✓ Logs will be saved to .magentrix/logs/'));
+        } else {
+            console.log(chalk.gray('Logs disabled. You can enable them anytime with: magentrix config set logs true'));
+        }
+        console.log('');
+    }
+
+    /**
+     * Initialize log file if logging is enabled
+     */
+    async initLogFile() {
+        if (this.loggingEnabled === null) {
+            // First time - prompt user
+            await this.promptLoggingPreference();
+        }
+
+        if (this.loggingEnabled) {
+            // Ensure log directory exists
+            if (!fs.existsSync(this.logDir)) {
+                fs.mkdirSync(this.logDir, { recursive: true });
+            }
+
+            // Initialize log file
+            this.writeToFile(`=== ${this.operationName.toUpperCase()} LOG ===`);
+            this.writeToFile(`Started: ${new Date().toISOString()}`);
+            this.writeToFile(`Working Directory: ${process.cwd()}`);
+            this.writeToFile('');
+        }
+    }
+
+    /**
+     * Write a line to the log file (internal method)
+     */
+    writeToFile(message) {
+        if (this.loggingEnabled) {
+            fs.appendFileSync(this.logFile, message + '\n');
+        }
+    }
+
+    /**
+     * Log an info message
+     */
+    info(message, details = null) {
+        const timestamp = new Date().toISOString();
+        const entry = { timestamp, level: 'INFO', message, details };
+        this.infos.push(entry);
+
+        this.writeToFile(`[${timestamp}] INFO: ${message}`);
+        if (details) {
+            this.writeToFile(`  Details: ${typeof details === 'object' ? JSON.stringify(details, null, 2) : details}`);
+        }
+    }
+
+    /**
+     * Log a warning message
+     */
+    warning(message, details = null) {
+        const timestamp = new Date().toISOString();
+        const entry = { timestamp, level: 'WARNING', message, details };
+        this.warnings.push(entry);
+
+        this.writeToFile(`[${timestamp}] WARNING: ${message}`);
+        if (details) {
+            this.writeToFile(`  Details: ${typeof details === 'object' ? JSON.stringify(details, null, 2) : details}`);
+        }
+    }
+
+    /**
+     * Log an error message
+     * @param {string} message - Error message
+     * @param {Error|null} error - Error object
+     * @param {object|null} details - Additional details
+     * @param {string|null} hint - Helpful hint for resolving the error
+     */
+    error(message, error = null, details = null, hint = null) {
+        const timestamp = new Date().toISOString();
+        const entry = {
+            timestamp,
+            level: 'ERROR',
+            message,
+            error: error ? error.toString() : null,
+            stack: error?.stack || null,
+            details,
+            hint
+        };
+        this.errors.push(entry);
+
+        this.writeToFile(`[${timestamp}] ERROR: ${message}`);
+        if (error) {
+            this.writeToFile(`  Error: ${error.toString()}`);
+            if (error.stack) {
+                this.writeToFile(`  Stack: ${error.stack}`);
+            }
+        }
+        if (details) {
+            this.writeToFile(`  Details: ${typeof details === 'object' ? JSON.stringify(details, null, 2) : details}`);
+        }
+    }
+
+    /**
+     * Get a summary of the log
+     */
+    getSummary() {
+        return {
+            errors: this.errors.length,
+            warnings: this.warnings.length,
+            infos: this.infos.length,
+            logFile: this.logFile
+        };
+    }
+
+    /**
+     * Get the most recent errors (for preview)
+     */
+    getRecentErrors(count = 3) {
+        return this.errors.slice(-count);
+    }
+
+    /**
+     * Get the most recent warnings (for preview)
+     */
+    getRecentWarnings(count = 3) {
+        return this.warnings.slice(-count);
+    }
+
+    /**
+     * Display a summary to the console
+     */
+    displaySummary() {
+        const summary = this.getSummary();
+
+        if (summary.errors > 0 || summary.warnings > 0) {
+            console.log('');
+            console.log(chalk.bold('Issues Summary:'));
+
+            if (summary.errors > 0) {
+                console.log(chalk.red(`  ✗ ${summary.errors} error(s)`));
+
+                // Show preview of recent errors
+                const recentErrors = this.getRecentErrors(3);
+                recentErrors.forEach((err, idx) => {
+                    console.log(chalk.red(`    ${idx + 1}. ${err.message}`));
+                    if (err.hint) {
+                        console.log(chalk.yellow(`       ${err.hint}`));
+                    }
+                });
+
+                if (summary.errors > 3) {
+                    console.log(chalk.gray(`    ... and ${summary.errors - 3} more`));
+                }
+            }
+
+            if (summary.warnings > 0) {
+                console.log(chalk.yellow(`  ⚠ ${summary.warnings} warning(s)`));
+
+                // Show preview of recent warnings
+                const recentWarnings = this.getRecentWarnings(2);
+                recentWarnings.forEach((warn, idx) => {
+                    console.log(chalk.yellow(`    ${idx + 1}. ${warn.message}`));
+                });
+
+                if (summary.warnings > 2) {
+                    console.log(chalk.gray(`    ... and ${summary.warnings - 2} more`));
+                }
+            }
+
+            // Only show log file path if logging is enabled
+            if (this.loggingEnabled) {
+                console.log('');
+                console.log(chalk.cyan(`📄 Full log: ${chalk.white(summary.logFile)}`));
+                console.log(chalk.gray(`   View with: cat ${summary.logFile}`));
+            }
+            console.log('');
+        }
+    }
+
+    /**
+     * Finalize the log file
+     */
+    close() {
+        this.writeToFile('');
+        this.writeToFile(`Completed: ${new Date().toISOString()}`);
+        this.writeToFile(`Summary: ${this.errors.length} errors, ${this.warnings.length} warnings, ${this.infos.length} info messages`);
+        this.writeToFile('=== END LOG ===');
+    }
+
+    /**
+     * Clean up old log files (keep only last N logs)
+     */
+    static cleanupOldLogs(keepCount = 10) {
+        const logDir = '.magentrix/logs';
+
+        if (!fs.existsSync(logDir)) {
+            return;
+        }
+
+        try {
+            const files = fs.readdirSync(logDir)
+                .filter(f => f.endsWith('.log'))
+                .map(f => ({
+                    name: f,
+                    path: path.join(logDir, f),
+                    time: fs.statSync(path.join(logDir, f)).mtime.getTime()
+                }))
+                .sort((a, b) => b.time - a.time); // Sort by newest first
+
+            // Delete files beyond keepCount
+            if (files.length > keepCount) {
+                const toDelete = files.slice(keepCount);
+                toDelete.forEach(file => {
+                    try {
+                        fs.unlinkSync(file.path);
+                    } catch (err) {
+                        // Ignore errors when deleting old logs
+                    }
+                });
+            }
+        } catch (err) {
+            // Ignore errors in cleanup
+        }
+    }
+}
+
+/**
+ * Create a logger instance for an operation
+ */
+export function createLogger(operationName) {
+    return new Logger(operationName);
+}