@orderly.network/i18n 2.10.2 → 3.0.0-beta.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orderly.network/i18n",
-  "version": "2.10.2",
+  "version": "3.0.0-beta.0",
   "description": "Internationalization for orderly sdk",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -48,7 +48,7 @@
     "tsup": "^8.5.1",
     "typescript": "^5.1.6",
     "yargs": "^17.7.2",
-    "tsconfig": "0.13.2"
+    "tsconfig": "1.0.0-beta.0"
   },
   "peerDependencies": {
     "react": ">=18",
@@ -61,15 +61,15 @@
     "cli": "node ./bin/cli.js",
     "csv2json": "pnpm cli csv2json ./dist/locale.csv ./dist/locales",
     "json2csv": "pnpm cli json2csv ./dist/locales ./dist/locale.csv",
-    "generateCsv": "pnpm cli generateCsv ./dist/locale.csv",
+    "generateCsv": "pnpm cli generateCsv ./locales ./dist/locale.csv",
     "diffcsv": "pnpm cli diffcsv ./dist/locale1.csv ./dist/locale2.csv",
     "fillJson": "pnpm cli fillJson ./src/locale/zh.json ./dist/locale/zh.json",
     "separateJson": "pnpm cli separateJson ./locales ./dist/locales extend",
     "mergeJson": "pnpm cli mergeJson ./locales ./dist/locales",
     "mergeExtendJson": "pnpm cli mergeJson ./locales ./locales",
-    "_generateEnJson": "node ./script/generateEnJson.js",
-    "generateEnJson": "pnpm tsup && node ./script/generateEnJson.js",
-    "copyLocales": "node ./script/copyLocales.js",
-    "generateMissingKeys": "pnpm tsup && pnpm _generateEnJson && node ./script/generateMissingKeys.js"
+    "_generateEnJson": "node ./scripts/generateEnJson.js",
+    "generateEnJson": "pnpm tsup && node ./scripts/generateEnJson.js",
+    "copyLocales": "node ./scripts/copyLocales.js",
+    "generateMissingKeys": "pnpm tsup && pnpm _generateEnJson && node ./scripts/generateMissingKeys.js"
   }
 }

package/script/copyLocales.js

@@ -1,11 +0,0 @@
-const fs = require("fs-extra");
-const path = require("path");
-
-async function copyLocales() {
-  await fs.copy(
-    path.resolve(__dirname, "../locales"),
-    path.resolve(__dirname, "../dist/locales")
-  );
-}
-
-copyLocales();

package/script/csv2json.js

@@ -1,28 +0,0 @@
-const fs = require("fs-extra");
-const path = require("path");
-const { csv2multiJson } = require("./json-csv-converter");
-const { checkFileExists } = require("./utils");
-
-/** Convert locale CSV to multiple locale JSON files */
-async function csv2json(inputPath, outputDir) {
-  const csv = fs.readFileSync(inputPath, { encoding: "utf8" });
-
-  const json = csv2multiJson(csv);
-
-  const files = [];
-
-  for (const key of Object.keys(json)) {
-    const filePath = path.resolve(outputDir, `${key}.json`);
-    await checkFileExists(filePath);
-    await fs.outputFile(filePath, JSON.stringify(json[key], undefined, 4), {
-      encoding: "utf8",
-    });
-    files.push(filePath);
-  }
-
-  console.log("csv2json success =>", files);
-}
-
-module.exports = {
-  csv2json,
-};

package/script/diffCsv.js

