i18nizer 0.2.0 → 0.3.0

package/README.md

@@ -140,24 +140,55 @@ export function Login() {
 - Always generates **English camelCase keys**
 - Supports **any number of locales**
 - Isolated TypeScript parsing (no project tsconfig required)
-- Friendly logs, and errors
+- Friendly logs and errors
+
+### Supported Extraction Cases
+
+- **JSX text children**: `<div>Hello</div>`
+- **JSX attributes**: `placeholder`, `title`, `alt`, `aria-label`, `aria-placeholder`, `label`, `text`, `tooltip`, `helperText`
+- **String literals**: `placeholder="Enter name"`
+- **Curly-braced strings**: `placeholder={"Enter name"}`
+- **Template literals**: `` placeholder={`Enter name`} ``
+- **Template literals with placeholders**: `` <p>{`Hello ${name}`}</p> ``
+- **Ternary operators**: `placeholder={condition ? "Text A" : "Text B"}`
+- **Logical AND**: `{condition && "Visible text"}`
+- **Logical OR**: `{condition || "Fallback text"}`
+- **Nested expressions**: Complex combinations of the above
+
+### Filtering & Quality
+
+- **Skips non-translatable content**: Single symbols (`*`, `|`), punctuation-only strings (`...`), whitespace
+- **Deterministic key generation**: Same input always produces the same key
+- **Stable JSON output**: Alphabetically sorted keys, consistent formatting
+- **2-space indentation**: Clean and diff-friendly JSON files
 
 ---
 
 ## 🔮 Roadmap
 
-- Configurable output directory
-- Framework support (Vue, Svelte)
-- i18n library presets (`next-intl`, `react-i18next`)
-- Watch mode
-- Non-AI fallback mode
+- [ ] Cross-file string deduplication
+- [ ] Key reuse mechanism
+- [ ] Configurable output directory
+- [ ] Framework support (Vue, Svelte)
+- [ ] i18n library presets (`next-intl`, `react-i18next`)
+- [ ] Watch mode
+- [ ] Non-AI fallback mode
+
+---
+
+## ⚠️ Current Limitations
+
+- Does not yet deduplicate identical strings across files
+- AI-generated keys may vary between runs (deterministic fallback available)
+- Only supports React JSX/TSX (no Vue, Svelte yet)
+- Does not handle runtime-only string generation
 
 ---
 
 ## ⚠️ Notes
 
 - API keys are **never committed**
-- JSON files are stored per project in `.i18nizer/`
+- JSON files are stored in `/{HOME}/.i18nizer/`
 - Designed for incremental adoption
 
 ---

package/dist/core/ast/extract-text.js

@@ -4,7 +4,17 @@ import { isTranslatableString } from "./is-translatable.js";
 let tempIdCounter = 0;
 const allowedFunctions = new Set(["alert", "confirm", "prompt"]);
 const allowedMemberFunctions = new Set(["toast.error", "toast.info", "toast.success", "toast.warn"]);
-const allowedProps = new Set(["alt", "aria-label", "placeholder", "title"]);
+const allowedProps = new Set([
+    "alt",
+    "aria-label",
+    "aria-placeholder",
+    "helperText",
+    "label",
+    "placeholder",
+    "text",
+    "title",
+    "tooltip",
+]);
 // --- Helpers ---
 function processTemplateLiteral(node) {
     if (Node.isNoSubstitutionTemplateLiteral(node)) {

package/dist/core/ast/replace-text-with-text.js

@@ -1,7 +1,17 @@
 /* eslint-disable complexity */
 import { Node } from "ts-morph";
 // Allowed JSX props to replace text
-const allowedProps = new Set(["alt", "aria-label", "placeholder", "title"]);
+const allowedProps = new Set([
+    "alt",
+    "aria-label",
+    "aria-placeholder",
+    "helperText",
+    "label",
+    "placeholder",
+    "text",
+    "title",
+    "tooltip",
+]);
 // Allowed functions for simple calls
 const allowedFunctions = new Set(["alert", "confirm", "prompt"]);
 // Allowed member functions (e.g., toast.error)

package/dist/core/i18n/generate-key.js

@@ -0,0 +1,72 @@
+/**
+ * Generate a deterministic, human-readable translation key from text.
+ * This is used as a fallback when AI-generated keys are not available.
+ */
+/**
+ * Convert a string to camelCase
+ */
+function toCamelCase(str) {
+    return str
+        .replaceAll(/[^\w\s]/g, " ") // Replace special chars (note: \w includes underscores, so this won't replace them)
+        .replaceAll("_", " ") // Explicitly replace underscores with spaces
+        .split(/\s+/) // Split by whitespace
+        .filter(Boolean) // Remove empty strings
+        .map((word, index) => {
+        const lower = word.toLowerCase();
+        return index === 0 ? lower : lower.charAt(0).toUpperCase() + lower.slice(1);
+    })
+        .join("");
+}
+/**
+ * Generate a deterministic key from text.
+ *
+ * Rules:
+ * - Remove special characters
+ * - Convert to camelCase
+ * - Limit to first 4-5 words for readability
+ * - Ensure minimum length
+ *
+ * @param text - The text to generate a key from
+ * @returns A camelCase key
+ */
+export function generateKey(text) {
+    // Remove template literal placeholders like {name}
+    const cleanedText = text.replaceAll(/\{[^}]+\}/g, "");
+    // Replace apostrophes followed by 's' with just 's' (e.g., "User's" -> "Users")
+    const normalizedText = cleanedText.replaceAll(/'s\b/g, "s");
+    // Split into words and take first 4-5 significant words
+    const words = normalizedText
+        .replaceAll(/[^\w\s]/g, " ") // Replace special chars (note: \w includes underscores, so this won't replace them)
+        .replaceAll("_", " ") // Explicitly replace underscores with spaces
+        .split(/\s+/)
+        .filter(Boolean)
+        .slice(0, 5);
+    if (words.length === 0) {
+        return "text";
+    }
+    const key = toCamelCase(words.join(" "));
+    // Ensure minimum key length
+    if (key.length < 3) {
+        return "text";
+    }
+    return key;
+}
+/**
+ * Generate a unique key by appending a counter if needed.
+ *
+ * @param baseKey - The base key
+ * @param existingKeys - Set of already used keys
+ * @returns A unique key
+ */
+export function generateUniqueKey(baseKey, existingKeys) {
+    if (!existingKeys.has(baseKey)) {
+        return baseKey;
+    }
+    let counter = 2;
+    let uniqueKey = `${baseKey}${counter}`;
+    while (existingKeys.has(uniqueKey)) {
+        counter++;
+        uniqueKey = `${baseKey}${counter}`;
+    }
+    return uniqueKey;
+}

package/dist/core/i18n/write-files.js

@@ -7,13 +7,16 @@ export function writeLocaleFiles(namespace, data, locales) {
     for (const locale of locales) {
         const content = {};
         content[namespace] = {};
-        for (const key of Object.keys(data[namespace])) {
+        // Sort keys for stable output
+        const sortedKeys = Object.keys(data[namespace]).sort();
+        for (const key of sortedKeys) {
             content[namespace][key] = data[namespace][key][locale];
         }
         const dir = path.join(CONFIG_DIR, locale);
         fs.mkdirSync(dir, { recursive: true });
         const filePath = path.join(dir, `${namespace}.json`);
-        fs.writeFileSync(filePath, JSON.stringify(content, null, 2));
+        // Use 2-space indentation for clean, readable JSON
+        fs.writeFileSync(filePath, JSON.stringify(content, null, 2) + "\n");
         console.log(chalk.green(`💾 Locale file saved: ${filePath}`));
     }
 }

package/oclif.manifest.json

@@ -161,5 +161,5 @@
       ]
     }
   },
-  "version": "0.2.0"
+  "version": "0.3.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "i18nizer",
   "description": "CLI to extract texts from JSX/TSX and generate i18n JSON with AI translations",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "author": "Yoannis Sanchez Soto",
   "bin": "./bin/run.js",
   "bugs": "https://github.com/yossTheDev/i18nizer/issues",