@zeesoft/i18n-verify 1.0.0

package/dist/utils/reportFactory/html/template/html.js

@@ -0,0 +1,79 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.renderHtml = exports.getBodyData = void 0;
+const renderHtml = ({
+  appName,
+  reportTime,
+  script,
+  style,
+  body
+}) => `<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="charset" content="charset='UTF-8'" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <meta name="company" content="Zeesoft" />
+    <meta name="author" content="Jitendra Maheshwari" />
+    <meta name="email" content="jm@zeesoft.com" />
+    <meta
+      name="description"
+      content="I18n verification report"
+    />
+    <title>I18n Verification Report | ${reportTime}</title>
+    <style>
+      ${style}
+    </style>
+    <script type="text/javascript">
+      ${script}
+    </script>
+  </head>
+  <body>
+    ${body}
+  </body>
+</html>
+`;
+exports.renderHtml = renderHtml;
+const getBodyData = () => ` <header><div class="logo">zI18n-Verify</div></header>
+    <main>
+      <div class="sidebar">
+        <ul class="menu" id="menu">
+          <li class="menu-item" data-page="overview">
+            <a href="#">Overview</a>
+          </li>
+          <li class="menu-item has-submenu" data-page="insights">
+            <a href="#" data-page="insights">Insights</a>
+            <ul class="submenu">
+              <li class="sub-menu-item" data-locale="en_US">
+                <a href="#">en_US</a>
+              </li>
+              <li class="sub-menu-item" data-locale="fr_CA">
+                <a href="#">fr_CA</a>
+              </li>
+            </ul>
+          </li>
+        </ul>
+      </div>
+      <div class="content-wrapper">
+        <div id="overview" class="content">
+          <div class="overall-quality">
+            <span class="title">Overall I18n Quality</span>
+          </div>
+          <div><span class="title">String Quality</span></div>
+          <div><span class="title">Number Quality</span></div>
+          <div><span class="title">DateTime Quality</span></div>
+        </div>
+        <div id="insights" class="content">
+          <div class="cards">
+            <span class="title">Locale wise info cards</span>
+          </div>
+        </div>
+        <div id="locale" class="content">
+          <div class="string-data"><span class="title">String Data</span></div>
+        </div>
+      </div>
+    </main>`;
+exports.getBodyData = getBodyData;

package/dist/utils/reportFactory/html/template/javascript.js

@@ -0,0 +1,106 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getJsData = void 0;
+var _dateTime = require("../../../dateTime");
+var _apex = _interopRequireDefault(require("./includes/apex.js"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+const getJsData = ({
+  stats,
+  statsByLocale,
+  locales
+}) => `
+  ${getIncludes()}
+  ${getSideMenuConfig()}
+  ${getOverviewContent()}
+  ${getInsightsContent()}
+  ${getLocaleSpecificContent()}
+  `;
+exports.getJsData = getJsData;
+const getIncludes = () => `
+  // 3rd party sources
+  ${(0, _apex.default)()}
+`;
+const getOverviewContent = () => `
+  //Overview
+  
+`;
+const getInsightsContent = () => `//Cards of locales`;
+const getLocaleSpecificContent = () => `//Choosen locale`;
+const getSideMenuConfig = () => `// for sidebar menu
+  (() => {
+    const loadContent = (section) => {
+      const contents = document.querySelectorAll('.content');
+      contents.forEach((content) => {
+        content.id !== section
+          ? content.classList.remove('active')
+          : content.classList.add('active');
+      });
+    };
+
+    document.addEventListener('DOMContentLoaded', function () {
+      const menuItems = document.querySelectorAll('.menu-item'),
+        submenuItems = document.querySelectorAll('.sub-menu-item');
+
+      menuItems.forEach((item) => {
+        item.addEventListener('click', function (event) {
+          const selectedMenuItem = document.querySelector(
+              '.menu-item.selected'
+            ),
+            selectedSubmenu = document.querySelector('.submenu.active'),
+            page = item.dataset.page;
+
+          if (selectedMenuItem) {
+            selectedMenuItem.classList.remove('selected');
+          }
+
+          if (selectedSubmenu) {
+            selectedSubmenu.classList.remove('active');
+          }
+
+          if (item.classList.contains('has-submenu')) {
+            event.preventDefault();
+            item.classList.add('selected');
+            const submenu = item.querySelector('.submenu');
+            submenu.classList.add('active');
+          } else {
+            item.classList.add('selected');
+            if (selectedSubmenu) {
+              selectedSubmenu
+                .querySelectorAll('.sub-menu-item')
+                .forEach((submenuItem) => {
+                  submenuItem.textContent !== item.textContent &&
+                    submenuItem.classList.remove('selected');
+                });
+            }
+          }
+
+          loadContent(page);
+        });
+
+        loadContent('overview');
+      });
+
+      submenuItems.forEach((sItem) => {
+        sItem.addEventListener('click', function (event) {
+          const selectedSubMenuItem = document.querySelector(
+            '.sub-menu-item.selected'
+          );
+          event.preventDefault();
+          event.stopPropagation();
+
+          if (selectedSubMenuItem) {
+            selectedSubMenuItem.classList.remove('selected');
+          }
+          sItem.classList.add('selected');
+          loadContent('locale');
+        });
+      });
+
+      // update footer info
+      const footer = document.querySelector('.sidebar .footer');
+      footer.textContent = '${(0, _dateTime.getCurrentYear)()} @ Zeesoft. All rights reserved.';
+    });
+  })();`;

package/dist/utils/reportFactory/index.js

@@ -0,0 +1,38 @@
+"use strict";
+
+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");
+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();
+      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 appName = (0, _runtime.getRootProjectName)();
+    const reportData = new _reportData.default({
+      data,
+      appName,
+      reportTime
+    });
+    builder.generate(reportData);
+    builder.export(path, name);
+  }
+}
+exports.default = ReportFactory;