@@ -1,175 +0,0 @@
-const fs = require("fs-extra");
-const path = require("path");
-const { csv2multiJson } = require("./json-csv-converter");
-const packageJson = require("../package.json");
-
-/**
- * https://www.jsdelivr.com/package/npm/@orderly.network/i18n?tab=files&path=dist
- * Compare two locale CSV files
- */
-async function diffCsv(oldFile, newFile) {
-  const oldCsv = await fs.readFile(oldFile, { encoding: "utf8" });
-  const newCsv = await fs.readFile(newFile, { encoding: "utf8" });
-
-  const oldJson = csv2multiJson(oldCsv);
-  const newJson = csv2multiJson(newCsv);
-  const diffResult = compareJsonFiles(oldJson, newJson);
-  console.log("CSV diff result:", JSON.stringify(diffResult, null, 2));
-
-  const filepath = path.resolve("LOCALE_CHANGELOG.md");
-
-  // generate .md file
-  let markdownContent = generateMarkdown(diffResult);
-
-  if (!(await fs.exists(filepath))) {
-    const title = `# Locale Changelog`;
-    markdownContent = `${title}\n\n${markdownContent}`;
-
-    await fs.writeFile(filepath, markdownContent, {
-      encoding: "utf8",
-    });
-    console.log("LOCALE_CHANGELOG.md created");
-  } else {
-    // Read existing content
-    const existingContent = await fs.readFile(filepath, { encoding: "utf8" });
-
-    // Find the position after "# Locale Changelog"
-    const titleIndex = existingContent.indexOf("# Locale Changelog");
-    if (titleIndex === -1) {
-      console.error("Could not find '# Locale Changelog' title in the file");
-      return;
-    }
-
-    const titleEndIndex = titleIndex + "# Locale Changelog".length;
-
-    // Split content and insert new content after the title
-    const beforeTitle = existingContent.slice(0, titleEndIndex);
-    const afterTitle = existingContent.slice(titleEndIndex);
-
-    // Combine all parts
-    const newContent = `${beforeTitle}\n\n${markdownContent}${afterTitle}`;
-
-    // Write back to file
-    await fs.writeFile(filepath, newContent, {
-      encoding: "utf8",
-    });
-    console.log("LOCALE_CHANGELOG.md updated");
-  }
-}
-
-// Compare function
-function compareJsonFiles(oldJson, newJson) {
-  const result = {
-    added: {},
-    removed: {},
-    updated: {},
-  };
-
-  Object.keys(newJson).forEach((lang) => {
-    result.added[lang] = {};
-    result.removed[lang] = {};
-    result.updated[lang] = {};
-
-    const oldKeys = oldJson[lang] || {};
-    const newKeys = newJson[lang];
-
-    // Find added keys
-    Object.keys(newKeys).forEach((key) => {
-      if (!(key in oldKeys)) {
-        result.added[lang][key] = newKeys[key];
-      }
-    });
-
-    // Find removed keys
-    Object.keys(oldKeys).forEach((key) => {
-      if (!(key in newKeys)) {
-        result.removed[lang][key] = oldKeys[key];
-      }
-    });
-
-    // Find updated keys (same key, different value)
-    Object.keys(newKeys).forEach((key) => {
-      if (key in oldKeys && oldKeys[key] !== newKeys[key]) {
-        result.updated[lang][key] = {
-          old: oldKeys[key],
-          new: newKeys[key],
-        };
-      }
-    });
-  });
-
-  return result;
-}
-
-// generate Markdown conent
-function generateMarkdown(diff) {
-  let mdContent = `## ${packageJson.version}\n\n`;
-
-  const addedKeysEmpty = Object.keys(diff.added).every((lang) => {
-    return Object.keys(diff.added[lang]).length === 0;
-  });
-  const removedKeysEmpty = Object.keys(diff.removed).every((lang) => {
-    return Object.keys(diff.removed[lang]).length === 0;
-  });
-  const updatedKeysEmpty = Object.keys(diff.updated).every((lang) => {
-    return Object.keys(diff.updated[lang]).length === 0;
-  });
-
-  if (addedKeysEmpty && removedKeysEmpty && updatedKeysEmpty) {
-    return `${mdContent}### No locale changes`;
-  }
-
-  // handle added content
-  if (!addedKeysEmpty) {
-    mdContent += `### Added Keys\n`;
-    Object.keys(diff.added).forEach((lang) => {
-      if (Object.keys(diff.added[lang]).length === 0) {
-        mdContent += `\n#### Language: **${lang}**\n> No added keys.\n`;
-      } else {
-        mdContent += `\n#### Language: **${lang}**\n`;
-        mdContent += `| Key | Value |\n| --- | --- |\n`;
-        Object.entries(diff.added[lang]).forEach(([key, value]) => {
-          mdContent += `| ${key} | ${value} |\n`;
-        });
-      }
-    });
-  }
-
-  // handle removed content
-  if (!removedKeysEmpty) {
-    mdContent += `\n### Removed Keys\n`;
-    Object.keys(diff.removed).forEach((lang) => {
-      if (Object.keys(diff.removed[lang]).length === 0) {
-        mdContent += `\n#### Language: **${lang}**\n> No removed keys.\n`;
-      } else {
-        mdContent += `\n#### Language: **${lang}**\n`;
-        mdContent += `| Key | Value |\n| --- | --- |\n`;
-        Object.entries(diff.removed[lang]).forEach(([key, value]) => {
-          mdContent += `| ${key} | ${value} |\n`;
-        });
-      }
-    });
-  }
-
-  // handle updated content
-  if (!updatedKeysEmpty) {
-    mdContent += `\n### Updated Keys\n`;
-    Object.keys(diff.updated).forEach((lang) => {
-      if (Object.keys(diff.updated[lang]).length === 0) {
-        mdContent += `\n#### Language: **${lang}**\n> No updates found.\n`;
-      } else {
-        mdContent += `\n#### Language: **${lang}**\n`;
-        mdContent += `| Key | Old Value | New Value |\n| --- | --- | --- |\n`;
-        Object.entries(diff.updated[lang]).forEach(([key, values]) => {
-          mdContent += `| ${key} | ${values.old} | ${values.new} |\n`;
-        });
-      }
-    });
-  }
-
-  return mdContent;
-}
-
-module.exports = {
-  diffCsv,
-};

