i18next-cli 1.34.0 → 1.34.1

package/dist/esm/rename-key.js

@@ -1 +1,352 @@
-import{glob as e}from"glob";import{readFile as t,writeFile as n}from"node:fs/promises";import{ConsoleLogger as r}from"./utils/logger.js";import{getOutputPath as o,loadTranslationFile as s,serializeTranslationFile as a}from"./utils/file-utils.js";import{resolve as i}from"node:path";import{getNestedValue as c,setNestedValue as l}from"./utils/nested-object.js";import{shouldShowFunnel as f,recordFunnelShown as u}from"./utils/funnel-msg-tracker.js";import p from"chalk";async function g(g,d,m,h={},x=new r){const{dryRun:k=!1}=h,b=function(e,t){if(!e||!e.trim())return{valid:!1,error:"Old key cannot be empty"};if(!t||!t.trim())return{valid:!1,error:"New key cannot be empty"};if(e===t)return{valid:!1,error:"Old and new keys are identical"};return{valid:!0}}(d,m);if(!b.valid)return{success:!1,sourceFiles:[],translationFiles:[],error:b.error};const K=y(d,g),v=y(m,g),S=await async function(e,t){const n=[];for(const r of t.locales){const a=o(t.extract.output,r,e.namespace),l=i(process.cwd(),a);try{const o=await s(l);if(o){const s=t.extract.keySeparator??".";void 0!==c(o,e.key,s)&&n.push(`${r}:${e.fullKey}`)}}catch{}}return n}(v,g);if(S.length>0)return{success:!1,sourceFiles:[],translationFiles:[],conflicts:S,error:"Target key already exists in translation files"};x.info(`🔍 Scanning for usages of "${d}"...`);const R=await async function(r,o,s,a,i){const c=["node_modules/**"],l=Array.isArray(s.extract.ignore)?s.extract.ignore:s.extract.ignore?[s.extract.ignore]:[],f=Array.isArray(s.extract.input)?s.extract.input:[s.extract.input],u=f.map(e=>e.replace(/\\/g,"/")),p=await e(u,{ignore:[...c,...l],cwd:process.cwd()}),g=[];for(const e of p){const c=await t(e,"utf-8"),{newCode:l,changes:f}=await $(c,r,o,s);f>0&&(a||await n(e,l,"utf-8"),g.push({path:e,changes:f}),i.info(`   ${a?"(dry-run) ":""}✓ ${e} (${f} ${1===f?"change":"changes"})`))}g.length>0&&i.info(`\n📝 Source file changes: ${g.length} file${1===g.length?"":"s"}`);return g}(K,v,g,k,x),E=await async function(e,t,r,f,u){const p=[],g=r.extract.keySeparator??".";for(const y of r.locales){const $=o(r.extract.output,y,e.namespace),d=i(process.cwd(),$);try{const o=await s(d);if(!o)continue;const i=c(o,e.key,g);if(void 0===i)continue;if(w(o,e.key,g),l(o,t.key,i,g),!f){const e=a(o,r.extract.outputFormat,r.extract.indentation);await n(d,e,"utf-8")}p.push({path:d,updated:!0}),u.info(`   ${f?"(dry-run) ":""}✓ ${d}`)}catch(e){}}p.length>0&&u.info(`\n📦 Translation file updates: ${p.length} file${1===p.length?"":"s"}`);return p}(K,v,g,k,x),j=R.reduce((e,t)=>e+t.changes,0);return!k&&j>0?(x.info("\n✨ Successfully renamed key!"),x.info(`   Old: "${d}"`),x.info(`   New: "${m}"`),await async function(){if(!await f("rename-key"))return;return console.log(p.yellow.bold("\n💡 Tip: Managing translations across multiple projects?")),console.log("   With locize, you can rename, move, and copy translation keys directly"),console.log("   in the web interface—no CLI needed. Perfect for collaboration with"),console.log("   translators and managing complex refactoring across namespaces."),console.log(`   Learn more: ${p.cyan("https://www.locize.com/docs/how-can-a-segment-key-be-copied-moved-or-renamed")}`),u("rename-key")}()):0===j&&x.info(`\n⚠️  No usages found for "${d}"`),{success:!0,sourceFiles:R,translationFiles:E}}function y(e,t){const n=t.extract.nsSeparator??":";if(n&&e.includes(n)){const[t,...r]=e.split(n);return{namespace:t,key:r.join(n),fullKey:e}}return{namespace:t.extract.defaultNS||"translation",key:e,fullKey:e}}async function $(e,t,n,r){return function(e,t,n,r){let o=0,s=e;const a=r.extract.nsSeparator??":",i=e=>a&&e.includes(String(a))?n.fullKey:n.key,c=r.extract.functions||["t","*.t"],l=[];for(const e of c)if(e.startsWith("*.")){const n=d(e.substring(1));l.push({pattern:new RegExp(`\\w+${n}\\((['"\`])${d(t.fullKey)}\\1`,"g"),original:t.fullKey}),l.push({pattern:new RegExp(`\\w+${n}\\((['"\`])${d(t.key)}\\1`,"g"),original:t.key})}else{const n=d(e);l.push({pattern:new RegExp(`\\b${n}\\((['"\`])${d(t.fullKey)}\\1`,"g"),original:t.fullKey}),l.push({pattern:new RegExp(`\\b${n}\\((['"\`])${d(t.key)}\\1`,"g"),original:t.key})}for(const{pattern:e,original:t}of l)if(e.test(s)){const n=i(t);s=s.replace(e,(e,t)=>{o++;const r=e.match(/^(\w+(?:\.\w+)*)\(/);return r?`${r[1]}(${t}${n}${t}`:e})}for(const e of c){let n;if(e.startsWith("*.")){n=`\\w+${d(e.substring(1))}`}else n=d(e);for(const e of[t.fullKey,t.key]){const t=new RegExp(`(\\b${n}\\(\\s*\\(?\\s*([a-zA-Z_$][\\w$]*)\\s*\\)?\\s*=>\\s*)\\2\\.${d(e)}(\\s*\\))`,"g");if(t.test(s)){const n=i(e);s=s.replace(t,(e,t,r,s)=>(o++,`${t}${r}.${n}${s}`))}const r=new RegExp(`(\\b${n}\\(\\s*\\(?\\s*([a-zA-Z_$][\\w$]*)\\s*\\)?\\s*=>\\s*)\\2\\[\\s*(['"\`])${d(e)}\\3\\s*\\](\\s*\\))`,"g");if(r.test(s)){const t=i(e),n=e=>/^[A-Za-z_$][\w$]*$/.test(e);s=s.replace(r,(e,r,s,a,i)=>(o++,n(t)?`${r}${s}.${t}${i}`:`${r}${s}[${a}${t}${a}]${i}`))}}}const f=[{pattern:new RegExp(`i18nKey=(['"\`])${d(t.fullKey)}\\1`,"g"),original:t.fullKey},{pattern:new RegExp(`i18nKey=(['"\`])${d(t.key)}\\1`,"g"),original:t.key}];for(const{pattern:e,original:t}of f)if(e.test(s)){const n=i(t);s=s.replace(e,(e,t)=>(o++,`i18nKey=${t}${n}${t}`))}return{newCode:s,changes:o}}(e,t,n,r)}function d(e){return e.replace(/[.*+?^${}()|[\]\\]/g,"\\$&")}function w(e,t,n){if(!1===n)return void delete e[t];const r=t.split(String(n));let o=e;for(let e=0;e<r.length-1;e++){if(!o[r[e]])return;o=o[r[e]]}delete o[r[r.length-1]]}export{g as runRenameKey};
+import { glob } from 'glob';
+import { readFile, writeFile } from 'node:fs/promises';
+import { ConsoleLogger } from './utils/logger.js';
+import { getOutputPath, loadTranslationFile, serializeTranslationFile } from './utils/file-utils.js';
+import { resolve } from 'node:path';
+import { getNestedValue, setNestedValue } from './utils/nested-object.js';
+import { shouldShowFunnel, recordFunnelShown } from './utils/funnel-msg-tracker.js';
+import chalk from 'chalk';
+
+/**
+ * Renames a translation key across all source files and translation files.
+ *
+ * This function performs a comprehensive key rename operation:
+ * 1. Validates the old and new key names
+ * 2. Checks for conflicts in translation files
+ * 3. Updates all occurrences in source code (AST-based)
+ * 4. Updates all translation files for all locales
+ * 5. Preserves the original translation values
+ *
+ * @param config - The i18next toolkit configuration
+ * @param oldKey - The current key to rename (may include namespace prefix)
+ * @param newKey - The new key name (may include namespace prefix)
+ * @param options - Rename options (dry-run mode, etc.)
+ * @param logger - Logger instance for output
+ * @returns Result object with update status and file lists
+ *
+ * @example
+ * ```typescript
+ * // Basic rename
+ * const result = await runRenameKey(config, 'old.key', 'new.key')
+ *
+ * // With namespace
+ * const result = await runRenameKey(config, 'common:button.submit', 'common:button.save')
+ *
+ * // Dry run to preview changes
+ * const result = await runRenameKey(config, 'old.key', 'new.key', { dryRun: true })
+ * ```
+ */
+async function runRenameKey(config, oldKey, newKey, options = {}, logger = new ConsoleLogger()) {
+    const { dryRun = false } = options;
+    // Validate keys
+    const validation = validateKeys(oldKey, newKey);
+    if (!validation.valid) {
+        return {
+            success: false,
+            sourceFiles: [],
+            translationFiles: [],
+            error: validation.error
+        };
+    }
+    // Parse namespace from keys
+    const oldParts = parseKeyWithNamespace(oldKey, config);
+    const newParts = parseKeyWithNamespace(newKey, config);
+    // Check for conflicts in translation files
+    const conflicts = await checkConflicts(newParts, config);
+    if (conflicts.length > 0) {
+        return {
+            success: false,
+            sourceFiles: [],
+            translationFiles: [],
+            conflicts,
+            error: 'Target key already exists in translation files'
+        };
+    }
+    logger.info(`🔍 Scanning for usages of "${oldKey}"...`);
+    // Find and update source files
+    const sourceResults = await updateSourceFiles(oldParts, newParts, config, dryRun, logger);
+    // Update translation files
+    const translationResults = await updateTranslationFiles(oldParts, newParts, config, dryRun, logger);
+    const totalChanges = sourceResults.reduce((sum, r) => sum + r.changes, 0);
+    if (!dryRun && totalChanges > 0) {
+        logger.info('\n✨ Successfully renamed key!');
+        logger.info(`   Old: "${oldKey}"`);
+        logger.info(`   New: "${newKey}"`);
+        // Show locize funnel after successful rename
+        await printLocizeFunnel();
+    }
+    else if (totalChanges === 0) {
+        logger.info(`\n⚠️  No usages found for "${oldKey}"`);
+    }
+    return {
+        success: true,
+        sourceFiles: sourceResults,
+        translationFiles: translationResults
+    };
+}
+/**
+ * Prints a promotional message for the locize rename/move workflow.
+ * This message is shown after a successful key rename operation.
+ */
+async function printLocizeFunnel() {
+    if (!(await shouldShowFunnel('rename-key')))
+        return;
+    console.log(chalk.yellow.bold('\n💡 Tip: Managing translations across multiple projects?'));
+    console.log('   With locize, you can rename, move, and copy translation keys directly');
+    console.log('   in the web interface—no CLI needed. Perfect for collaboration with');
+    console.log('   translators and managing complex refactoring across namespaces.');
+    console.log(`   Learn more: ${chalk.cyan('https://www.locize.com/docs/how-can-a-segment-key-be-copied-moved-or-renamed')}`);
+    return recordFunnelShown('rename-key');
+}
+function parseKeyWithNamespace(key, config) {
+    const nsSeparator = config.extract.nsSeparator ?? ':';
+    if (nsSeparator && key.includes(nsSeparator)) {
+        const [ns, ...rest] = key.split(nsSeparator);
+        return {
+            namespace: ns,
+            key: rest.join(nsSeparator),
+            fullKey: key
+        };
+    }
+    return {
+        namespace: config.extract.defaultNS || 'translation',
+        key,
+        fullKey: key
+    };
+}
+function validateKeys(oldKey, newKey, config) {
+    if (!oldKey || !oldKey.trim()) {
+        return { valid: false, error: 'Old key cannot be empty' };
+    }
+    if (!newKey || !newKey.trim()) {
+        return { valid: false, error: 'New key cannot be empty' };
+    }
+    if (oldKey === newKey) {
+        return { valid: false, error: 'Old and new keys are identical' };
+    }
+    return { valid: true };
+}
+async function checkConflicts(newParts, config) {
+    const conflicts = [];
+    for (const locale of config.locales) {
+        const outputPath = getOutputPath(config.extract.output, locale, newParts.namespace);
+        const fullPath = resolve(process.cwd(), outputPath);
+        try {
+            const existingTranslations = await loadTranslationFile(fullPath);
+            if (existingTranslations) {
+                const keySeparator = config.extract.keySeparator ?? '.';
+                const value = getNestedValue(existingTranslations, newParts.key, keySeparator);
+                if (value !== undefined) {
+                    conflicts.push(`${locale}:${newParts.fullKey}`);
+                }
+            }
+        }
+        catch {
+            // File doesn't exist, no conflict
+        }
+    }
+    return conflicts;
+}
+async function updateSourceFiles(oldParts, newParts, config, dryRun, logger) {
+    const defaultIgnore = ['node_modules/**'];
+    const userIgnore = Array.isArray(config.extract.ignore)
+        ? config.extract.ignore
+        : config.extract.ignore ? [config.extract.ignore] : [];
+    // Normalize input patterns for cross-platform compatibility
+    const inputPatterns = Array.isArray(config.extract.input)
+        ? config.extract.input
+        : [config.extract.input];
+    const normalizedPatterns = inputPatterns.map(pattern => pattern.replace(/\\/g, '/'));
+    const sourceFiles = await glob(normalizedPatterns, {
+        ignore: [...defaultIgnore, ...userIgnore],
+        cwd: process.cwd()
+    });
+    const results = [];
+    for (const file of sourceFiles) {
+        const code = await readFile(file, 'utf-8');
+        const { newCode, changes } = await replaceKeyInSource(code, oldParts, newParts, config);
+        if (changes > 0) {
+            if (!dryRun) {
+                await writeFile(file, newCode, 'utf-8');
+            }
+            results.push({ path: file, changes });
+            logger.info(`   ${dryRun ? '(dry-run) ' : ''}✓ ${file} (${changes} ${changes === 1 ? 'change' : 'changes'})`);
+        }
+    }
+    if (results.length > 0) {
+        logger.info(`\n📝 Source file changes: ${results.length} file${results.length === 1 ? '' : 's'}`);
+    }
+    return results;
+}
+async function replaceKeyInSource(code, oldParts, newParts, config) {
+    // Use regex-based replacement which is more reliable than AST manipulation
+    return replaceKeyWithRegex(code, oldParts, newParts, config);
+}
+function replaceKeyWithRegex(code, oldParts, newParts, config) {
+    let changes = 0;
+    let newCode = code;
+    const nsSeparator = config.extract.nsSeparator ?? ':';
+    // Helper to determine which key form to use in replacement
+    const getReplacementKey = (originalKey) => {
+        const hasNamespace = nsSeparator && originalKey.includes(String(nsSeparator));
+        return hasNamespace ? newParts.fullKey : newParts.key;
+    };
+    // Pattern 1: Function calls - respect configured functions
+    const configuredFunctions = config.extract.functions || ['t', '*.t'];
+    const functionPatterns = [];
+    for (const fnPattern of configuredFunctions) {
+        if (fnPattern.startsWith('*.')) {
+            // Wildcard pattern like '*.t' - match any prefix
+            const suffix = fnPattern.substring(1); // '.t'
+            const escapedSuffix = escapeRegex(suffix);
+            // Match: anyIdentifier.t('key')
+            functionPatterns.push({
+                pattern: new RegExp(`\\w+${escapedSuffix}\\((['"\`])${escapeRegex(oldParts.fullKey)}\\1`, 'g'),
+                original: oldParts.fullKey
+            });
+            functionPatterns.push({
+                pattern: new RegExp(`\\w+${escapedSuffix}\\((['"\`])${escapeRegex(oldParts.key)}\\1`, 'g'),
+                original: oldParts.key
+            });
+        }
+        else {
+            // Exact function name
+            const escapedFn = escapeRegex(fnPattern);
+            functionPatterns.push({
+                pattern: new RegExp(`\\b${escapedFn}\\((['"\`])${escapeRegex(oldParts.fullKey)}\\1`, 'g'),
+                original: oldParts.fullKey
+            });
+            functionPatterns.push({
+                pattern: new RegExp(`\\b${escapedFn}\\((['"\`])${escapeRegex(oldParts.key)}\\1`, 'g'),
+                original: oldParts.key
+            });
+        }
+    }
+    for (const { pattern, original } of functionPatterns) {
+        if (pattern.test(newCode)) {
+            const replacement = getReplacementKey(original);
+            newCode = newCode.replace(pattern, (match, quote) => {
+                changes++;
+                // Preserve the function name part, only replace the key
+                const functionNameMatch = match.match(/^(\w+(?:\.\w+)*)\(/);
+                if (functionNameMatch) {
+                    return `${functionNameMatch[1]}(${quote}${replacement}${quote}`;
+                }
+                return match;
+            });
+        }
+    }
+    // Pattern 2: Selector API arrow functions (e.g. t(($) => $.old.key) or i18n.t($ => $.old.key))
+    // Respect configured function names (including wildcard patterns)
+    for (const fnPattern of configuredFunctions) {
+        // Build a regex prefix for the function invocation (handles wildcard '*.t' -> '\w+\.t')
+        let patternPrefix;
+        if (fnPattern.startsWith('*.')) {
+            const suffix = fnPattern.substring(1); // '.t'
+            patternPrefix = `\\w+${escapeRegex(suffix)}`;
+        }
+        else {
+            patternPrefix = escapeRegex(fnPattern);
+        }
+        // Try matching both the plain key and the ns-prefixed fullKey used in selector access
+        for (const original of [oldParts.fullKey, oldParts.key]) {
+            // Match dot-notation selector forms like:
+            // t(($) => $.old.key)
+            // i18n.t($ => $.old.key.nested)
+            const selectorDotRegex = new RegExp(`(\\b${patternPrefix}\\(\\s*\\(?\\s*([a-zA-Z_$][\\w$]*)\\s*\\)?\\s*=>\\s*)\\2\\.${escapeRegex(original)}(\\s*\\))`, 'g');
+            if (selectorDotRegex.test(newCode)) {
+                const replacementKey = getReplacementKey(original);
+                newCode = newCode.replace(selectorDotRegex, (match, prefix, param, suffix) => {
+                    changes++;
+                    // Replace property chain with dot-notation replacement
+                    return `${prefix}${param}.${replacementKey}${suffix}`;
+                });
+            }
+            // Match bracket-notation selector forms like:
+            // t(($) => $["Old Key"])
+            const selectorBracketRegex = new RegExp(`(\\b${patternPrefix}\\(\\s*\\(?\\s*([a-zA-Z_$][\\w$]*)\\s*\\)?\\s*=>\\s*)\\2\\[\\s*(['"\`])${escapeRegex(original)}\\3\\s*\\](\\s*\\))`, 'g');
+            if (selectorBracketRegex.test(newCode)) {
+                const replacementKey = getReplacementKey(original);
+                const isIdentifier = (s) => /^[A-Za-z_$][\w$]*$/.test(s);
+                newCode = newCode.replace(selectorBracketRegex, (match, prefix, param, quote, suffix) => {
+                    changes++;
+                    // If the replacement is a valid identifier, convert to dot-notation, otherwise keep bracket-notation
+                    if (isIdentifier(replacementKey)) {
+                        return `${prefix}${param}.${replacementKey}${suffix}`;
+                    }
+                    return `${prefix}${param}[${quote}${replacementKey}${quote}]${suffix}`;
+                });
+            }
+        }
+    }
+    // Pattern 3: JSX i18nKey attribute - respect configured transComponents
+    // const transComponents = config.extract.transComponents || ['Trans']
+    // Create a pattern that matches i18nKey on any of the configured components
+    // This is a simplified approach - for more complex cases, consider AST-based replacement
+    const i18nKeyPatterns = [
+        { pattern: new RegExp(`i18nKey=(['"\`])${escapeRegex(oldParts.fullKey)}\\1`, 'g'), original: oldParts.fullKey },
+        { pattern: new RegExp(`i18nKey=(['"\`])${escapeRegex(oldParts.key)}\\1`, 'g'), original: oldParts.key }
+    ];
+    for (const { pattern, original } of i18nKeyPatterns) {
+        if (pattern.test(newCode)) {
+            const replacement = getReplacementKey(original);
+            newCode = newCode.replace(pattern, (match, quote) => {
+                changes++;
+                return `i18nKey=${quote}${replacement}${quote}`;
+            });
+        }
+    }
+    return { newCode, changes };
+}
+function escapeRegex(str) {
+    return str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+}
+async function updateTranslationFiles(oldParts, newParts, config, dryRun, logger) {
+    const results = [];
+    const keySeparator = config.extract.keySeparator ?? '.';
+    for (const locale of config.locales) {
+        const outputPath = getOutputPath(config.extract.output, locale, oldParts.namespace);
+        const fullPath = resolve(process.cwd(), outputPath);
+        try {
+            const translations = await loadTranslationFile(fullPath);
+            if (!translations)
+                continue;
+            const oldValue = getNestedValue(translations, oldParts.key, keySeparator);
+            if (oldValue === undefined)
+                continue;
+            // Remove old key
+            deleteNestedValue(translations, oldParts.key, keySeparator);
+            // Add new key with same value
+            setNestedValue(translations, newParts.key, oldValue, keySeparator);
+            if (!dryRun) {
+                const content = serializeTranslationFile(translations, config.extract.outputFormat, config.extract.indentation);
+                await writeFile(fullPath, content, 'utf-8');
+            }
+            results.push({ path: fullPath, updated: true });
+            logger.info(`   ${dryRun ? '(dry-run) ' : ''}✓ ${fullPath}`);
+        }
+        catch (error) {
+            // File doesn't exist or couldn't be processed
+        }
+    }
+    if (results.length > 0) {
+        logger.info(`\n📦 Translation file updates: ${results.length} file${results.length === 1 ? '' : 's'}`);
+    }
+    return results;
+}
+function deleteNestedValue(obj, path, separator) {
+    if (separator === false) {
+        delete obj[path];
+        return;
+    }
+    const keys = path.split(String(separator));
+    let current = obj;
+    for (let i = 0; i < keys.length - 1; i++) {
+        if (!current[keys[i]])
+            return;
+        current = current[keys[i]];
+    }
+    delete current[keys[keys.length - 1]];
+}
+
+export { runRenameKey };