package/dist/utils/reports.js

@@ -0,0 +1,120 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _path = _interopRequireDefault(require("path"));
+var _config = _interopRequireDefault(require("../lib/config.js"));
+var _file = require("./file.js");
+var _constants = require("../utils/constants.js");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+class Reports {
+  static #baseReportPath;
+  static setup() {
+    const rootFolder = _path.default.resolve();
+    Reports.#baseReportPath = (0, _file.joinPaths)(rootFolder, 'l10nReports', Reports.#dateTime());
+  }
+  static reviewedReports(str = null, imgName = null) {
+    return Reports.#generateFullReportPath('reviewed', str, imgName);
+  }
+  static [_constants.I18N_STATUS.STRING_LOCALIZED](str, imgName) {
+    return Reports.#generateFullReportPath('string_localized', str, imgName);
+  }
+  static [_constants.I18N_STATUS.STRING_NOT_LOCALIZED](str, imgName) {
+    return Reports.#generateFullReportPath('string_not_localized', str, imgName);
+  }
+  static [_constants.I18N_STATUS.STRING_PARTIALLY_LOCALIZED](str, imgName) {
+    return Reports.#generateFullReportPath('string_partially_localized', str, imgName);
+  }
+  static [_constants.I18N_STATUS.DNT](str, imgName) {
+    return Reports.#generateFullReportPath('dnt', str, imgName);
+  }
+  static [_constants.I18N_STATUS.IGNORE](str, imgName) {
+    return Reports.#generateFullReportPath('ignored', str, imgName);
+  }
+  static [_constants.I18N_STATUS.AUTO_IGNORE](str, imgName) {
+    return Reports.#generateFullReportPath('auto_ignored', str, imgName);
+  }
+  static [_constants.I18N_STATUS.UNTRANSLATED](str, imgName) {
+    return Reports.#generateFullReportPath('un_translated', str, imgName);
+  }
+  static [_constants.I18N_STATUS.ENCODING_ISSUE](str, imgName) {
+    return Reports.#generateFullReportPath('encoding_issue', str, imgName);
+  }
+  static [_constants.I18N_STATUS.DATE_TIME_LOCALIZED](str, imgName) {
+    return Reports.#generateFullReportPath('date_time_localized', str, imgName);
+  }
+  static [_constants.I18N_STATUS.DATE_TIME_NOT_LOCALIZED](str, imgName) {
+    return Reports.#generateFullReportPath('date_time_not_localized', str, imgName);
+  }
+  static [_constants.I18N_STATUS.DATE_LOCALIZED](str, imgName) {
+    return Reports.#generateFullReportPath('date_localized', str, imgName);
+  }
+  static [_constants.I18N_STATUS.DATE_NOT_LOCALIZED](str, imgName) {
+    return Reports.#generateFullReportPath('date_not_localized', str, imgName);
+  }
+  static [_constants.I18N_STATUS.TIME_LOCALIZED](str, imgName) {
+    return Reports.#generateFullReportPath('time_localized', str, imgName);
+  }
+  static [_constants.I18N_STATUS.TIME_NOT_LOCALIZED](str, imgName) {
+    return Reports.#generateFullReportPath('time_not_localized', str, imgName);
+  }
+  static [_constants.I18N_STATUS.CURRENCY_LOCALIZED](str, imgName) {
+    return Reports.#generateFullReportPath('currency_localized', str, imgName);
+  }
+  static [_constants.I18N_STATUS.CURRENCY_NOT_LOCALIZED](str, imgName) {
+    return Reports.#generateFullReportPath('currency_not_localized', str, imgName);
+  }
+  static [_constants.I18N_STATUS.PERCENTAGE_LOCALIZED](str, imgName) {
+    return Reports.#generateFullReportPath('percentage_localized', str, imgName);
+  }
+  static [_constants.I18N_STATUS.PERCENTAGE_NOT_LOCALIZED](str, imgName) {
+    return Reports.#generateFullReportPath('percentage_not_localized', str, imgName);
+  }
+  static [_constants.I18N_STATUS.NUMBER_LOCALIZED](str, imgName) {
+    return Reports.#generateFullReportPath('number_localized', str, imgName);
+  }
+  static [_constants.I18N_STATUS.NUMBER_NOT_LOCALIZED](str, imgName) {
+    return Reports.#generateFullReportPath('number_not_localized', str, imgName);
+  }
+  static incrementCount(propertyName) {
+    if (_constants.REPORT_COUNTS.hasOwnProperty(propertyName)) {
+      _constants.REPORT_COUNTS[propertyName]++;
+    }
+  }
+  static #dateTime() {
+    const now = new Date();
+    const year = now.getFullYear();
+    const month = String(now.getMonth() + 1).padStart(2, '0');
+    const day = String(now.getDate()).padStart(2, '0');
+    const hours = String(now.getHours()).padStart(2, '0');
+    const minutes = String(now.getMinutes()).padStart(2, '0');
+    const timeStamp = `${year}-${month}-${day}-${hours}-${minutes}`;
+    return timeStamp;
+  }
+  static #generateFullReportPath = (type, str, imgName) => {
+    const _screenshotPath = (0, _file.joinPaths)(Reports.#baseReportPath, _config.default.getLocale(), 'screenshots', type);
+    (0, _file.ensureDirectoryExists)(_screenshotPath, _constants.DEBUG_MODE);
+    const _stringsPath = (0, _file.joinPaths)(Reports.#baseReportPath, _config.default.getLocale(), 'strings');
+    (0, _file.ensureDirectoryExists)(_stringsPath, _constants.DEBUG_MODE);
+    if (str !== null && str !== undefined) {
+      let content = '';
+      if ((0, _file.pathExists)((0, _file.joinPaths)(_stringsPath, type + '.txt'))) {
+        const existingContent = (0, _file.getFileContent)((0, _file.joinPaths)(_stringsPath, type + '.txt'));
+        if (existingContent.includes(imgName)) {
+          content += str;
+        } else {
+          content += `\n|<<<<<<<<<<<<<------${imgName}------>>>>>>>>>>>>>|\n`;
+          content += str;
+        }
+      } else {
+        content += `\n|<<<<<<<<<<<<<------${imgName}------>>>>>>>>>>>>>|\n`;
+        content += str;
+      }
+      (0, _file.addContentToFile)((0, _file.joinPaths)(_stringsPath, type + '.txt'), content);
+    }
+    return _screenshotPath;
+  };
+}
+exports.default = Reports;