package/script/fillJson.js

@@ -1,33 +0,0 @@
-const fs = require("fs-extra");
-const path = require("path");
-const { checkFileExists } = require("./utils");
-const { en } = require("../dist");
-
-/** Fill values from the input locale JSON file and generate a new locale JSON file */
-async function fillJson(inputPath, outputPath) {
-  const inputJson = await fs.readJSON(inputPath, { encoding: "utf8" });
-
-  const newJson = {};
-  const missingValues = {};
-  Object.keys(en).forEach((key) => {
-    const value = inputJson[key] || "";
-    if (!value) {
-      missingValues[key] = en[key];
-    }
-    newJson[key] = value;
-  });
-  console.log("missingValues", missingValues);
-
-  const jsonPath = path.resolve(outputPath);
-  await checkFileExists(jsonPath);
-
-  await fs.outputFile(jsonPath, JSON.stringify(newJson, null, 4), {
-    encoding: "utf8",
-  });
-
-  console.log("fillJson success =>", jsonPath);
-}
-
-module.exports = {
-  fillJson,
-};

package/script/generateCsv.js

@@ -1,36 +0,0 @@
-const fs = require("fs-extra");
-const path = require("path");
-const { checkFileExists } = require("./utils");
-const { multiJson2Csv } = require("./json-csv-converter");
-const { defaultLanguages } = require("../dist");
-
-/** Generate a locale CSV file */
-async function generateCsv(outputPath) {
-  const headers = [""];
-  const jsonList = [];
-
-  for (const item of defaultLanguages) {
-    headers.push(item.localCode);
-    const json = await fs.readJSON(
-      path.resolve(__dirname, `../locales/${item.localCode}.json`),
-      {
-        encoding: "utf8",
-      }
-    );
-    jsonList.push(json);
-  }
-
-  const csv = multiJson2Csv(jsonList, headers);
-
-  const csvPath = path.resolve(outputPath);
-
-  await checkFileExists(outputPath);
-
-  await fs.outputFile(outputPath, csv, { encoding: "utf8" });
-
-  console.log("generateCsv success =>", csvPath);
-}
-
-module.exports = {
-  generateCsv,
-};

package/script/generateEnJson.js

@@ -1,11 +0,0 @@
-const fs = require("fs-extra");
-const path = require("path");
-const { en } = require("../dist");
-
-async function generateEnJson() {
-  const outPath = path.resolve(__dirname, "../locales/en.json");
-  const jsonData = JSON.stringify(en, null, 2);
-  await fs.outputFile(outPath, jsonData, { encoding: "utf8" });
-}
-
-generateEnJson();

package/script/generateMissingKeys.js

