i18n-sharpen 0.2.1 → 0.2.3

package/README.md

@@ -120,6 +120,20 @@ npx i18n-sharpen prune --force
 
 ---
 
+## Supported File Formats
+
+`i18n-sharpen` supports reading translation files in multiple formats:
+
+*   **JSON (`.json`)**: Out of the box. Fully writable (`extract`/`prune`).
+*   **YAML (`.yaml`, `.yml`)**: Out of the box. Fully writable (`extract`/`prune`).
+*   **CommonJS (`.js`, `.cjs`)**: Supported for **reading only**. Loaded synchronously via native Node `require`.
+*   **ESM / TypeScript (`.mjs`, `.ts`, `.tsx`)**: Supported for **reading only**. Requires the `jiti` package (install via `pnpm add -D jiti`). Supports ES modules syntax (`export default { ... }`).
+
+> [!WARNING]
+> **JS/TS locale files are Read-Only.** `extract` and `prune` will throw an error if asked to write to a `.js`, `.cjs`, `.mjs`, `.ts`, or `.tsx` file. This prevents the tool from destroying imports, JSDoc, type annotations, or custom wrapping code. If you want `i18n-sharpen` to automatically manage and mutate your locale files, convert them to `.json` or `.yaml`.
+
+---
+
 ## Locale Layouts
 
 Two layouts are supported under `localesDir`:

package/dist/cli.js

@@ -4,6 +4,7 @@ import * as path3 from 'path';
 import { fileURLToPath } from 'url';
 import { Command } from 'commander';
 import pc5 from 'picocolors';
+import { createRequire } from 'module';
 import YAML from 'yaml';
 import { z } from 'zod';
 
@@ -329,8 +330,19 @@ var unflattenObject = buildNestedObject;
 function normalizeDisplayPath(p) {
   return p.split(path3.sep).join("/");
 }
+var _require = createRequire(import.meta.url);
+var LOCALE_EXTENSIONS = [
+  ".json",
+  ".yaml",
+  ".yml",
+  ".js",
+  ".cjs",
+  ".mjs",
+  ".ts",
+  ".tsx"
+];
 function findLocaleFile(localesDir, lang) {
-  const extensions = [".json", ".yaml", ".yml"];
+  const extensions = LOCALE_EXTENSIONS;
   const found = extensions.map((ext) => path3.join(localesDir, `${lang}${ext}`)).filter((p) => fs8.existsSync(p));
   if (found.length === 0) return null;
   if (found.length > 1) {
@@ -342,8 +354,56 @@ function findLocaleFile(localesDir, lang) {
   }
   return found[0];
 }
+function loadWithJiti(filePath) {
+  let jiti;
+  try {
+    const jitiMod = _require("jiti");
+    const factory = typeof jitiMod === "function" ? jitiMod : jitiMod.default;
+    if (typeof factory === "function") {
+      jiti = factory(import.meta.url);
+    }
+  } catch {
+  }
+  if (!jiti) {
+    throw new Error(
+      `TypeScript/ESM locale file '${path3.basename(filePath)}' requires the 'jiti' package.
+Install it as a dev-dependency: pnpm add -D jiti`
+    );
+  }
+  try {
+    const mod = jiti(filePath);
+    const result = mod !== null && typeof mod === "object" && "default" in mod ? mod.default : mod;
+    return result && typeof result === "object" && !Array.isArray(result) ? result : {};
+  } catch (err) {
+    throw new Error(
+      `Failed to parse TypeScript/ESM locale file '${path3.basename(filePath)}': ${err.message}`
+    );
+  }
+}
 function readLocaleFile(filePath) {
   const ext = path3.extname(filePath).toLowerCase();
+  if (ext === ".js" || ext === ".cjs") {
+    try {
+      const resolved = _require.resolve(filePath);
+      Reflect.deleteProperty(_require.cache, resolved);
+    } catch {
+    }
+    try {
+      const mod = _require(filePath);
+      const result = mod !== null && typeof mod === "object" && "default" in mod ? mod.default : mod;
+      return result && typeof result === "object" && !Array.isArray(result) ? result : {};
+    } catch (err) {
+      if (ext === ".js") {
+        return loadWithJiti(filePath);
+      }
+      throw new Error(
+        `Failed to parse JS/CJS locale file '${path3.basename(filePath)}': ${err.message}`
+      );
+    }
+  }
+  if (ext === ".mjs" || ext === ".ts" || ext === ".tsx") {
+    return loadWithJiti(filePath);
+  }
   let content = fs8.readFileSync(filePath, "utf8");
   if (content.charCodeAt(0) === 65279) {
     content = content.slice(1);
@@ -359,8 +419,16 @@ function readLocaleFile(filePath) {
   const parsedJson = JSON.parse(trimmed);
   return parsedJson && typeof parsedJson === "object" && !Array.isArray(parsedJson) ? parsedJson : {};
 }
+var JS_TS_EXTENSIONS = /* @__PURE__ */ new Set([".js", ".cjs", ".mjs", ".ts", ".tsx"]);
 function writeLocaleFile(filePath, obj) {
   const ext = path3.extname(filePath).toLowerCase();
+  if (JS_TS_EXTENSIONS.has(ext)) {
+    throw new Error(
+      `Refusing to write JS/TS locale file '${path3.basename(filePath)}'.
+i18n-sharpen can read .js/.cjs/.mjs/.ts/.tsx locale files but will not overwrite them, because doing so would destroy any imports, type annotations, or custom code in the source.
+Fix: convert this locale to .json or .yaml so extract/prune can update it safely, or add the missing keys manually.`
+    );
+  }
   let content = "";
   if (ext === ".yaml" || ext === ".yml") {
     content = YAML.stringify(obj, { indent: 2 });
@@ -427,7 +495,7 @@ function loadNamespacedLocales(localesDir, supportedLanguages, onMissing = () =>
     for (const entry of entries) {
       if (!entry.isFile()) continue;
       const ext = path3.extname(entry.name).toLowerCase();
-      if (ext !== ".json" && ext !== ".yaml" && ext !== ".yml") continue;
+      if (!LOCALE_EXTENSIONS.includes(ext)) continue;
       const ns = path3.basename(entry.name, ext);
       const filePath = path3.join(langDir, entry.name);
       localeNamespaces[lang][ns] = filePath;