@zeesoft/i18n-verify 3.2.5 → 3.2.7

package/dist/executor.mjs

@@ -1,4 +1,4 @@
-import fs, { existsSync, statSync, readFileSync, mkdirSync, writeFileSync, readdirSync, appendFileSync, copyFileSync } from "fs";
+import fs, { existsSync, statSync, readFileSync, writeFileSync, readdirSync, mkdirSync, appendFileSync, copyFileSync } from "fs";
 import path, { join, dirname, extname } from "path";
 import { Table } from "console-table-printer";
 import CDP from "chrome-remote-interface";
@@ -175,7 +175,6 @@ const SMART_SELECTOR = `//*[not(self::script or self::style or self::noscript)]
       or @hidden
   ])]
 `;
-const DEBUG_MODE = true;
 const GARBLED_CHARACTERS = [
   "☐",
   "�",
@@ -4156,6 +4155,9 @@ class ReportFactory {
     }
   }
   static export(type, path2, name) {
+    if (type === SUPPORTED_REPORT_TYPES.HTML && !path2) {
+      return;
+    }
     const builder = ReportFactory.#build(type);
     const reportData = new ReportData({
       appName: Config.getAppName(),
@@ -4978,14 +4980,14 @@ class Reports {
       "screenshots",
       String(type).toLowerCase()
     );
-    ensureDirectoryExists(_screenshotPath, DEBUG_MODE);
+    ensureDirectoryExists(_screenshotPath, Config.isDebugMode());
     if (str !== null && str !== void 0) {
       const _stringsPath = joinPaths(
         Reports.#baseReportPath,
         toFileNameFormat(Config.getLocale()),
         "strings"
       );
-      ensureDirectoryExists(_stringsPath, DEBUG_MODE);
+      ensureDirectoryExists(_stringsPath, Config.isDebugMode());
       let content = "";
       const filePath = joinPaths(_stringsPath, type + ".txt");
       if (pathExists(filePath)) {
@@ -5014,7 +5016,7 @@ class Reports {
       toFileNameFormat(Config.getLocale()),
       "contexts"
     );
-    ensureDirectoryExists(contextPath, DEBUG_MODE);
+    ensureDirectoryExists(contextPath, Config.isDebugMode());
     return contextPath;
   };
   static #generateReport(type) {
@@ -5044,16 +5046,20 @@ class Logger {
     Logger.#print("dbug", message);
   }
   static #print(type, message, additionalObj = "") {
+    if (type === "dbug" && !Config.isDebugMode()) {
+      return;
+    }
     const colors = {
       INFO: "\x1B[37m",
       WARN: "\x1B[33m",
       ERRR: "\x1B[31m",
       DBUG: "\x1B[34m"
     };
+    const locale = Config.getLocale();
     type = type.toUpperCase();
     let color = colors[type] || colors.DEFAULT;
     additionalObj = additionalObj ? ` reason: ${additionalObj.toString()}` : "";
-    let logMessage = `[${(/* @__PURE__ */ new Date()).toLocaleString()}] [${color}${type}\x1B[0m] [${Config.getLocale()}] - ${message}${additionalObj}`;
+    let logMessage = `[${(/* @__PURE__ */ new Date()).toLocaleString()}] [${color}${type}\x1B[0m]${locale ? `[${locale}]` : ""} - ${message}${additionalObj}`;
     switch (type) {
       case "INFO":
         console.info(logMessage);
@@ -5087,10 +5093,12 @@ class Logger {
       }, 10);
     } else {
       Logger.#isLogAppending = true;
-      const LOGS_DIR = joinPaths(Reports.getReportPath(), "logs");
-      const logFilePath = joinPaths(LOGS_DIR, "log");
-      ensureDirectoryExists(LOGS_DIR, DEBUG_MODE);
-      fs.appendFileSync(logFilePath, message);
+      const logsDir = joinPaths(Reports.getReportPath(), "logs");
+      if (logsDir) {
+        const logFilePath = joinPaths(logsDir, "log");
+        ensureDirectoryExists(logsDir, Config.isDebugMode());
+        fs.appendFileSync(logFilePath, message);
+      }
       Logger.#isLogAppending = false;
     }
   };
@@ -5763,7 +5771,6 @@ class BaseValidator {
   }
   #getCompatibleLocale(locale) {
     if (this.isQaLocale()) {
-      Logger.warn(`Detected QA lcoale so defaulting to 'en'.`);
       return "en";
     }
     locale = locale.replace(/[-_ ]/g, "-");
@@ -5777,9 +5784,6 @@ class BaseValidator {
       if (firstMatch) {
         suitableLocale = firstMatch;
       } else {
-        Logger.warn(
-          `No suitable locale found for ${locale}. Defaulting to 'en'.`
-        );
         suitableLocale = "en";
       }
     }
@@ -6651,8 +6655,8 @@ const loadDependencies = () => {
   if (Config.getDriver() && !Config.isLoaded() && Config.getLocale()) {
     Config.build();
     Resource.load();
-    Validator.load();
     Reports.setup();
+    Validator.load();
     Cache.init();
     Config.setIsLoaded(true);
   }
@@ -6697,7 +6701,8 @@ const getConfigTemplate = (type = "") => `{
         "suffix": "_海"
     },
     "mode": "${RUN_MODE.I18N}", // should be one of the following: ${Object.values(RUN_MODE).join(", ")}
-    "garbledChars": [""]
+    "garbledChars": [""],
+    "debug": false // set to true to enable debug mode (verbose logging)
 }`;
 const readConfigFile = () => {
   const rcFilePath = getConfigFilePath();
@@ -6769,43 +6774,45 @@ class Config {
   static #ssCount;
   static #appName;
   static #isLoaded;
+  static #isDebugMode;
   static init() {
     try {
       const config = readConfigFile();
       validateConfig(config);
-      this.#type = config?.type;
-      this.#mode = config?.mode;
-      this.#qaLocale = config?.qaLocale;
-      this.#appName = config?.appName;
-      this.#options = config;
-      this.#ssCount = 0;
-      this.getGarbledChars();
+      Config.#type = config?.type;
+      Config.#mode = config?.mode;
+      Config.#qaLocale = config?.qaLocale;
+      Config.#appName = config?.appName;
+      Config.#options = config;
+      Config.#ssCount = 0;
+      Config.#isDebugMode = config?.debug ?? false;
+      Config.getGarbledChars();
     } catch (ex) {
       Logger.error(ex.message);
       throw ex;
     }
   }
   static build() {
-    this.#driver = build$1(this.#type, this.#driver);
-    this.resetCounter();
+    Config.#driver = build$1(Config.#type, Config.#driver);
+    Config.resetCounter();
   }
   static getGarbledChars() {
-    return [...this.#options.garbledChars || [], ...GARBLED_CHARACTERS];
+    return [...Config.#options.garbledChars || [], ...GARBLED_CHARACTERS];
   }
   static getL10nReportsPath() {
-    return this.#options.l10nReportsPath;
+    return Config.#options.l10nReportsPath;
   }
   static setDriver(driver) {
-    this.#driver = driver;
+    Config.#driver = driver;
   }
   static setType(type) {
-    this.#type = type;
+    Config.#type = type;
   }
   static setLocale(locale) {
-    this.#locale = locale;
+    Config.#locale = locale;
   }
   static setOptions(options) {
-    this.#options = options;
+    Config.#options = options;
   }
   static getExecutor() {
     if (Config.#executor) {
@@ -6816,65 +6823,68 @@ class Config {
         "Unable to initialize process executor, driver is missing"
       );
     }
-    this.#executor = new Executor(this.#driver);
-    return this.#executor;
+    Config.#executor = new Executor(Config.#driver);
+    return Config.#executor;
   }
   static getDriver() {
-    return this.#driver;
+    return Config.#driver;
   }
   static getLocale() {
-    return this.#locale;
+    return Config.#locale;
   }
   static getDefaultLocale() {
-    return this.#options.defaultLocale;
+    return Config.#options.defaultLocale;
   }
   static getType() {
-    return this.#type;
+    return Config.#type;
   }
   static getOptions() {
-    return this.#options;
+    return Config.#options;
   }
   static setQALocale(locale) {
-    this.#qaLocale = locale;
+    Config.#qaLocale = locale;
   }
   static getQALocale() {
-    return this.#qaLocale;
+    return Config.#qaLocale;
   }
   static setResourceBundle(resources) {
-    this.#resources = resources;
+    Config.#resources = resources;
   }
   static getResourceBundle(value) {
-    return this.#resources?.[value] || this.#resources || [];
+    return Config.#resources?.[value] || Config.#resources || [];
   }
   static incrementCounter() {
-    this.#ssCount++;
+    Config.#ssCount++;
   }
   static resetCounter() {
-    this.#ssCount = 0;
+    Config.#ssCount = 0;
   }
   static getSSCount(incrementCount = false) {
-    return incrementCount ? ++this.#ssCount : this.#ssCount;
+    return incrementCount ? ++Config.#ssCount : Config.#ssCount;
   }
   static getMode() {
-    return this.#mode;
+    return Config.#mode;
   }
   static isSanityRun() {
-    return this.#mode === RUN_MODE.SANITY;
+    return Config.#mode === RUN_MODE.SANITY;
   }
   static isI18nVerificationRun() {
-    return this.#mode === RUN_MODE.I18N;
+    return Config.#mode === RUN_MODE.I18N;
   }
   static isContextRun() {
-    return this.#mode === RUN_MODE.CONTEXT;
+    return Config.#mode === RUN_MODE.CONTEXT;
   }
   static getAppName() {
-    return this.#appName;
+    return Config.#appName;
   }
   static isLoaded() {
-    return this.#isLoaded;
+    return Config.#isLoaded;
   }
   static setIsLoaded(value) {
-    this.#isLoaded = value;
+    Config.#isLoaded = value;
+  }
+  static isDebugMode() {
+    return Config.#isDebugMode;
   }
 }
 class BaseRunner {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zeesoft/i18n-verify",
-  "version": "3.2.5",
+  "version": "3.2.7",
   "description": "Library to perform I18n verification on Nightwatch, WebdriverIO or Selenium framework projects",
   "main": "dist/index.mjs",
   "module": "dist/index.mjs",

package/readme.md

@@ -14,6 +14,8 @@
 
 - `garbledChars` list of garbled characters which the library will use to skip while processing i18n verification
 
+- `debug` runs in debug mode (verbose logging)
+
 ## Dependency installation
 
     npm i --ignore-scripts