@zeesoft/i18n-verify 2.0.2 → 2.1.0

package/dist/utils/reportFactory/index.js

@@ -4,30 +4,28 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _config = _interopRequireDefault(require("../../lib/config.js"));
-var _cache = _interopRequireDefault(require("../cache.js"));
 var _constants = require("../constants.js");
 var _index = _interopRequireDefault(require("./html/index.js"));
 var _reportData = _interopRequireDefault(require("../objects/reportData.js"));
-var _cacheData = _interopRequireDefault(require("../objects/cacheData.js"));
 var _runtime = require("../runtime.js");
+var _table = _interopRequireDefault(require("./table.js"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 class ReportFactory {
   static #build(type) {
     switch (type) {
       case _constants.SUPPORTED_REPORT_TYPES.HTML:
         return new _index.default();
+      case _constants.SUPPORTED_REPORT_TYPES.ASCII_TABLE:
+        return new _table.default();
       default:
         throw new Error('unsupported report type requested');
     }
   }
   static export(type, path, name) {
     const builder = ReportFactory.#build(type);
-    const data = new _cacheData.default(_cache.default.getData());
-    const reportTime = new Date(_config.default.getLastRunTimeStamp()).toLocaleString();
+    const reportTime = new Date().toLocaleString();
     const appName = (0, _runtime.getRootProjectName)();
     const reportData = new _reportData.default({
-      data,
       appName,
       reportTime
     });

package/dist/utils/reportFactory/table.js

@@ -0,0 +1,95 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _consoleTablePrinter = require("console-table-printer");
+var _constants = require("../constants");
+var _logs = _interopRequireDefault(require("../logs"));
+var _base = _interopRequireDefault(require("./base"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+class TableReport extends _base.default {
+  /**
+   * @type {Table}
+   */
+  #printer;
+  /**
+   * @type {Boolean}
+   */
+  #hasData = false;
+  static #column1 = 'STATUS';
+  static #column2 = 'COUNTS';
+  constructor() {
+    super(_constants.SUPPORTED_REPORT_TYPES.ASCII_TABLE);
+    this.#preparePrinter();
+  }
+  #preparePrinter() {
+    this.#printer = new _consoleTablePrinter.Table({
+      style: {
+        headerTop: {
+          left: '\u001B[94m╔\x1b[0m',
+          mid: '\u001B[94m╦\x1b[0m',
+          right: '\u001B[94m╗\x1b[0m',
+          other: '\u001B[94m═'
+        },
+        headerBottom: {
+          left: '\u001B[94m╟\x1b[0m',
+          mid: '\u001B[94m╬\x1b[0m',
+          right: '\u001B[94m╢\x1b[0m',
+          other: '\u001B[94m═'
+        },
+        tableBottom: {
+          left: '\u001B[94m╚\x1b[0m',
+          mid: '\u001B[94m╩\x1b[0m',
+          right: '\u001B[94m╝\x1b[0m',
+          other: '\u001B[94m═\x1b[0m'
+        },
+        vertical: '\u001B[94m║\x1b[0m'
+      },
+      columns: [{
+        name: TableReport.#column1,
+        alignment: 'left'
+      }, {
+        name: TableReport.#column2,
+        alignment: 'center'
+      }]
+    });
+  }
+
+  /**
+   * @override
+   */
+  buildContent() {
+    if (_constants.REPORT_COUNTS[_constants.I18N_STATUS.REVIEWED] > 0) {
+      this.#hasData = true;
+      for (const key in _constants.REPORT_COUNTS) {
+        if (key !== _constants.I18N_STATUS.REVIEWED) {
+          if (_constants.REPORT_COUNTS.hasOwnProperty(key)) {
+            this.#printer.addRows([{
+              STATUS: key,
+              COUNTS: `${_constants.REPORT_COUNTS[key]}`
+            }]);
+          }
+        } else {
+          this.#printer.addRows([{
+            STATUS: '\u001B[94m' + '═'.repeat(28) + '\x1b[0m',
+            COUNTS: '\u001B[94m' + '═'.repeat(8) + '\x1b[0m'
+          }]);
+          this.#printer.addRows([{
+            STATUS: 'OVERALL_REVIEWED',
+            COUNTS: `${_constants.REPORT_COUNTS[key]}`
+          }]);
+        }
+      }
+    }
+  }
+
+  /**
+   * @override
+   */
+  export() {
+    this.#hasData ? this.#printer.printTable() : _logs.default.info('There are no visbile elements with UI strings');
+  }
+}
+exports.default = TableReport;

package/dist/utils/resource.js

@@ -7,7 +7,6 @@ exports.default = void 0;
 var _config = _interopRequireDefault(require("../lib/config.js"));
 var _constants = require("./constants.js");
 var _file = require("./file.js");