@@ -1,49 +0,0 @@
-const fs = require("fs-extra");
-const path = require("path");
-const { getMissingKeys } = require("./json-csv-converter");
-const { checkFileExists, findJsonFiles } = require("./utils");
-const { LocaleEnum } = require("../dist");
-
-async function generateMissingKeys() {
-  const inputDir = path.resolve(__dirname, "../locales");
-  const jsonFiles = await findJsonFiles(inputDir);
-
-  // Sort input files by locale
-  jsonFiles.sort((a, b) => (b.startsWith(LocaleEnum.en) ? 1 : -1));
-
-  const jsonList = [];
-  const headers = [""];
-
-  for (const file of jsonFiles) {
-    const jsonPath = path.resolve(inputDir, file);
-
-    const json = await fs.readJSON(jsonPath, {
-      encoding: "utf8",
-    });
-
-    jsonList.push(json);
-
-    const fileName = path.basename(file, path.extname(file));
-    headers.push(fileName);
-  }
-
-  const errors = getMissingKeys(jsonList, headers);
-
-  const missingJson = {};
-  for (const locale of Object.values(errors)) {
-    for (const [key, value] of Object.entries(locale)) {
-      missingJson[key] = value;
-    }
-  }
-
-  const outputPath = path.resolve(inputDir, "extend/en.json");
-
-  // don't check file exists
-  // await checkFileExists(outputPath);
-
-  await fs.outputFile(outputPath, JSON.stringify(missingJson, null, 2), {
-    encoding: "utf8",
-  });
-}
-
-generateMissingKeys();

package/script/json-csv-converter.js

