i18ntk 2.0.4 → 2.2.0

package/utils/cli-helper.js

@@ -124,106 +124,34 @@ class CliHelper {
 }
 
 // Utility: Show framework suggestion warning only once per process
-let frameworkWarningShown = false;
-function showFrameworkWarningOnce(ui) {
-  if (frameworkWarningShown) return;
-  frameworkWarningShown = true;
-
-  // Try to use the proper translation system first
-  let t;
-  if (ui && typeof ui.t === 'function') {
-    t = ui.t.bind(ui);
-  } else {
-    // Fallback to loading the UI i18n system properly
-    try {
-      const UIi18n = require('../main/i18ntk-ui');
-      const fallbackUI = new UIi18n();
-      fallbackUI.loadLanguage('en'); // Load English as fallback
-      t = fallbackUI.t.bind(fallbackUI);
-    } catch (error) {
-      // Last resort: use locale files directly
-      try {
-        const path = require('path');
-        const fs = require('fs');
-        const localePath = path.join(__dirname, '..', 'resources', 'i18n', 'ui-locales', 'en.json');
-        if (SecurityUtils.safeExistsSync(localePath)) {
-          const translations = JSON.parse(SecurityUtils.safeReadFileSync(localePath, path.dirname(localePath), 'utf8'));
-          t = (key) => {
-            const keys = key.split('.');
-            let result = translations;
-            for (const k of keys) {
-              result = result && result[k];
-            }
-            return result || key;
-          };
-        } else {
-          throw new Error('Locale file not found');
-        }
-      } catch (fallbackError) {
-        // Final fallback: load from current UI locale or English
-        try {
-          const path = require('path');
-          const fs = require('fs');
-          
-          // Try to determine current language from settings
-          const settingsManager = require('../settings/settings-manager');
-          const settings = settingsManager.loadSettings();
-          const currentLang = settings.uiLanguage || 'en';
-          
-          const localePath = path.join(__dirname, '..', 'resources', 'i18n', 'ui-locales', `${currentLang}.json`);
-          if (SecurityUtils.safeExistsSync(localePath)) {
-            const translations = JSON.parse(SecurityUtils.safeReadFileSync(localePath, path.dirname(localePath), 'utf8'));
-            t = (key) => {
-              const keys = key.split('.');
-              let result = translations;
-              for (const k of keys) {
-                result = result && result[k];
-              }
-              return result || key;
-            };
-          } else {
-            // Fallback to English
-            const enLocalePath = path.join(__dirname, '..', 'resources', 'i18n', 'ui-locales', 'en.json');
-            if (SecurityUtils.safeExistsSync(enLocalePath)) {
-              const translations = JSON.parse(SecurityUtils.safeReadFileSync(enLocalePath, path.dirname(enLocalePath), 'utf8'));
-              t = (key) => {
-                const keys = key.split('.');
-                let result = translations;
-                for (const k of keys) {
-                  result = result && result[k];
-                }
-                return result || key;
-              };
-            } else {
-              throw new Error('No locale files found');
-            }
-          }
-        } catch (finalError) {
-          // Absolute last resort: basic hardcoded fallback
-          const messages = {
-            'init.suggestions.noFramework': 'No i18n framework detected. Consider using one of the following:',
-            'init.frameworks.react': ' - React i18next (react-i18next)',
-            'init.frameworks.vue': ' - Vue i18n (vue-i18next)',
-            'init.frameworks.i18next': ' - i18next (i18next)',
-            'init.frameworks.nuxt': ' - Nuxt i18n (@nuxtjs/i18next)',
-            'init.frameworks.svelte': ' - Svelte i18n (svelte-i18next)'
-          };
-          t = (key) => messages[key] || key;
-        }
-      }
-    }
-  }
-
-  console.log(t('init.suggestions.noFramework'));
-  console.log(t('init.frameworks.react'));
-  console.log(t('init.frameworks.vue'));
-  console.log(t('init.frameworks.i18next'));
-  console.log(t('init.frameworks.nuxt'));
-  console.log(t('init.frameworks.svelte'));
-}
+let frameworkWarningShown = false;
+function showFrameworkWarningOnce(ui) {
+  if (frameworkWarningShown) return;
+  frameworkWarningShown = true;
+
+  const translate = ui && typeof ui.t === 'function'
+    ? ui.t.bind(ui)
+    : require('./i18n-helper').t;
+
+  const fallback = {
+    noFramework: 'No i18n framework detected. Consider using one of the following:',
+    react: ' - React i18next (react-i18next)',
+    vue: ' - Vue i18n (vue-i18next)',
+    i18next: ' - i18next (i18next)',
+    nuxt: ' - Nuxt i18n (@nuxtjs/i18n)',
+    svelte: ' - Svelte i18n (svelte-i18n)'
+  };
+
+  console.log(translate('init.suggestions.noFramework') || fallback.noFramework);
+  console.log(translate('init.frameworks.react') || fallback.react);
+  console.log(translate('init.frameworks.vue') || fallback.vue);
+  console.log(translate('init.frameworks.i18next') || fallback.i18next);
+  console.log(translate('init.frameworks.nuxt') || fallback.nuxt);
+  console.log(translate('init.frameworks.svelte') || fallback.svelte);
+}
 
 // Export a singleton instance and attach utility for backward compatibility
 const cliHelper = new CliHelper();
 cliHelper.showFrameworkWarningOnce = showFrameworkWarningOnce;
 
