at-builder 1.1.6 → 1.1.7

package/bin/constants/config.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setupEnv = exports.getHelpInfo = exports.getVersion = void 0;
+exports.getENV = exports.setupEnv = exports.getHelpInfo = exports.getVersion = void 0;
 const path = require("path");
 const fs = require("fs");
 var clc = require("cli-color");
@@ -80,6 +80,7 @@ TARGET_URL=""
 LOGIN_URL=""
 VARIATION="Variation-1"
 NODE_ENV="development"
+VERBOSE=false
     `;
         // Write the content to the .env file
         fs.writeFileSync(envPath, envContent.trim(), 'utf8');
@@ -107,3 +108,39 @@ const createWatchConfig = (basePath) => {
         console.log('watch-config.json file already exists!');
     }
 };
+/**
+ * Reads and returns environment variables from the specified .env file
+ * @param {string} basePath - The base path where the .env file is located
+ * @returns {Promise<Object>} Object containing environment variables
+ */
+const getENV = async (basePath) => {
+    const envPath = path.join(basePath, '.env');
+    try {
+        // Check if .env file exists
+        if (!fs.existsSync(envPath)) {
+            throw new Error('.env file not found');
+        }
+        // Read the .env file
+        const envContent = await fs.promises.readFile(envPath, { encoding: 'utf8' });
+        // Parse the .env file content
+        const envVars = {};
+        envContent.split('\n').forEach(line => {
+            line = line.trim();
+            // Skip empty lines and comments
+            if (line && !line.startsWith('#')) {
+                const [key, ...valueParts] = line.split('=');
+                if (key) {
+                    const value = valueParts.join('=').trim();
+                    // Remove quotes if present
+                    envVars[key.trim()] = value.replace(/^["'](.*)["']$/, '$1');
+                }
+            }
+        });
+        return envVars;
+    }
+    catch (error) {
+        console.error(clc.red(`Error reading .env file: ${error.message}`));
+        throw error;
+    }
+};
+exports.getENV = getENV;

package/bin/index.js

@@ -10,21 +10,22 @@ const fs_1 = __importDefault(require("fs"));
 const inquirer_1 = __importDefault(require("inquirer"));
 const commander_1 = require("commander");
 const config_1 = require("./constants/config");
+const logger_1 = __importDefault(require("./services/logger"));
 /**
  * Checks if the .env file exists at the current working directory
  *
  * @throws {Error} If the .env file is not found
  */
 const checkEnvFile = () => {
-    console.log("Checking if .env file exists at current working directory");
+    logger_1.default.info("checkEnvFile", "Checking if .env file exists at current working directory");
     try {
         // Check if the file exists and is readable
         fs_1.default.accessSync(path_1.default.join(process.cwd(), ".env"), fs_1.default.constants.R_OK);
-        console.log(".env file found");
+        logger_1.default.info("checkEnvFile", ".env file found");
     }
     catch (error) {
         // If the file does not exist, throw an error
-        console.log(`Error: Couldn't find .env file at location ${process.cwd()}`);
+        logger_1.default.error("checkEnvFile", `Error: Couldn't find .env file at location ${process.cwd()}`);
         throw error;
     }
 };
