i18n-sharpen 0.2.2 → 0.2.4

package/README.md

@@ -120,6 +120,29 @@ 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`.
+
+### Format Trade-offs (`.json` vs. `.ts` / `.js`)
+
+*   **Using `.ts` / `.tsx` (or JS modules):**
+    *   *Requirement:* You must install `jiti` as a `devDependency`.
+    *   *Capability:* Supported for **`validate` only**. Automatic `extract` and `prune` are disabled.
+*   **Using `.json` / `.yaml`:**
+    *   *Capability:* Full support for **all features** (`validate`, `extract`, and `prune`).
+    *   *Note:* Vite and TypeScript natively resolve types for `.json` imports (by enabling `"resolveJsonModule": true` in your `tsconfig.json`), guaranteeing compile-time type safety with zero runtime overhead.
+
+---
+
 ## Locale Layouts
 
 Two layouts are supported under `localesDir`:

package/dist/cli.js

@@ -23,6 +23,9 @@ function escapeRegex(input) {
   return input.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
 }
 function buildKeyRegex(matchFunctions) {
+  if (matchFunctions.length === 0) {
+    return /(?!)/g;
+  }
   const functionsJoined = matchFunctions.map(escapeRegex).join("|");
   return new RegExp(
     "\\b(?:" + functionsJoined + ")\\s*\\(\\s*(['\"`])([a-zA-Z0-9_\\-.:]+)\\1",
@@ -30,6 +33,9 @@ function buildKeyRegex(matchFunctions) {
   );
 }
 function buildAttrRegex(matchAttributes) {
+  if (matchAttributes.length === 0) {
+    return /(?!)/g;
+  }
   const attrsJoined = matchAttributes.map(escapeRegex).join("|");
   return new RegExp(
     "(?:^|[\\s/{(>])(?:" + attrsJoined + ")\\s*=\\s*(['\"`])([a-zA-Z0-9_\\-.:]+)\\1",
@@ -37,6 +43,9 @@ function buildAttrRegex(matchAttributes) {
   );
 }
 function buildDynamicCallRegex(matchFunctions) {
+  if (matchFunctions.length === 0) {
+    return /(?!)/g;
+  }
   const functionsJoined = matchFunctions.map(escapeRegex).join("|");
   return new RegExp("\\b(?:" + functionsJoined + ")\\s*\\(\\s*([^)]*)\\)", "g");
 }
@@ -419,8 +428,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 });