-module.exports = cliHelper;
+module.exports = cliHelper;

package/utils/extractors/regex.js

@@ -1,21 +1,48 @@
-function extract(content, patterns = []) {
-  const keys = new Set();
-  if (!Array.isArray(patterns)) return [];
-  if (content === null || content === undefined) return [];
+function normalizeKeyCandidate(rawKey) {
+  if (rawKey === null || rawKey === undefined) return null;
+
+  let key = String(rawKey).trim();
+  if (!key) return null;
+
+  // Normalize dynamic template segments to wildcard form.
+  key = key.replace(/\$\{[^}]+\}/g, '*');
+
+  // Reject multiline keys and obvious code fragments.
+  if (/[\r\n\t]/.test(key)) return null;
+  if (/\s/.test(key)) return null;
+  if (/(=>|\|\||&&|function\b|return\b|includes\()/i.test(key)) return null;
+
+  // Allow typical i18n key character sets only.
+  if (!/^[A-Za-z0-9_.:*-]+$/.test(key)) return null;
+
+  // Reject malformed key shapes.
+  if (key.startsWith('.') || key.endsWith('.')) return null;
+  if (key.includes('..')) return null;
+
+  return key;
+}
+
+function extract(content, patterns = []) {
+  const keys = new Set();
+  if (!Array.isArray(patterns)) return [];
+  if (content === null || content === undefined) return [];
   const contentStr = String(content);
   for (const pattern of patterns) {
     try {
-      let regex = pattern instanceof RegExp ? new RegExp(pattern.source, 'g') : new RegExp(pattern, 'g');
-      let match;
-      while ((match = regex.exec(contentStr)) !== null) {
-        if (match[1]) keys.add(match[1]);
-        if (regex.lastIndex === 0) break;
-      }
-    } catch (e) {
+      let regex = pattern instanceof RegExp ? new RegExp(pattern.source, 'g') : new RegExp(pattern, 'g');
+      let match;
+      while ((match = regex.exec(contentStr)) !== null) {
+        if (match[1]) {
+          const normalized = normalizeKeyCandidate(match[1]);
+          if (normalized) keys.add(normalized);
+        }
+        if (regex.lastIndex === 0) break;
+      }
+    } catch (e) {
       // skip invalid patterns
     }
   }
   return Array.from(keys);
 }
 
-module.exports = { extract };
+module.exports = { extract };

package/utils/i18n-helper.js

@@ -11,23 +11,24 @@ function getSecurityUtils() {
     } catch (error) {
       // Fallback: use basic fs operations if SecurityUtils is not available
       return {
-        safeExistsSync: (path) => {
+        safeExistsSync: (targetPath) => {
           try {
-            return require('fs').existsSync(path);
+            require('fs').accessSync(targetPath);
+            return true;
           } catch {
             return false;
           }
         },
-        safeWriteFileSync: (path, data, encoding) => {
+        safeWriteFileSync: (targetPath, data, _basePath, encoding = 'utf8') => {
           try {
-            return require('fs').writeFileSync(path, data, encoding);
+            return require('fs').writeFileSync(targetPath, data, encoding);
           } catch {
             return null;
           }
         },
-        safeReadFileSync: (path, encoding) => {
+        safeReadFileSync: (targetPath, _basePath, encoding = 'utf8') => {
           try {
-            return require('fs').readFileSync(path, encoding);
+            return require('fs').readFileSync(targetPath, encoding);
           } catch {
             return null;
           }
@@ -56,9 +57,42 @@ function stripBOMAndComments(s) {
   return s;
 }
 
-function readJsonSafe(file) {
+function getValidationBase(targetPath) {
+  const fallbackBase = path.resolve(__dirname, '..');
+  if (!targetPath || typeof targetPath !== 'string') {
+    return fallbackBase;
+  }
+
+  let current = path.resolve(path.dirname(targetPath));
+  while (true) {
+    try {
+      if (fs.statSync(current).isDirectory()) {
+        return current;
+      }
+    } catch {
+      // Continue upward until we find an existing directory.
+    }
+
+    const parent = path.dirname(current);
+    if (parent === current) {
+      break;
+    }
+    current = parent;
+  }
+
+  return fallbackBase;
+}
+
+function safeReadFile(targetPath, encoding = 'utf8') {
   const SecurityUtils = getSecurityUtils();
-  const raw = SecurityUtils.safeReadFileSync(file, path.dirname(file), 'utf8');
+  return SecurityUtils.safeReadFileSync(targetPath, getValidationBase(targetPath), encoding);
+}
+
+function readJsonSafe(file) {
+  const raw = safeReadFile(file, 'utf8');
+  if (raw === null) {
+    throw new Error(`Unable to read JSON file: ${file}`);
+  }
   return JSON.parse(stripBOMAndComments(raw));
 }
 
@@ -67,21 +101,30 @@ function pkgUiLocalesDirViaThisFile() {
 }
 
 function pkgUiLocalesDirViaResolve() {
-  try {
-    const enJson = require.resolve('i18ntk/ui-locales/en.json');
-    return path.dirname(enJson);
-  } catch { return null; }
-}
+    try {
+        // Try the new correct path first (ui-locales/en.json)
+        const enJson = require.resolve('i18ntk/ui-locales/en.json');
+        return path.dirname(enJson);
+    } catch {
+        try {
+            // Fallback to the old incorrect path for backward compatibility
+            const enJson = require.resolve('i18ntk/resources/i18n/ui-locales/en.json');
+            return path.dirname(enJson);
+        } catch { return null; }
+        }
+    }
+
+// Removed legacyResourcesUiLocalesDir as resources/i18n/ui-locales is deprecated
 
-function resolveLocalesDirs() {
+function resolveLocalesDirs(preferredDir) {
+  const SecurityUtils = getSecurityUtils();
   const dirs = [];
   const addDir = (dir) => {
     if (typeof dir === 'string' && dir.trim()) {
       try {
         const normalized = path.normalize(path.resolve(dir.trim()));
-
-        const SecurityUtils = getSecurityUtils();
-        if (SecurityUtils.safeExistsSync(normalized) && fs.statSync(normalized).isDirectory()) {
+        const stats = SecurityUtils.safeStatSync(normalized, getValidationBase(normalized));
+        if (stats && stats.isDirectory()) {
           dirs.push(normalized);
         }
       } catch {
@@ -90,6 +133,8 @@ function resolveLocalesDirs() {
     }
   };
 
+  addDir(preferredDir);
+
   const pkgA = pkgUiLocalesDirViaThisFile();
   addDir(pkgA);
 
@@ -98,6 +143,8 @@ function resolveLocalesDirs() {
     addDir(pkgB);
   }
 
+  // Removed legacy directory fallback
+
   // Deduplicate while preserving order
   const seen = new Set();
     return dirs.filter(dir => {
@@ -114,8 +161,9 @@ function candidatesForLang(dir, lang) {
   ];
 }
 
-function findLocaleFilesAllDirs(lang) {
-  const dirs = resolveLocalesDirs();
+function findLocaleFilesAllDirs(lang, preferredDir) {
+  const SecurityUtils = getSecurityUtils();
+  const dirs = resolveLocalesDirs(preferredDir);
 
   if (process.env.I18NTK_DEBUG_LOCALES === '1') {
     console.log('🔎 i18ntk locale search dirs:', dirs);
@@ -127,14 +175,12 @@ function findLocaleFilesAllDirs(lang) {
   for (const dir of dirs) {
     for (const candidate of candidatesForLang(dir, lang)) {
       try {
-        const SecurityUtils = getSecurityUtils();
-        if (SecurityUtils.safeExistsSync(candidate)) {
-          const stats = fs.statSync(candidate);
-          if (stats.isFile() && stats.size > 0) {
+        const stats = SecurityUtils.safeStatSync(candidate, getValidationBase(candidate));
+        if (stats && stats.isFile() && stats.size > 0) {
             // Validate file is readable and parseable
             fs.accessSync(candidate, fs.constants.R_OK);
             // Quick JSON validation
-            const content = SecurityUtils.safeReadFileSync(candidate, path.dirname(candidate), 'utf8');
+            const content = safeReadFile(candidate, 'utf8');
             if (content) {
               if (content.trim().startsWith('{') || content.trim().startsWith('[')) {
                 files.push(candidate);
@@ -144,7 +190,6 @@ function findLocaleFilesAllDirs(lang) {
             } else {
               errors.push({ file: candidate, error: 'Empty or unreadable file' });
             }
-          }
         }
       } catch (error) {
         errors.push({ file: candidate, error: error.message });
@@ -164,20 +209,22 @@ let currentLanguage = 'en';
 let isInitialized = false;
 const missingWarned = new Set();
 
-function loadTranslations(language) {
-  const cfg = safeRequireConfig();
-  const settings = cfg?.getConfig?.() || {};
-  const configuredLanguage = settings.uiLanguage || settings.language;
-
-  // Prioritize CLI argument, then UI language, then language fallback
-  const requested = (language || configuredLanguage || 'en').toString();
+function loadTranslations(language) {
+  const cfg = safeRequireConfig();
+  const settings = cfg?.getConfig?.() || {};
+  const configuredLanguage = settings.uiLanguage || settings.language;
+
+  // Prioritize CLI argument, then UI language, then language fallback
+  const requested = (language || configuredLanguage || 'en').toString();
   const short = requested.split('-')[0].toLowerCase();
   const tryOrder = [requested, short, 'en'];
 
   const loadErrors = [];
 
+  const preferredDir = arguments.length > 1 ? arguments[1] : null;
+
   for (const lang of tryOrder) {
-    const files = findLocaleFilesAllDirs(lang);
+    const files = findLocaleFilesAllDirs(lang, preferredDir);
 
     // Prioritize bundled locales over project ones
       const prioritizedFiles = files.sort((a, b) => Number(isBundledPath(b)) - Number(isBundledPath(a)));
@@ -353,12 +400,13 @@ function getAvailableLanguages() {
   for (const d of dirs) {
     try {
       const SecurityUtils = getSecurityUtils();
-      if (!SecurityUtils.safeExistsSync(d)) continue;
+      if (!SecurityUtils.safeExistsSync(d, getValidationBase(d))) continue;
       for (const f of fs.readdirSync(d)) {
         if (f.endsWith('.json')) langs.add(path.basename(f, '.json'));
       }
       for (const f of fs.readdirSync(d, { withFileTypes: true })) {
-        if (f.isDirectory() && SecurityUtils.safeExistsSync(path.join(d, f.name, `${f.name}.json`))) {
+        const nestedPath = path.join(d, f.name, `${f.name}.json`);
+        if (f.isDirectory() && SecurityUtils.safeExistsSync(nestedPath, getValidationBase(nestedPath))) {
           langs.add(f.name);
         }
       }
@@ -391,10 +439,10 @@ function deepMerge(target, source) {
  * Refresh language from settings manager
  * This ensures translations stay in sync with settings changes
  */
-function refreshLanguageFromSettings() {
-  const cfg = safeRequireConfig();
-  const settings = cfg?.getConfig?.() || {};
-  const configuredLanguage = settings.uiLanguage || settings.language || 'en';
+function refreshLanguageFromSettings() {
+  const cfg = safeRequireConfig();
+  const settings = cfg?.getConfig?.() || {};
+  const configuredLanguage = settings.uiLanguage || settings.language || 'en';
 
   if (configuredLanguage !== currentLanguage) {
     isInitialized = false;
@@ -417,4 +465,4 @@ module.exports = {
   deepMerge,
   refreshTranslations,
   refreshLanguageFromSettings
-};
+};