@zeesoft/i18n-verify 3.3.5 → 3.3.6

package/dist/executor.mjs

@@ -425,8 +425,9 @@ class BaseReport {
   }
   export(path2, name = DEFAULT_REPORT_NAME) {
     this.write(path2, name, this.$generatedContent);
+    const runMode = Config.getMode();
     Logger.info(
-      `Exported consolidated I18n Verification ${this.$type} report in ${path2}`
+      `Exported consolidated ${runMode} Verification ${this.$type} report in ${path2}`
     );
   }
   write(path2, name, data2) {
@@ -4077,82 +4078,118 @@ class HtmlReport extends BaseReport {
     saveToFile(joinPaths(path2, `${name}.html`), data2, "utf-8");
   }
 }
+function createTableStyle(colorCode = "\x1B[94m") {
+  return {
+    headerTop: {
+      left: `${colorCode}╔\x1B[0m`,
+      mid: `${colorCode}╦\x1B[0m`,
+      right: `${colorCode}╗\x1B[0m`,
+      other: `${colorCode}═`
+    },
+    headerBottom: {
+      left: `${colorCode}╟\x1B[0m`,
+      mid: `${colorCode}╬\x1B[0m`,
+      right: `${colorCode}╢\x1B[0m`,
+      other: `${colorCode}═`
+    },
+    tableBottom: {
+      left: `${colorCode}╚\x1B[0m`,
+      mid: `${colorCode}╩\x1B[0m`,
+      right: `${colorCode}╝\x1B[0m`,
+      other: `${colorCode}═\x1B[0m`
+    },
+    vertical: `${colorCode}║\x1B[0m`
+  };
+}
+function genSummaryTable(pageCount, locales, runMode = "Sanity") {
+  const mode = runMode.toLowerCase();
+  let summaryLine = "";
+  if (mode === "i18n") {
+    summaryLine = `${runMode} run completed localization verification for locales: ${locales}.`;
+  } else if (["sanity", "context"].includes(mode)) {
+    summaryLine = `${runMode} run has successfully verified ${pageCount} pages for locales: ${locales}.`;
+  } else {
+    summaryLine = `${runMode} run completed successfully for ${pageCount} pages for locales: ${locales}.`;
+  }
+  const summaryPrinter = new Table({
+    style: createTableStyle("\x1B[92m"),
+    columns: [
+      { name: "RUN MODE", alignment: "left" },
+      { name: "DETAILS", alignment: "left" }
+    ]
+  });
+  summaryPrinter.addRow({ "RUN MODE": runMode, DETAILS: summaryLine });
+  summaryPrinter.printTable();
+}
 class TableReport extends BaseReport {
-  /**
-   * @type {Table}
-   */
+  /** @type {Table} */
   #printer;
-  /**
-   * @type {Boolean}
-   */
+  /** @type {boolean} */
   #hasData = false;
   static #column1 = "STATUS";
   static #column2 = "COUNTS";
-  constructor() {
+  /**
+   * @param {string} runMode - optional, defaults to 'sanity'
+   */
+  constructor(runMode = "sanity") {
     super(SUPPORTED_REPORT_TYPES.ASCII_TABLE);
+    this.runMode = String(runMode).toLowerCase();
     this.#preparePrinter();
   }
+  /**
+   * Allow changing run mode after construction
+   * @param {string} runMode
+   */
+  setRunMode(runMode) {
+    this.runMode = String(runMode).toLowerCase();
+    if (!this.#printer) this.#preparePrinter();
+  }
   #preparePrinter() {
     this.#printer = new Table({
-      style: {
-        headerTop: {
-          left: "\x1B[94m╔\x1B[0m",
-          mid: "\x1B[94m╦\x1B[0m",
-          right: "\x1B[94m╗\x1B[0m",
-          other: "\x1B[94m═"
-        },
-        headerBottom: {
-          left: "\x1B[94m╟\x1B[0m",
-          mid: "\x1B[94m╬\x1B[0m",
-          right: "\x1B[94m╢\x1B[0m",
-          other: "\x1B[94m═"
-        },
-        tableBottom: {
-          left: "\x1B[94m╚\x1B[0m",
-          mid: "\x1B[94m╩\x1B[0m",
-          right: "\x1B[94m╝\x1B[0m",
-          other: "\x1B[94m═\x1B[0m"
-        },
-        vertical: "\x1B[94m║\x1B[0m"
-      },
+      style: createTableStyle("\x1B[94m"),
       columns: [
         { name: TableReport.#column1, alignment: "left" },
         { name: TableReport.#column2, alignment: "center" }
       ]
     });
   }
-  /**
-   * @override
-   */
+  /** @override */
   buildContent() {
-    if (REPORT_COUNTS[I18N_STATUS.REVIEWED] > 0) {
+    if (this.runMode !== "i18n") {
+      this.#hasData = false;
+      return;
+    }
+    const reviewedCount = REPORT_COUNTS[I18N_STATUS.REVIEWED] || 0;
+    if (reviewedCount > 0) {
       this.#hasData = true;
       for (const key in REPORT_COUNTS) {
-        if (key !== I18N_STATUS.REVIEWED) {
-          if (REPORT_COUNTS.hasOwnProperty(key)) {
-            this.#printer.addRows([
-              { STATUS: key, COUNTS: `${REPORT_COUNTS[key]}` }
-            ]);
-          }
-        } else {
+        if (!Object.prototype.hasOwnProperty.call(REPORT_COUNTS, key)) continue;
+        if (key === I18N_STATUS.REVIEWED) {
           this.#printer.addRows([
             {
               STATUS: "\x1B[94m" + "═".repeat(28) + "\x1B[0m",
               COUNTS: "\x1B[94m" + "═".repeat(8) + "\x1B[0m"
-            }
+            },
+            { STATUS: "OVERALL_REVIEWED", COUNTS: `${reviewedCount}` }
           ]);
+        } else {
           this.#printer.addRows([
-            { STATUS: "OVERALL_REVIEWED", COUNTS: `${REPORT_COUNTS[key]}` }
+            { STATUS: key, COUNTS: `${REPORT_COUNTS[key]}` }
           ]);
         }
       }