package/dist/utils/reportsTable.js

@@ -0,0 +1,71 @@
+"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;

package/dist/utils/resource.js

@@ -0,0 +1,54 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+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() {
+    const bundle = {};
+    if (_config.default.getOptions()?.l10nResourcePath) {
+      const resourcePath = (0, _file.joinPaths)(process.cwd(), _config.default.getOptions()?.l10nResourcePath);
+      if ((0, _file.fileExists)(resourcePath)) {
+        Resource.#processFile(resourcePath, bundle);
+      } else if ((0, _file.dirExists)(resourcePath)) {
+        for (const file of (0, _file.getDirContents)(resourcePath)) {
+          const filePath = (0, _file.joinPaths)(resourcePath, file);
+          Resource.#processFile(filePath, bundle);
+        }
+      } else {
+        _logs.default.error(`${resourcePath} invalid resource path`);
+        return; // throw runtime error
+      }
+      _config.default.setResourceBundle(bundle);
+    }
+  }
+  static #processFile(filePath, bundle) {
+    const locale = _config.default.getLocale(),
+      defaultLocale = _config.default.getDefaultLocale(),
+      fileContent = (0, _file.getFileContent)(filePath),
+      ext = (0, _file.getFileExtenstion)(filePath);
+    if (_constants.RES_FILE_EXTENSIONS.includes(ext)) {
+      if (!fileContent) {
+        _logs.default.error(`${filePath} is empty or invalid`);
+        return;
+      }
+      if (filePath.toLowerCase().includes('dnt')) {
+        bundle['dnt'] = fileContent.split(/\r?\n/);
+      } else if (filePath.toLowerCase().includes('ignore')) {
+        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/);
+      } else if (filePath.includes(defaultLocale)) {
+        bundle[defaultLocale] = fileContent.split(/\r?\n/);
+      }
+    }
+  }
+}
+exports.default = Resource;

