i18nExtractKeys.vite.js

import path from "path";
import fs from "fs";

const uniqueKeys = new Set();

function extractRegexPlugin({ extraKeys } = {}) {
  const fileOutput = path.join("registry", "uiLocaleKeysBackend.json");

  /**
   * Supported variants:
   * this.t('key');
   * {{ t('key') }}
   * this.t(
   *   'key'
   * )
   * To identify the translation keys, without triggering translation
   * {'viewAction': tk('common.viewAction') }
   */
  const regex = /(?:^|\W)tk?\([\s]*['"`](?<localeKey>[^'"`]+)['"`]/g;

  extraKeys ||= [];

  return {
    name: "extract-keys",
    transform(code, id) {
      if (
        !id.includes("node_modules") &&
        (id.endsWith(".vue") || id.endsWith(".js"))
      ) {
        const matches = [...code.matchAll(regex)];
        for (const match of matches) {
          uniqueKeys.add(match[1]);
        }
      }
      return null;
    },
    buildEnd() {
      for (const key of extraKeys) {
        uniqueKeys.add(key);
      }

      // remove dummy key used in the comment examples
      uniqueKeys.delete("key");

      // remove keys with unresolved template literals
      for (const key of uniqueKeys) {
        if (key.includes("${")) {
          uniqueKeys.delete(key);
        }
      }

      if (uniqueKeys.size) {
        const dir = path.dirname(fileOutput);

        if (!fs.existsSync(dir)) {
          fs.mkdirSync(dir, { recursive: true });
        }

        const outputArray = [...uniqueKeys].sort();

        fs.writeFileSync(
          fileOutput,
          `${JSON.stringify(outputArray, null, 2)}\n`
        );
        console.log(`Written all existing locale keys to ${fileOutput}`);
      }
    },
  };
}

module.exports = extractRegexPlugin;