@zeesoft/i18n-verify 1.0.0

package/dist/utils/objects/statData.js

@@ -0,0 +1,365 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _constants = require("../constants");
+class StatData {
+  /**
+   * @type {Number}
+   */
+  #localizedStrings;
+  /**
+   * @type {Number}
+   */
+  #notLocalizedStrings;
+  /**
+   * @type {Number}
+   */
+  #untranslatedStrings;
+  /**
+   * @type {Number}
+   */
+  #partialStrings;
+  /**
+   * @type {Number}
+   */
+  #localizedDateTime;
+  /**
+   * @type {Number}
+   */
+  #localizedDate;
+  /**
+   * @type {Number}
+   */
+  #localizedTime;
+  /**
+   * @type {Number}
+   */
+  #notLocalizedDateTime;
+  /**
+   * @type {Number}
+   */
+  #notLocalizedDate;
+  /**
+   * @type {Number}
+   */
+  #notLocalizedTime;
+  /**
+   * @type {Number}
+   */
+  #localizedNumber;
+  /**
+   * @type {Number}
+   */
+  #notLocalizedNumber;
+  /**
+   * @type {Number}
+   */
+  #currency;
+  /**
+   * @type {Number}
+   */
+  #notLocalizedCurrency;
+  /**
+   * @type {Number}
+   */
+  #percentage;
+  /**
+   * @type {Number}
+   */
+  #notLocalizedPercentage;
+  /**
+   * @type {Number}
+   */
+  #ignore;
+  /**
+   * @type {Number}
+   */
+  #dnt;
+  /**
+   * @type {Number}
+   */
+  #autoIgnore;
+  /**
+   * @type {Number}
+   */
+  #encoding;
+  /**
+   * @type {Number}
+   */
+  #truncation;
+  /**
+   * @type {Number}
+   */
+  #overlapping;
+  /**
+   * @type {Number}
+   */
+  #reviewed;
+  constructor(data = {}) {
+    this.#localizedStrings = data?.localizedStrings || 0;
+    this.#notLocalizedStrings = data?.notLocalizedStrings || 0;
+    this.#untranslatedStrings = data?.untranslatedStrings || 0;
+    this.#partialStrings = data?.partialStrings || 0;
+    this.#localizedDateTime = data?.localizedDateTime || 0;
+    this.#localizedDate = data?.localizedDate || 0;
+    this.#localizedTime = data?.localizedTime || 0;
+    this.#notLocalizedDateTime = data?.notLocalizedDateTime || 0;
+    this.#notLocalizedDate = data?.notLocalizedDate || 0;
+    this.#notLocalizedTime = data?.notLocalizedTime || 0;
+    this.#localizedNumber = data?.localizedNumber || 0;
+    this.#notLocalizedNumber = data?.notLocalizedNumber || 0;
+    this.#currency = data?.currency || 0;
+    this.#notLocalizedCurrency = data?.notLocalizedCurrency || 0;
+    this.#percentage = data?.percentage || 0;
+    this.#notLocalizedPercentage = data?.notLocalizedPercentage || 0;
+    this.#ignore = data?.ignore || 0;
+    this.#dnt = data?.dnt || 0;
+    this.#autoIgnore = data?.autoIgnore || 0;
+    this.#encoding = data?.encoding || 0;
+    this.#truncation = data?.truncation || 0;
+    this.#overlapping = data?.overlapping || 0;
+    this.#reviewed = data?.reviewed || 0;
+  }
+  getLocalizedStrings() {
+    return this.#localizedStrings;
+  }
+  setLocalizedStrings(translatedStrings) {
+    this.#localizedStrings = translatedStrings;
+  }
+  getUntranslatedStrings() {
+    return this.#untranslatedStrings;
+  }
+  setUntranslatedStrings(untranslatedStrings) {
+    this.#untranslatedStrings = untranslatedStrings;
+  }
+  getNotLocalizedStrings() {
+    return this.#notLocalizedStrings;
+  }
+  setNotLocalizedStrings(notLocalizedStrings) {
+    this.#notLocalizedStrings = notLocalizedStrings;
+  }
+  getPartialStrings() {
+    return this.#partialStrings;
+  }
+  setPartialStrings(partialStrings) {
+    this.#partialStrings = partialStrings;
+  }
+  getLocalizedDateTime() {
+    return this.#localizedDateTime;
+  }
+  setLocalizedDateTime(localizedDateTime) {
+    this.#localizedDateTime = localizedDateTime;
+  }
+  getLocalizedDate() {
+    return this.#localizedDate;
+  }
+  setLocalizedDate(localizedDate) {
+    this.#localizedDate = localizedDate;
+  }
+  getLocalizedTime() {
+    return this.#localizedTime;
+  }
+  setLocalizedTime(localizedTime) {
+    this.#localizedTime = localizedTime;
+  }
+  getNotLocalizedDateTime() {
+    return this.#notLocalizedDateTime;
+  }
+  setNotLocalizedDateTime(notLocalizedDateTime) {
+    this.#notLocalizedDateTime = notLocalizedDateTime;
+  }
+  getNotLocalizedDate() {
+    return this.#notLocalizedDate;
+  }
+  setNotLocalizedDate(notLocalizedDate) {
+    this.#notLocalizedDate = notLocalizedDate;
+  }
+  getNotLocalizedTime() {
+    return this.#notLocalizedTime;
+  }
+  setNotLocalizedTime(notLocalizedTime) {
+    this.#notLocalizedTime = notLocalizedTime;
+  }
+  getLocalizedNumber() {
+    return this.#localizedNumber;
+  }
+  setLocalizedNumber(localizedNumber) {
+    this.#localizedNumber = localizedNumber;
+  }
+  getNotLocalizeNumber() {
+    return this.#notLocalizedNumber;
+  }
+  setNotLocalizeNumber(notLocalizedNumber) {
+    this.#notLocalizedNumber = notLocalizedNumber;
+  }
+  getCurrency() {
+    return this.#currency;
+  }
+  setCurrency(currency) {
+    this.#currency = currency;
+  }
+  getNotLocalizeCurrency() {
+    return this.#notLocalizedCurrency;
+  }
+  setNotLocalizeCurrency(notLocalizedCurrency) {
+    this.#notLocalizedCurrency = notLocalizedCurrency;
+  }
+  getPercentage() {
+    return this.#percentage;
+  }
+  setPercentage(percentage) {
+    this.#percentage = percentage;
+  }
+  getNotLocalizePercentage() {
+    return this.#notLocalizedPercentage;
+  }
+  setNotLocalizePercentage(notLocalizedPercentage) {
+    this.#notLocalizedPercentage = notLocalizedPercentage;
+  }
+  getIgnore() {
+    return this.#ignore;
+  }
+  setIgnore(ignore) {
+    this.#ignore = ignore;
+  }
+  getDnt() {
+    return this.#dnt;
+  }
+  setDnt(dnt) {
+    this.#dnt = dnt;
+  }
+  getAutoIgnore() {
+    return this.#autoIgnore;
+  }
+  setAutoIgnore(autoIgnore) {
+    this.#autoIgnore = autoIgnore;
+  }
+  getEncoding() {
+    return this.#encoding;
+  }
+  setEncoding(encoding) {
+    this.#encoding = encoding;
+  }
+  getTruncation() {
+    return this.#truncation;
+  }
+  setTruncation(truncation) {
+    this.#truncation = truncation;
+  }
+  getOverlapping() {
+    return this.#overlapping;
+  }
+  setOverlapping(overlapping) {
+    this.#overlapping = overlapping;
+  }
+  getReviewed() {
+    return this.#reviewed;
+  }
+  setReviewed(reviewed) {
+    this.#reviewed = reviewed;
+  }
+  incrementByType(type) {
+    switch (type) {
+      case _constants.I18N_STATUS.STRING_LOCALIZED:
+        ++this.#localizedStrings;
+        break;
+      case _constants.I18N_STATUS.STRING_NOT_LOCALIZED:
+        ++this.#notLocalizedStrings;
+        break;
+      case _constants.I18N_STATUS.UNTRANSLATED:
+        ++this.#untranslatedStrings;
+        break;
+      case _constants.I18N_STATUS.STRING_PARTIALLY_LOCALIZED:
+        ++this.#partialStrings;
+        break;
+      case _constants.I18N_STATUS.AUTO_IGNORE:
+        ++this.#autoIgnore;
+        break;
+      case _constants.I18N_STATUS.IGNORE:
+        ++this.#ignore;
+        break;
+      case _constants.I18N_STATUS.DNT:
+        ++this.#dnt;
+        break;
+      case _constants.I18N_STATUS.ENCODING_ISSUE:
+        ++this.#encoding;
+        break;
+      case _constants.I18N_STATUS.DATE_LOCALIZED:
+        ++this.#localizedDate;
+        break;
+      case _constants.I18N_STATUS.TIME_LOCALIZED:
+        ++this.#localizedTime;
+        break;
+      case _constants.I18N_STATUS.DATE_TIME_LOCALIZED:
+        ++this.#localizedDateTime;
+        break;
+      case _constants.I18N_STATUS.DATE_NOT_LOCALIZED:
+        ++this.#notLocalizedDate;
+        break;
+      case _constants.I18N_STATUS.TIME_NOT_LOCALIZED:
+        ++this.#notLocalizedTime;
+        break;
+      case _constants.I18N_STATUS.DATE_TIME_NOT_LOCALIZED:
+        ++this.#notLocalizedDateTime;
+        break;
+      case _constants.I18N_STATUS.NUMBER_LOCALIZED:
+        ++this.#localizedNumber;
+        break;
+      case _constants.I18N_STATUS.NUMBER_NOT_LOCALIZED:
+        ++this.#notLocalizedNumber;
+        break;
+      case _constants.I18N_STATUS.CURRENCY_LOCALIZED:
+        ++this.#currency;
+        break;
+      case _constants.I18N_STATUS.CURRENCY_NOT_LOCALIZED:
+        ++this.#notLocalizedCurrency;
+        break;
+      case _constants.I18N_STATUS.PERCENTAGE_LOCALIZED:
+        ++this.#percentage;
+        break;
+      case _constants.I18N_STATUS.PERCENTAGE_NOT_LOCALIZED:
+        ++this.#notLocalizedPercentage;
+        break;
+      case _constants.I18N_STATUS.TRUNCATION_ISSUE:
+        ++this.#truncation;
+        break;
+      case _constants.I18N_STATUS.OVERLAPPING_ISSUE:
+        ++this.#overlapping;
+        break;
+      case _constants.I18N_STATUS.REVIEWED:
+        ++this.#reviewed;
+        break;
+    }
+  }
+  toJSON() {
+    return {
+      localizedStrings: this.#localizedStrings,
+      notLocalizedStrings: this.#notLocalizedStrings,
+      untranslatedStrings: this.#untranslatedStrings,
+      partialStrings: this.#partialStrings,
+      localizedDateTime: this.#localizedDateTime,
+      localizedDate: this.#localizedDate,
+      localizedTime: this.#localizedTime,
+      notLocalizedDateTime: this.#notLocalizedDateTime,
+      notLocalizedDate: this.#notLocalizedDate,
+      notLocalizedTime: this.#notLocalizedTime,
+      localizedNumber: this.#localizedNumber,
+      notLocalizedNumber: this.#notLocalizedNumber,
+      currency: this.#currency,
+      notLocalizedCurrency: this.#notLocalizedCurrency,
+      percentage: this.#percentage,
+      notLocalizedPercentage: this.#notLocalizedPercentage,
+      ignore: this.#ignore,
+      dnt: this.#dnt,
+      autoIgnore: this.#autoIgnore,
+      encoding: this.#encoding,
+      truncation: this.#truncation,
+      overlapping: this.#overlapping,
+      reviewed: this.#reviewed
+    };
+  }
+}
+exports.default = StatData;