-var _logs = _interopRequireDefault(require("../utils/logs.js"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 class Resource {
   static load() {
@@ -22,8 +21,8 @@ class Resource {
           Resource.#processFile(filePath, bundle);
         }
       } else {
-        _logs.default.error(`${resourcePath} invalid resource path`);
-        return; // throw runtime error
+        console.error(`${resourcePath} invalid resource path`);
+        return;
       }
       _config.default.setResourceBundle(bundle);
     }
@@ -35,7 +34,7 @@ class Resource {
       ext = (0, _file.getFileExtenstion)(filePath);
     if (_constants.RES_FILE_EXTENSIONS.includes(ext)) {
       if (!fileContent) {
-        _logs.default.error(`${filePath} is empty or invalid`);
+        console.error(`${filePath} is empty or invalid`);
         return;
       }
       if (filePath.toLowerCase().includes('dnt')) {
@@ -44,11 +43,16 @@ class Resource {
         bundle['ignore'] = fileContent.split(/\r?\n/);
         // TODO: add locale validations for the following cases
       } else if (filePath.includes(locale)) {
-        bundle[locale] = fileContent.split(/\r?\n/);
+        const lines = fileContent.split(/\r?\n/);
+        bundle[locale] = lines.map(removeHtmlTags);
       } else if (filePath.includes(defaultLocale)) {
         bundle[defaultLocale] = fileContent.split(/\r?\n/);
       }
     }
   }
 }
-exports.default = Resource;
+exports.default = Resource;
+function removeHtmlTags(str) {
+  const htmlTagPattern = /<\/?[^>]+>/gi;
+  return str.replace(htmlTagPattern, '');
+}

package/dist/utils/runtime.js

@@ -3,14 +3,34 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.loadDependencies = void 0;
+exports.loadDependencies = exports.getRootProjectPackageJson = exports.getRootProjectName = exports.getRootProjectMainDir = void 0;
 var _index = _interopRequireDefault(require("../lib/validator/index.js"));
-var _reports = _interopRequireDefault(require("./reports.js"));
+var _reports = _interopRequireDefault(require("../lib/reports.js"));
 var _resource = _interopRequireDefault(require("./resource.js"));
+var _cache = _interopRequireDefault(require("./cache.js"));
+var _path = require("path");
+var _file = require("./file.js");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const loadDependencies = () => {
   _resource.default.load();
   _index.default.load();
   _reports.default.setup();
+  _cache.default.init();
 };
-exports.loadDependencies = loadDependencies;
+exports.loadDependencies = loadDependencies;
+const getRootProjectMainDir = () => {
+  let currentDir = __dirname;
+  while (currentDir !== (0, _path.parse)(currentDir).root) {
+    const packageJsonPath = (0, _file.joinPaths)(currentDir, 'package.json');
+    if ((0, _file.fileExists)(packageJsonPath) && !(0, _file.getFileContent)(packageJsonPath).match(/"name": "@zeesoft\/i18n-verify",/g) === null) {
+      return packageJsonPath;
+    }
+    currentDir = (0, _path.dirname)(currentDir);
+  }
+  return '';
+};
+exports.getRootProjectMainDir = getRootProjectMainDir;
+const getRootProjectPackageJson = (rootProjectPath = getRootProjectMainDir()) => (0, _file.getFileContent)((0, _file.joinPaths)(rootProjectPath, 'package.json'));
+exports.getRootProjectPackageJson = getRootProjectPackageJson;
+const getRootProjectName = () => getRootProjectPackageJson()?.match(/"name": "([^"]+)",/)?.[1] || '';
+exports.getRootProjectName = getRootProjectName;

package/dist/utils/scripts/postinstall.js

@@ -3,8 +3,9 @@
 var _configFile = require("../configFile.js");
 var _constants = require("../constants.js");
 var _file = require("../file.js");
-const projectDir = (0, _file.joinPaths)(process.cwd(), '..', '..', '..');
-const packageJson = (0, _file.getFileContent)((0, _file.joinPaths)(projectDir, 'package.json'));
+var _runtime = require("../runtime.js");
+const projectDir = (0, _runtime.getRootProjectMainDir)();
+const packageJson = (0, _runtime.getRootProjectPackageJson)(projectDir);
 let type = '';
 if (packageJson) {
   if (packageJson.includes('"nightwatch"')) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zeesoft/i18n-verify",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "description": "Library to perform I18n verification over Nightwatch or WebdriverIO frameworks",
   "main": "dist/index.js",
   "exports": {
@@ -16,7 +16,8 @@
   },
   "files": [
     "dist",
-    "readme.md"
+    "readme.md",
+    "types"
   ],
   "keywords": [
     "Zeesoft",
@@ -32,13 +33,17 @@
   "engines": {
     "node": ">=16"
   },
+  "types": "types/index.d.ts",
   "devDependencies": {
     "@babel/cli": "^7.17.0",
     "@babel/core": "^7.17.0",
     "@babel/plugin-transform-modules-commonjs": "^7.17.0",
-    "@babel/preset-env": "^7.17.0"
+    "@babel/preset-env": "^7.17.0",
+    "@types/nightwatch": "^2.3.31",
+    "@wdio/types": "^9.0.8"
   },
   "dependencies": {
+    "@types/selenium-webdriver": "^4.1.26",
     "chrono-node": "^2.7.6",
     "cldr-data": "^36.0.0",
     "console-table-printer": "^2.12.0",

package/types/index.d.ts

@@ -0,0 +1,46 @@
+import { NightwatchBrowser } from 'nightwatch';
+import { WebDriver } from 'selenium-webdriver';
+
+type Driver = NightwatchBrowser | WebdriverIO.Browser | WebDriver;
+/**
+ *
+ * @summary sets driver and locale configurations required to run the i18n verification and
+ * it should be called before calling the verify function
+ *
+ * @param driver supported browser or driver object from the automation framework
+ * @param locale current locale to run automation
+ */
+export function config(driver: Driver, locale: string): void;
+
+/**
+ * @summary sets locale
+ * @param locale
+ */
+export function setLocale(locale: string): void;
+
+/**
+ * @summary generates ASCII table and prints on the stdout
+ */
+export function genReportTable(): void;
+
+/**
+ * @summary generates Html report and saves to L10n Report Path
+ */
+export function genHtmlReport(): void;
+
+/**
+ * @summary returns current locale
+ */
+export function getLocale(): string;
+
+/**
+ * @summary performs i18n verification to the supplied selector area
+ * `Note: "config" method should be called to configure driver and locale details before starting verification`
+ *
+ * @throws {Error} when verify is unable to build runner object
+ */
+export function verify(args: {
+  verificationArea: string;
+  staticLocators: Array<string>;
+  description: string;
+}): Promise<void>;

package/dist/utils/reportsTable.js

@@ -1,71 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _constants = require("./constants.js");
-var _consoleTablePrinter = require("console-table-printer");
-var _logs = _interopRequireDefault(require("./logs.js"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-const column1 = 'STATUS';
-const column2 = 'COUNTS';
-class GenerateReportTable {
-  static #printer = new _consoleTablePrinter.Table({
-    style: {
-      headerTop: {
-        left: '\u001B[94m╔\x1b[0m',
-        mid: '\u001B[94m╦\x1b[0m',
-        right: '\u001B[94m╗\x1b[0m',
-        other: '\u001B[94m═'
-      },
-      headerBottom: {
-        left: '\u001B[94m╟\x1b[0m',
-        mid: '\u001B[94m╬\x1b[0m',
-        right: '\u001B[94m╢\x1b[0m',
-        other: '\u001B[94m═'
-      },
-      tableBottom: {
-        left: '\u001B[94m╚\x1b[0m',
-        mid: '\u001B[94m╩\x1b[0m',
-        right: '\u001B[94m╝\x1b[0m',
-        other: '\u001B[94m═\x1b[0m'
-      },
-      vertical: '\u001B[94m║\x1b[0m'
-    },
-    columns: [{
-      name: column1,
-      alignment: 'left'
-    }, {
-      name: column2,
-      alignment: 'center'
-    }]
-  });
-  static generateTable() {
-    if (_constants.REPORT_COUNTS[_constants.I18N_STATUS.REVIEWED] === 0) {
-      _logs.default.info('There are no visbile elements with UI strings');
-      return;
-    }
-    for (const key in _constants.REPORT_COUNTS) {
-      if (key !== _constants.I18N_STATUS.REVIEWED) {
-        if (_constants.REPORT_COUNTS.hasOwnProperty(key)) {
-          GenerateReportTable.#printer.addRows([{
-            STATUS: key,
-            COUNTS: `${_constants.REPORT_COUNTS[key]}`
-          }]);
-        }
-      } else {
-        GenerateReportTable.#printer.addRows([{
-          STATUS: '\u001B[94m' + '═'.repeat(28) + '\x1b[0m',
-          COUNTS: '\u001B[94m' + '═'.repeat(8) + '\x1b[0m'
-        }]);
-        GenerateReportTable.#printer.addRows([{
-          STATUS: 'OVERALL_REVIEWED',
-          COUNTS: `${_constants.REPORT_COUNTS[key]}`
-        }]);
-      }
-    }
-    GenerateReportTable.#printer.printTable();
-  }
-}
-exports.default = GenerateReportTable;