package/dist/utils/runtime.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.loadDependencies = void 0;
+var _index = _interopRequireDefault(require("../lib/validator/index.js"));
+var _reports = _interopRequireDefault(require("./reports.js"));
+var _resource = _interopRequireDefault(require("./resource.js"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+const loadDependencies = () => {
+  _resource.default.load();
+  _index.default.load();
+  _reports.default.setup();
+};
+exports.loadDependencies = loadDependencies;

package/dist/utils/scripts/genreport.js

@@ -0,0 +1 @@
+"use strict";

package/dist/utils/scripts/postinstall.js

@@ -0,0 +1,21 @@
+"use strict";
+
+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'));
+let type = '';
+if (packageJson) {
+  if (packageJson.includes('"nightwatch"')) {
+    type = _constants.SYSTEM_TYPES.NIGHT_WATCH;
+  } else if (packageJson.includes('"cypress"')) {
+    type = _constants.SYSTEM_TYPES.CYPRESS;
+  } else if (packageJson.includes('"@wdio"') || packageJson.includes('@wdio')) {
+    type = _constants.SYSTEM_TYPES.WEB_DRIVER_IO;
+  } else if (packageJson.includes('"selenium-webdriver"')) {
+    type = _constants.SYSTEM_TYPES.SELENIUMJS;
+  }
+}
+(0, _configFile.checkAndExportConfig)((0, _file.joinPaths)(projectDir, _constants.CONFIG_FILE_NAME), type);
+console.log(`Added ${_constants.CONFIG_FILE_NAME} to project root directory. Please use the file to configure i18n verification!`);

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@zeesoft/i18n-verify",
+  "version": "1.0.0",
+  "description": "Library to perform I18n verification over Nightwatch or WebdriverIO frameworks",
+  "main": "dist/index.js",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "babel src -d dist --delete-dir-on-start --copy-files",
+    "prepack": "npm run build",
+    "postinstall": "node dist/utils/scripts/postinstall.js"
+  },
+  "files": [
+    "dist",
+    "readme.md"
+  ],
+  "keywords": [
+    "Zeesoft",
+    "Internationalization",
+    "Internationalization Verification",
+    "I18n",
+    "I18n Verification",
+    "I18n Automation",
+    "I18n Report"
+  ],
+  "author": "Jitendra Maheshwari<jm@zeesoft.com>",
+  "license": "MIT",
+  "engines": {
+    "node": ">=16"
+  },
+  "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"
+  },
+  "dependencies": {
+    "chrono-node": "^2.7.6",
+    "cldr-data": "^36.0.0",
+    "console-table-printer": "^2.12.0",
+    "global": "^4.4.0",
+    "globalize": "^1.7.0",
+    "jimp": "^0.22.12",
+    "luxon": "^3.4.4",
+    "tinyld": "^1.3.4"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitlab.com/zeesoft/qa.git"
+  },
+  "bugs": {
+    "url": "https://gitlab.com/zeesoft/qa/issues"
+  },
+  "homepage": "https://gitlab.com/zeesoft/qa/-/blob/zlqa/i18n-verify/readme.md"
+}

package/readme.md

@@ -0,0 +1,15 @@
+## i18n-verify library usage guide
+
+- after installation, the library will auto create .i18nVerify.rc file with required conguration template
+- you can configure the following properties
+- `qaLocale` supply qa locale value if your application uses one
+- `l10nResourcePath` directory of l10n resources which will be used by the library to perform i18n verification
+- `defaultLocale` default locale of your application
+- `qaMock` prefix and suffix characters used by qa locale
+- `garbledChars` list of garbled characters which the library will use to skip while processing i18n verification
+
+**TODO**
+
+- [] modify .i18nVerify.rc property names to be more user friendly
+- [] add support for html report
+- [] add support for iframe strings capturing and highlighting