+    } else {
+      this.#hasData = false;
     }
   }
-  /**
-   * @override
-   */
+  /** @override */
   export() {
-    this.#hasData ? this.#printer.printTable() : Logger.info("There are no visbile elements with UI strings");
+    if (this.runMode !== "i18n") return;
+    if (this.#hasData) {
+      this.#printer.printTable();
+    } else {
+      Logger.info("There are no visible elements with UI strings");
+    }
   }
 }
 class ReportFactory {
@@ -4161,7 +4198,7 @@ class ReportFactory {
       case SUPPORTED_REPORT_TYPES.HTML:
         return new HtmlReport();
       case SUPPORTED_REPORT_TYPES.ASCII_TABLE:
-        return new TableReport();
+        return new TableReport(Config.getMode());
       default:
         throw new Error("unsupported report type requested");
     }
@@ -7459,10 +7496,11 @@ export {
   Logger as L,
   Reports as R,
   SYSTEM_TYPES as S,
-  getRootProjectPackageJson as a,
-  CONFIG_FILE_NAME as b,
+  getRootProjectMainDir as a,
+  getRootProjectPackageJson as b,
   checkAndExportConfig as c,
-  getRootProjectMainDir as g,
+  CONFIG_FILE_NAME as d,
+  genSummaryTable as g,
   joinPaths as j,
   loadDependencies as l
 };

package/dist/genrc.mjs

@@ -1,4 +1,4 @@
-import { g as getRootProjectMainDir, a as getRootProjectPackageJson, c as checkAndExportConfig, j as joinPaths, b as CONFIG_FILE_NAME, S as SYSTEM_TYPES } from "./executor.mjs";
+import { a as getRootProjectMainDir, b as getRootProjectPackageJson, c as checkAndExportConfig, j as joinPaths, d as CONFIG_FILE_NAME, S as SYSTEM_TYPES } from "./executor.mjs";
 const projectDir = getRootProjectMainDir();
 const packageJson = getRootProjectPackageJson(projectDir);
 let type = "";

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { C as Config, L as Logger, S as SYSTEM_TYPES, l as loadDependencies, R as Reports, E as Executor } from "./executor.mjs";
+import { C as Config, L as Logger, S as SYSTEM_TYPES, l as loadDependencies, R as Reports, g as genSummaryTable, E as Executor } from "./executor.mjs";
 const logger = Logger;
 const systems = SYSTEM_TYPES;
 const setRuntime = (driver) => {
@@ -13,6 +13,14 @@ const setLocale = (locale) => {
 const genReportTable = () => {
   Reports.generateAsciiTable();
   Reports.generateHtml();
+  try {
+    const pageCount = Config.getSSCount();
+    const locales = getLocale();
+    const runMode = Config.getMode();
+    genSummaryTable(pageCount, locales, runMode);
+  } catch (err) {
+    Logger.debug("Could not print summary table: " + err.message);
+  }
 };
 const getLocale = () => {
   return Config.getLocale();

package/package.json

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