@@ -35,9 +36,9 @@ const productionEnv = {
 };
 // Commander setup
 const setupCommander = async () => {
-    console.log("Setting up commander");
+    logger_1.default.info("setupCommander", "Setting up commander");
     const version = await (0, config_1.getVersion)();
-    console.log(`Version: ${version}`);
+    logger_1.default.info("setupCommander", `Version: ${version}`);
     const program = new commander_1.Command();
     program
         .version(version, "-V, --version")
@@ -46,7 +47,7 @@ const setupCommander = async () => {
         .option("-p, --prod")
         .option("-v, --verbose", "Enable verbose logging")
         .parse(process.argv);
-    console.log("Commander setup complete");
+    logger_1.default.info("setupCommander", "Commander setup complete");
     return program.opts();
 };
 /**
@@ -56,9 +57,9 @@ const setupCommander = async () => {
  * @param env - The environment object to pass to the spawned process.
  */
 const runCommand = (commandArr, env) => {
-    console.log(`Running npm command [${commandArr.join(", ")}]`);
-    console.log(`Current working directory: ${process.cwd()}`);
-    // console.log(`Environment variables: ${JSON.stringify(env, null, 2)}`);
+    logger_1.default.info("runCommand", `Running npm command [${commandArr.join(", ")}]`);
+    logger_1.default.info("runCommand", `Current working directory: ${process.cwd()}`);
+    // logger.log(`Environment variables: ${JSON.stringify(env, null, 2)}`);
     // Spawn the command using `npm` with the given environment and current working directory.
     (0, child_process_1.spawn)("npm", commandArr, {
         cwd: path_1.default.join(__dirname, "../"),
@@ -74,16 +75,16 @@ const runCommand = (commandArr, env) => {
  *                          If false, runs the build with development environment.
  */
 const handleBuild = async (prod) => {
-    console.log(`Handling build with options: production=${prod}`);
+    logger_1.default.info("handleBuild", `Handling build with options: production=${prod}`);
     if (prod) {
         // Set production environment
         process.env['NODE_ENV'] = 'production';
-        console.log("Running build with production environment");
+        logger_1.default.info("handleBuild", "Running build with production environment");
         // Run the build command
         runCommand(['run', 'build-prod'], productionEnv);
     }
     else {
-        console.log("Running build with development environment");
+        logger_1.default.info("handleBuild", "Running build with development environment");
         // Prompt the user to ask if they want to open the build in a browser tab
         const { openInBrowser } = await inquirer_1.default.prompt([
             {
@@ -93,14 +94,14 @@ const handleBuild = async (prod) => {
                 default: false,
             },
         ]);
-        console.log(`User opted for opening in browser: ${openInBrowser}`);
+        logger_1.default.info("handleBuild", `User opted for opening in browser: ${openInBrowser}`);
         const commandArr = ['run', 'dev'];
         if (openInBrowser) {
             // If the user wants to open the build in a browser, run the build with
             // puppeteer
             commandArr[1] = 'dev-puppeteer';
         }
-        console.log(`Running command: ${commandArr.join(', ')}`);
+        logger_1.default.info("handleBuild", `Running command: ${commandArr.join(', ')}`);
         // Run the build command
         runCommand(commandArr, productionEnv);
         // TO_DO: verify
@@ -114,20 +115,20 @@ const handleBuild = async (prod) => {
  * @returns {Promise<void>}
  */
 const executeCommand = async () => {
-    console.log("Entering executeCommand");
+    logger_1.default.info("executeCommand", "Entering executeCommand");
     // Check if .env file is present
     // Get the command options
     const options = await setupCommander();
     if (options.command !== 'init')
         checkEnvFile();
-    console.log(`Options: ${JSON.stringify(options)}`);
+    logger_1.default.info("executeCommand", `Options: ${JSON.stringify(options)}`);
     /**
      * Logs a message if verbose mode is enabled
      * @param {string} message - The message to log
      */
     const verboseLog = (message) => {
         if (options.verbose) {
-            console.log(`[VERBOSE] ${message}`);
+            logger_1.default.info("verbose", message);
         }
     };
     switch (options.command) {
@@ -154,12 +155,12 @@ const executeCommand = async () => {
             process.exit(0);
             break;
     }
-    console.log("Exiting executeCommand");
+    logger_1.default.info("executeCommand", "Exiting executeCommand");
 };
 // Print command help
 const printCommandHelp = async () => {
     const help = await (0, config_1.getHelpInfo)();
-    console.log(help);
+    logger_1.default.info("printCommandHelp", help);
     process.exit(0);
 };
 /**
@@ -176,7 +177,7 @@ const main = async () => {
     }
     catch (error) {
         // Log the error message if the command fails
-        console.error(error.message);
+        logger_1.default.error("main", error.message);
         // Exit with code 1 if the command fails
         process.exit(1);
     }

package/bin/services/logger.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const config_1 = require("../constants/config");
+// Initialize verbose setting with a default value
+let isVerbose = false;
+// Set up verbose mode asynchronously
+(0, config_1.getENV)(process.cwd())
+    .then(envVars => {
+    isVerbose = envVars.VERBOSE === 'true';
+})
+    .catch(() => {
+    isVerbose = false;
+});
+const logger = {
+    MAX_RECORDS: 2000,
+    get verbose() {
+        return isVerbose;
+    },
+    // "debug"
+    log: function (tag, msg, ...rest) {
+        this._log("l", msg, tag, rest);
+    },
+    // "info"
+    info: function (tag, msg, ...rest) {
+        this._log("i", msg, tag, rest);
+    },
+    // "warn"
+    warn: function (tag, msg, ...rest) {
+        this._log("w", msg, tag, rest);
+    },
+    // "error"
+    error: function (tag, msg, ...rest) {
+        this._log("e", msg, tag, rest);
+    },
+    _log: function (level, msg, tag, ...rest) {
+        const origMsg = msg;
+        if (rest.length) {
+            msg = msg + " " + rest.join("\n");
+        }
+        let record;
+        tag = tag || null;
+        record = ((tag != null) ? "[" + tag + "] " + msg : msg);
+        const time = (new Date).toLocaleDateString() + " " + (new Date).toLocaleTimeString();
+        record = time + " " + record;
+        if (logger.verbose) {
+            const colors = {
+                reset: "\x1b[0m",
+                bright: "\x1b[1m",
+                dim: "\x1b[2m",
+                time: "\x1b[36m", // cyan
+                tag: "\x1b[35m", // magenta
+                message: "\x1b[37m", // white
+                error: "\x1b[31m", // red
+                warn: "\x1b[33m", // yellow
+                info: "\x1b[32m", // green
+                debug: "\x1b[34m" // blue
+            };
+            const coloredTime = `${colors.time}${time}${colors.reset}`;
+            const coloredTag = tag ? `${colors.tag}[${tag}]${colors.reset}` : '';
+            switch (level) {
+                case "l":
+                    console.log(coloredTime, coloredTag, `${colors.debug}${origMsg}${colors.reset}`, rest.join(" "));
+                    break;
+                case "i":
+                    console.info(coloredTime, coloredTag, `${colors.info}${origMsg}${colors.reset}`, rest.join(" "));
+                    break;
+                case "w":
+                    console.warn(coloredTime, coloredTag, `${colors.warn}${origMsg}${colors.reset}`, rest.join(" "));
+                    break;
+                case "e":
+                    console.error(coloredTime, coloredTag, `${colors.error}${origMsg}${colors.reset}`, rest.join(" "));
+                    break;
+            }
+        }
+    }
+};
+exports.default = logger;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "at-builder",
-    "version": "1.1.6",
+    "version": "1.1.7",
     "main": "bin/index.js",
     "bin": {
         "atb": "bin/index.js"

package/src/constants/config.ts

@@ -80,6 +80,7 @@ TARGET_URL=""
 LOGIN_URL=""
 VARIATION="Variation-1"
 NODE_ENV="development"
+VERBOSE=false
     `;
         // Write the content to the .env file
         fs.writeFileSync(envPath, envContent.trim(), 'utf8');
@@ -108,4 +109,42 @@ const createWatchConfig = (basePath) => {
     } else {
         console.log('watch-config.json file already exists!');
     }
-}
+}
+
+/**
+ * Reads and returns environment variables from the specified .env file
+ * @param {string} basePath - The base path where the .env file is located
+ * @returns {Promise<Object>} Object containing environment variables
+ */
+export const getENV = async (basePath: string) => {
+    const envPath = path.join(basePath, '.env');
+    try {
+        // Check if .env file exists
+        if (!fs.existsSync(envPath)) {
+            throw new Error('.env file not found');
+        }
+
+        // Read the .env file
+        const envContent = await fs.promises.readFile(envPath, { encoding: 'utf8' });
+        
+        // Parse the .env file content
+        const envVars: { [key: string]: string } = {};
+        envContent.split('\n').forEach(line => {
+            line = line.trim();
+            // Skip empty lines and comments
+            if (line && !line.startsWith('#')) {
+                const [key, ...valueParts] = line.split('=');
+                if (key) {
+                    const value = valueParts.join('=').trim();
+                    // Remove quotes if present
+                    envVars[key.trim()] = value.replace(/^["'](.*)["']$/, '$1');
+                }
+            }
+        });
+
+        return envVars;
+    } catch (error) {
+        console.error(clc.red(`Error reading .env file: ${error.message}`));
+        throw error;
+    }
+};

package/src/index.ts

@@ -5,21 +5,21 @@ import fs from "fs";
 import inquirer  from 'inquirer';
 import { Command } from 'commander';
 import { getVersion, getHelpInfo, setupEnv } from "./constants/config";
-
+import logger from "./services/logger";
 /**
  * Checks if the .env file exists at the current working directory
  *
  * @throws {Error} If the .env file is not found
  */
 const checkEnvFile = () => {
-    console.log("Checking if .env file exists at current working directory");
+    logger.info("checkEnvFile", "Checking if .env file exists at current working directory");
     try {
         // Check if the file exists and is readable
         fs.accessSync(path.join(process.cwd(), ".env"), fs.constants.R_OK);
-        console.log(".env file found");
+        logger.info("checkEnvFile", ".env file found");
     } catch (error) {
         // If the file does not exist, throw an error
-        console.log(`Error: Couldn't find .env file at location ${process.cwd()}`);
+        logger.error("checkEnvFile", `Error: Couldn't find .env file at location ${process.cwd()}`);
         throw error;
     }
 };
@@ -32,9 +32,9 @@ const productionEnv = {
 
 // Commander setup
 const setupCommander = async () => {
-    console.log("Setting up commander");
+    logger.info("setupCommander", "Setting up commander");
     const version = await getVersion();
-    console.log(`Version: ${version}`);
+    logger.info("setupCommander", `Version: ${version}`);
     const program = new Command();
     program
         .version(version, "-V, --version")
@@ -44,7 +44,7 @@ const setupCommander = async () => {
         .option("-v, --verbose", "Enable verbose logging")
         .parse(process.argv);
 
-    console.log("Commander setup complete");
+    logger.info("setupCommander", "Commander setup complete");
     return program.opts();
 };
 
@@ -57,9 +57,9 @@ const setupCommander = async () => {
  * @param env - The environment object to pass to the spawned process.
  */
 const runCommand = (commandArr: string[], env: NodeJS.ProcessEnv): void => {
-    console.log(`Running npm command [${commandArr.join(", ")}]`);
-    console.log(`Current working directory: ${process.cwd()}`);
-    // console.log(`Environment variables: ${JSON.stringify(env, null, 2)}`);
+    logger.info("runCommand", `Running npm command [${commandArr.join(", ")}]`);
+    logger.info("runCommand", `Current working directory: ${process.cwd()}`);
+    // logger.log(`Environment variables: ${JSON.stringify(env, null, 2)}`);
 
     // Spawn the command using `npm` with the given environment and current working directory.
     spawn("npm", commandArr, {
@@ -77,15 +77,15 @@ const runCommand = (commandArr: string[], env: NodeJS.ProcessEnv): void => {
  *                          If false, runs the build with development environment.
  */
 const handleBuild = async (prod: boolean): Promise<void> => {
-    console.log(`Handling build with options: production=${prod}`);
+    logger.info("handleBuild", `Handling build with options: production=${prod}`);
     if (prod) {
         // Set production environment
         process.env['NODE_ENV'] = 'production';
-        console.log("Running build with production environment");
+        logger.info("handleBuild", "Running build with production environment");
         // Run the build command
         runCommand(['run', 'build-prod'], productionEnv);
     } else {
-        console.log("Running build with development environment");
+        logger.info("handleBuild", "Running build with development environment");
         // Prompt the user to ask if they want to open the build in a browser tab
         const { openInBrowser } = await inquirer.prompt([
             {
@@ -96,7 +96,7 @@ const handleBuild = async (prod: boolean): Promise<void> => {
             },
         ]);
 
-        console.log(`User opted for opening in browser: ${openInBrowser}`);
+        logger.info("handleBuild", `User opted for opening in browser: ${openInBrowser}`);
         const commandArr = ['run', 'dev'];
         if (openInBrowser) {
             // If the user wants to open the build in a browser, run the build with
@@ -104,7 +104,7 @@ const handleBuild = async (prod: boolean): Promise<void> => {
             commandArr[1] = 'dev-puppeteer';
         }
 
-        console.log(`Running command: ${commandArr.join(', ')}`);
+        logger.info("handleBuild", `Running command: ${commandArr.join(', ')}`);
         // Run the build command
         runCommand(commandArr, productionEnv);
         // TO_DO: verify
@@ -119,7 +119,7 @@ const handleBuild = async (prod: boolean): Promise<void> => {
  * @returns {Promise<void>}
  */
 const executeCommand = async () => {
-    console.log("Entering executeCommand");
+    logger.info("executeCommand", "Entering executeCommand");
     // Check if .env file is present
     // Get the command options
     const options = await setupCommander();
@@ -127,14 +127,14 @@ const executeCommand = async () => {
     if (options.command !== 'init')
         checkEnvFile();
     
-    console.log(`Options: ${JSON.stringify(options)}`);
+    logger.info("executeCommand", `Options: ${JSON.stringify(options)}`);
     /**
      * Logs a message if verbose mode is enabled
      * @param {string} message - The message to log
      */
     const verboseLog = (message: string) => {
         if (options.verbose) {
-            console.log(`[VERBOSE] ${message}`);
+            logger.info("verbose", message);
         }
     };
 
@@ -165,13 +165,13 @@ const executeCommand = async () => {
             process.exit(0);
             break;
     }
-    console.log("Exiting executeCommand");
+    logger.info("executeCommand", "Exiting executeCommand");
 };
 
 // Print command help
 const printCommandHelp = async () => {
     const help = await getHelpInfo();
-    console.log(help);
+    logger.info("printCommandHelp", help);
     process.exit(0);
 };
 
@@ -188,7 +188,7 @@ const main = async () => {
         await executeCommand();
     } catch (error) {
         // Log the error message if the command fails
-        console.error(error.message);
+        logger.error("main", error.message);
         // Exit with code 1 if the command fails
         process.exit(1);
     }

package/src/services/logger.ts

@@ -0,0 +1,84 @@
+import { getENV } from "../constants/config";
+
+// Initialize verbose setting with a default value
+let isVerbose = false;
+
+// Set up verbose mode asynchronously
+getENV(process.cwd())
+    .then(envVars => {
+        isVerbose = envVars.VERBOSE === 'true';
+    })
+    .catch(() => {
+        isVerbose = false;
+    });
+
+const logger = {
+    MAX_RECORDS: 2000,
+    get verbose() {
+        return isVerbose;
+    },
+    // "debug"
+    log: function (tag, msg, ...rest) {
+        this._log("l", msg, tag, rest);
+    },
+    // "info"
+    info: function (tag, msg, ...rest) {
+        this._log("i", msg, tag, rest);
+    },
+    // "warn"
+    warn: function (tag, msg, ...rest) {
+        this._log("w", msg, tag, rest);
+    },
+    // "error"
+    error: function (tag, msg, ...rest) {
+        this._log("e", msg, tag, rest);
+    },
+    _log: function (level, msg, tag, ...rest) {
+        const origMsg = msg;
+        if (rest.length) {
+            msg = msg + " " + rest.join("\n")
+        }
+        let record;
+        tag = tag || null;
+        record = (
+            (tag != null) ? "[" + tag + "] " + msg : msg
+        );
+        const time = (new Date).toLocaleDateString() + " " + (new Date).toLocaleTimeString();
+        record = time + " " + record;
+        
+        if(logger.verbose) {
+            const colors = {
+                reset: "\x1b[0m",
+                bright: "\x1b[1m",
+                dim: "\x1b[2m",
+                time: "\x1b[36m",     // cyan
+                tag: "\x1b[35m",      // magenta
+                message: "\x1b[37m",   // white
+                error: "\x1b[31m",     // red
+                warn: "\x1b[33m",      // yellow
+                info: "\x1b[32m",      // green
+                debug: "\x1b[34m"      // blue
+            };
+
+            const coloredTime = `${colors.time}${time}${colors.reset}`;
+            const coloredTag = tag ? `${colors.tag}[${tag}]${colors.reset}` : '';
+            
+            switch (level) {
+                case "l":
+                    console.log(coloredTime, coloredTag, `${colors.debug}${origMsg}${colors.reset}`, rest.join(" "));
+                    break;
+                case "i":
+                    console.info(coloredTime, coloredTag, `${colors.info}${origMsg}${colors.reset}`, rest.join(" "));
+                    break;
+                case "w":
+                    console.warn(coloredTime, coloredTag, `${colors.warn}${origMsg}${colors.reset}`, rest.join(" "));
+                    break;
+                case "e":
+                    console.error(coloredTime, coloredTag, `${colors.error}${origMsg}${colors.reset}`, rest.join(" "));
+                    break;
+            }
+        }
+    }
+};
+
+export default logger;