package/dist/utils/objects/stringData.js

@@ -0,0 +1,67 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _stringInfo = _interopRequireDefault(require("./stringInfo.js"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+class StringData {
+  /**
+   * @type {{[key: string]: StringInfo[]}}
+   */
+  #data = {};
+  constructor(data) {
+    if (data?.data) {
+      data = data.data;
+      for (const string in data) {
+        data[string].forEach(info => {
+          if (!this.#data[string]) {
+            this.#data[string] = [];
+          }
+          this.#data[string].push(new _stringInfo.default(info));
+        });
+      }
+    }
+  }
+  getStringData(string) {
+    return this.#data[string];
+  }
+  setStringData(string, info) {
+    !this.#data[string] && (this.#data[string] = []);
+    this.#data[string].push(new _stringInfo.default(info));
+    return true;
+  }
+  checkAndAdd(string, info) {
+    !this.#data[string] && (this.#data[string] = []);
+    const canAdd = this.getStringData(string).some(data => data.getDescription() !== info.getDescription || data.getType() !== info.imagePath || data.getType() !== data.type);
+    if (canAdd) {
+      this.setStringData(string, info);
+    }
+    return canAdd;
+  }
+  hasStringData(string) {
+    return string in this.#data;
+  }
+
+  /**
+   *
+   * @param {String} string
+   * @param {Object[] | Object} info
+   * @returns {StringData}
+   */
+  static createNew(string, info) {
+    info = Array.isArray(info) ? info : [info];
+    return new StringData({
+      data: {
+        [string]: info
+      }
+    });
+  }
+  toJSON() {
+    return {
+      data: this.#data
+    };
+  }
+}
+exports.default = StringData;

package/dist/utils/objects/stringInfo.js

@@ -0,0 +1,51 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+class StringInfo {
+  /**
+   * @type {String}
+   */
+  #type;
+  /**
+   * @type {String}
+   */
+  #imagePath;
+  /**
+   * @type {String}
+   */
+  #description;
+  constructor(data) {
+    this.#type = data?.type || '';
+    this.#imagePath = data?.imagePath || '';
+    this.#description = data?.description || '';
+  }
+  getType() {
+    return this.#type;
+  }
+  setType(type) {
+    this.#type = type;
+  }
+  getImagePath() {
+    return this.#imagePath;
+  }
+  setImagePath(imagePath) {
+    this.#imagePath = imagePath;
+  }
+  getDescription() {
+    return this.#description;
+  }
+  setDescription(description) {
+    this.#description = description;
+  }
+  toJSON() {
+    return {
+      type: this.#type,
+      description: this.#description,
+      imagePath: this.#imagePath
+    };
+  }
+}
+exports.default = StringInfo;

package/dist/utils/regex.js

@@ -0,0 +1,8 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getSpacePattern = void 0;
+const getSpacePattern = (asStr = true) => asStr ? '(?:\\s|\\t|(?: ))' : /(?:\s|\t|(?: ))/g;
+exports.getSpacePattern = getSpacePattern;

package/dist/utils/reportFactory/base.js

@@ -0,0 +1,51 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _logs = _interopRequireDefault(require("../logs.js"));
+var _reportData = _interopRequireDefault(require("../objects/reportData.js"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+class BaseReport {
+  /**
+   * @type {ReportData}
+   */
+  #reportData;
+  /**
+   * @type {String | any}
+   */
+  $generatedContent;
+  /**
+   * @type {String}
+   */
+  $type;
+  constructor(type) {
+    this.$type = type;
+  }
+  generate(data) {
+    this.#reportData = data;
+    this.$generatedContent = this.buildContent();
+  }
+  export(path, name = 'report') {
+    this.write(path, name, this.$generatedContent);
+    _logs.default.info(`Wrote I18n Verification ${this.$type} report in ${path}/${name}`);
+  }
+  write(path, name, data) {
+    throw new Error('should be implemented by child report classes');
+  }
+  buildContent() {
+    throw new Error('should be implemented by child report classes');
+  }
+  getMetaInfo() {
+    return {
+      appName: this.#reportData.getAppName(),
+      locales: this.#reportData.getData().getLocales(),
+      stats: this.#reportData.getData().getMetaData().getStat(),
+      statsByLocale: this.#reportData.getData().getMetaData().getStatByLocale(),
+      reportTime: this.#reportData.getReportTime(),
+      stringData: this.#reportData.getData().getLocaleStringData()
+    };
+  }
+}
+exports.default = BaseReport;

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

@@ -0,0 +1,36 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _constants = require("../../constants.js");
+var _file = require("../../file.js");
+var _logs = _interopRequireDefault(require("../../logs.js"));
+var _base = _interopRequireDefault(require("../base.js"));
+var _css = require("./template/css.js");
+var _html = require("./template/html.js");
+var _javascript = require("./template/javascript.js");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+class HtmlReport extends _base.default {
+  constructor() {
+    super(_constants.SUPPORTED_REPORT_TYPES.HTML);
+  }
+  buildContent() {
+    const metaInfo = this.getMetaInfo();
+    const script = (0, _javascript.getJsData)(metaInfo);
+    const style = (0, _css.getCssData)();
+    const body = (0, _html.getBodyData)(metaInfo);
+    return (0, _html.renderHtml)({
+      appName: metaInfo.appName,
+      reportTime: metaInfo.reportTime,
+      body,
+      script,
+      style
+    });
+  }
+  write(path, name, data) {
+    (0, _file.saveToFile)((0, _file.joinPaths)(path, `${name}.html`), data, 'utf-8');
+  }
+}
+exports.default = HtmlReport;

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

@@ -0,0 +1,133 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getCssData = void 0;
+const getCssData = () => `
+  * {
+    user-select: none;
+  }
+
+  body {
+    margin: 0;
+    display: flex;
+    flex-direction: column;
+    font-family: Arial, sans-serif;
+  }
+
+  header {
+    background-color: #333;
+    height: 5rem;
+  }
+
+  main {
+    display: flex;
+    direction: column;
+    width: 100%;
+    height: calc(100vh - 5rem);
+  }
+
+  .sidebar {
+    width: 250px;
+    height: 100%;
+    background-color: #333;
+    color: #fff;
+    padding: 20px;
+    box-sizing: border-box;
+    float: left;
+  }
+
+  .logo {
+    font-size: 2rem;
+    letter-spacing: 0.1rem;
+    color: #14cf96;
+    font-weight: bold;
+    padding-top: 1.8rem;
+    padding-left: 2rem;
+  }
+
+  .menu {
+    list-style-type: none;
+    padding: 0;
+    margin: 0;
+  }
+
+  .menu-item {
+    margin-bottom: 10px;
+  }
+
+  .menu-item a {
+    color: #fff;
+    text-decoration: none;
+    display: block;
+    padding: 10px;
+    border-radius: 5px;
+    font-size: 1.05rem;
+  }
+
+  .menu-item a:hover {
+    background-color: #555;
+  }
+
+  .submenu {
+    display: none;
+    list-style-type: none;
+    padding-left: 20px;
+  }
+
+  .menu-item.has-submenu > a::after {
+    content: '▼';
+    float: right;
+    margin-left: 5px;
+  }
+
+  .menu-item.selected > a {
+    background-color: #555;
+  }
+
+  .submenu .sub-menu-item a:hover {
+    background-color: #777;
+  }
+
+  .submenu .sub-menu-item.selected a {
+    background-color: #555 !important;
+  }
+
+  .submenu.active {
+    display: block !important;
+  }
+
+  .content-wrapper {
+    padding: 20px;
+    float: left;
+    width: calc(100% - 250px);
+    background-color: #f4f4f4;
+  }
+
+  .content {
+    display: none;
+  }
+
+  .content .title {
+    font-size: 1rem;
+    color: #080404e2;
+  }
+
+  .content .title::after {
+    content: ':';
+  }
+
+  .content.active {
+    display: flex !important;
+    flex-direction: column;
+    gap: 1rem;
+  }
+
+  @media (max-width: 768px) {
+    .sidebar {
+      width: 100%;
+      padding: 10px;
+    }
+  }`;
+exports.getCssData = getCssData;