@@ -1,286 +0,0 @@
-const { validateI18nValue } = require("./utils");
-const fs = require("fs");
-const path = require("path");
-
-const separator = ".";
-
-function multiJson2Csv(jsonList, header) {
-  if (!Array.isArray(jsonList) || jsonList.length === 0) {
-    throw "Object array please.";
-  }
-
-  const ignoreKeys = loadIgnoreKeys();
-  const baseJson = jsonList[0];
-  const baseKeys = Object.keys(baseJson);
-  const errors = {};
-  let result = header.length ? [header] : [];
-  for (const key of baseKeys) {
-    const values = [];
-    for (const [index, json] of jsonList.entries()) {
-      const val = json[key] || "";
-      values.push(val);
-      // Skip validation if key is in ignore list
-      if (!shouldIgnoreKey(key, ignoreKeys)) {
-        const bool = validateI18nValue(val);
-        if (!bool.valid) {
-          const locale = header[index + 1];
-          if (!errors[locale]) {
-            errors[locale] = {};
-          }
-          errors[locale][key] = baseJson[key];
-        }
-      }
-    }
-    result.push(stringsToCsvLine([key, ...values]));
-  }
-  if (Object.keys(errors).length > 0) {
-    throw new Error(
-      "valid i18n value failed, please check the value of the following values: " +
-        JSON.stringify(errors, null, 4),
-    );
-  }
-  return result.join("\n");
-}
-
-function csv2multiJson(csv) {
-  if (typeof csv !== "string") throw "String please.";
-  const json = {};
-
-  const ignoreKeys = loadIgnoreKeys();
-  const lines = csvToLines(csv);
-  const csvLines = lines.filter(Boolean).map(parseCsvLine);
-
-  const headers = csvLines.shift();
-
-  const errors = {};
-  for (const [index, header] of headers.entries()) {
-    json[header] = {};
-    for (const line of csvLines) {
-      const [key, ...values] = line;
-      if (!key) {
-        continue;
-      }
-      const val = values[index];
-      json[header][key] = val;
-      // Skip validation if key is in ignore list
-      if (!shouldIgnoreKey(key, ignoreKeys)) {
-        const bool = validateI18nValue(val);
-        if (!bool.valid) {
-          if (!errors[header]) {
-            errors[header] = {};
-          }
-          errors[header][key] = values[0];
-        }
-      }
-    }
-
-    if (Object.values(json[header]).every((value) => !value)) {
-      delete json[header];
-    }
-  }
-
-  if (Object.keys(errors).length > 0) {
-    throw new Error(
-      "valid i18n value failed, please check the value of the following values: " +
-        JSON.stringify(errors, null, 4),
-    );
-  }
-
-  return json;
-}
-
-function json2Csv(json) {
-  if (typeof json !== "object" || !json) throw "Object please.";
-  return findKeyValues(json).join("\n");
-}
-
-function csv2Json(csv) {
-  if (typeof csv !== "string") throw "String please.";
-  const json = {};
-  parseCsvLines(csv).forEach((line) => {
-    const [path, value] = line;
-    const pathSplit = path.split(separator);
-    deepSet(json, pathSplit, value);
-  });
-  return json;
-}
-
-function findKeyValues(o, prefix, l = 0) {
-  let result = [];
-  for (const key of Object.keys(o)) {
-    const fullKey = prefix ? prefix + separator + key : key;
-    const value = o[key];
-    if (typeof value === "string") {
-      result.push(stringsToCsvLine([fullKey, value]));
-    } else if (typeof value === "object" && value) {
-      result = result.concat(findKeyValues(value, fullKey, l + 1));
-    }
-  }
-  return result;
-}
-
-function stringsToCsvLine(line) {
-  return line.map((s) => `"${s.replace(/"/g, '""')}"`).join(",");
-}
-
-function deepSet(o, path, value) {
-  if (path.length > 1) {
-    const key = path[0];
-    if (!o[key]) {
-      o[key] = {};
-    }
-    deepSet(o[key], path.slice(1), value);
-  } else {
-    o[path[0]] = value;
-  }
-}
-
-function parseCsvLines(csv) {
-  const lines = csvToLines(csv);
-  return lines.filter(Boolean).map(parseCsvLine);
-}
-
-function csvToLines(csv) {
-  return csv.split(/[\r\n]+/);
-}
-
-function parseCsvLine(line) {
-  const result = [];
-  for (let i = 0; i < line.length; i++) {
-    const char = line[i];
-    switch (char) {
-      case ",":
-        continue;
-      case '"': {
-        i++;
-        const [str, i2] = parseCsvString(line, i);
-        i = i2;
-        result.push(str);
-        break;
-      }
-      default: {
-        const [str, i2] = parseUnquotedField(line, i);
-        i = i2;
-        result.push(str);
-        break;
-      }
-    }
-  }
-  return result;
-}
-
-/** Parses one field until the next comma or end of line (for unquoted CSV). */
-function parseUnquotedField(line, i) {
-  let result = "";
-  for (; i < line.length; i++) {
-    if (line[i] === ",") break;
-    result += line[i];
-  }
-  return [result, i];
-}
-
-function parseCsvString(line, i) {
-  let result = "";
-  loop: for (; i < line.length; i++) {
-    const char = line[i];
-    switch (char) {
-      case '"':
-        i++;
-        if (line[i] === '"') {
-          result += '"';
-        } else {
-          break loop;
-        }
-        break;
-      default:
-        result += char;
-    }
-  }
-  return [result, i];
-}
-
-function getMissingKeys(jsonList, header) {
-  if (!Array.isArray(jsonList) || jsonList.length === 0) {
-    throw "Object array please.";
-  }
-
-  const baseJson = jsonList[0];
-  const baseKeys = Object.keys(baseJson);
-  const errors = {};
-  for (const key of baseKeys) {
-    for (const [index, json] of jsonList.entries()) {
-      const val = json[key] || "";
-      const bool = validateI18nValue(val);
-      if (!bool.valid) {
-        const locale = header[index + 1];
-        if (!errors[locale]) {
-          errors[locale] = {};
-        }
-        errors[locale][key] = baseJson[key];
-      }
-    }
-  }
-  return errors;
-}
-
-// Load ignore validation keys configuration
-function loadIgnoreKeys() {
-  const configPath = path.join(__dirname, "../validation-ignore.json");
-  try {
-    if (fs.existsSync(configPath)) {
-      const config = JSON.parse(fs.readFileSync(configPath, "utf8"));
-      const ignoreKeys = config.ignoreKeys || [];
-      // Convert config to matcher array: string or regex
-      return ignoreKeys
-        .map((item) => {
-          if (typeof item === "string") {
-            // If string starts and ends with /, treat as regex pattern
-            if (item.startsWith("/") && item.endsWith("/") && item.length > 2) {
-              try {
-                const pattern = item.slice(1, -1); // Remove leading and trailing /
-                return new RegExp(pattern);
-              } catch (error) {
-                console.warn(
-                  `Warning: Invalid regex pattern "${item}": ${error.message}`,
-                );
-                return item;
-              }
-            }
-            return item;
-          }
-          return item;
-        })
-        .filter(Boolean);
-    }
-  } catch (error) {
-    console.warn(
-      `Warning: Failed to load validation-ignore.json: ${error.message}`,
-    );
-  }
-  return [];
-}
-
-// Check if key should be ignored
-function shouldIgnoreKey(key, ignoreKeys) {
-  for (const matcher of ignoreKeys) {
-    if (matcher instanceof RegExp) {
-      if (matcher.test(key)) {
-        return true;
-      }
-    } else if (typeof matcher === "string") {
-      if (matcher === key) {
-        return true;
-      }
-    }
-  }
-  return false;
-}
-
-module.exports = {
-  separator,
-  json2Csv,
-  csv2Json,
-  multiJson2Csv,
-  csv2multiJson,
-  getMissingKeys,
-};