i18nsmith 0.3.4 → 0.4.0

package/src/commands/rename.ts

@@ -4,6 +4,7 @@ import path from 'node:path';
 import { promises as fs } from 'node:fs';
 import { loadConfig, KeyRenamer, type KeyRenameSummary, type KeyRenameBatchSummary, type KeyRenameMapping } from '@i18nsmith/core';
 import { applyPreviewFile, writePreviewFile } from '../utils/preview.js';
+import { runAdapterPreflight } from '../utils/adapter-preflight.js';
 import { CliError, withErrorHandling } from '../utils/errors.js';
 
 interface ScanOptions {
@@ -59,6 +60,12 @@ export function registerRename(program: Command): void {
 
         try {
           const config = await loadConfig(options.config);
+
+          // Run preflight checks for write operations
+          if (writeEnabled) {
+            await runAdapterPreflight();
+          }
+
           const renamer = new KeyRenamer(config);
           const summary = await renamer.rename(oldKey, newKey, {
             write: options.write,
@@ -113,6 +120,12 @@ export function registerRename(program: Command): void {
 
         try {
           const config = await loadConfig(options.config);
+
+          // Run preflight checks for write operations
+          if (options.write) {
+            await runAdapterPreflight();
+          }
+
           const mappings = await loadRenameMappings(options.map);
           const renamer = new KeyRenamer(config);
           const summary = await renamer.renameBatch(mappings, { write: options.write, diff: options.diff });

package/src/commands/review.ts

@@ -138,7 +138,7 @@ export function registerReview(program: Command) {
       withErrorHandling(async (options: ReviewCommandOptions) => {
         try {
           const { config, projectRoot, configPath } = await loadConfigWithMeta(options.config);
-          const scanner = new Scanner(config, { workspaceRoot: projectRoot });
+          const scanner = await Scanner.create(config, { workspaceRoot: projectRoot });
           const summary = scanner.scan({ scanCalls: options.scanCalls }) as BucketedScanSummary;
           const buckets = summary.buckets ?? {};
           const needsReview = buckets.needsReview ?? [];

package/src/commands/scan.ts

@@ -75,7 +75,10 @@ export function registerScan(program: Command) {
           if (options.exclude?.length) {
             config.exclude = options.exclude;
           }
-          const scanner = new Scanner(config, { workspaceRoot: projectRoot });
+          // Use factory that registers framework adapters (React/Vue) so
+          // scans include files handled by adapters. Backwards compatible
+          // API: Scanner.create will return a scanner with adapters wired.
+          const scanner = await Scanner.create(config, { workspaceRoot: projectRoot });
           const summary = scanner.scan();
 
           if (options.report) {

package/src/commands/sync.ts

@@ -554,12 +554,15 @@ export function registerSync(program: Command) {
 
         // Handle --auto-rename-suspicious
         if (options.autoRenameSuspicious && summary.suspiciousKeys.length > 0) {
-          await handleAutoRenameSuspicious(
+          const renameDiffs = await handleAutoRenameSuspicious(
             summary,
             options,
             config,
             projectRoot
           );
+          if (renameDiffs && renameDiffs.length > 0) {
+            summary.renameDiffs = renameDiffs;
+          }
         }
 
         // Handle --rewrite-shape
@@ -857,7 +860,7 @@ async function handleAutoRenameSuspicious(
   options: SyncCommandOptions,
   config: Awaited<ReturnType<typeof loadConfig>>,
   projectRoot: string
-) {
+): Promise<any[] | undefined> {
   console.log(chalk.blue("\n📝 Auto-rename suspicious keys analysis:"));
 
   // Get existing keys from locale data to check for conflicts
@@ -1008,6 +1011,23 @@ async function handleAutoRenameSuspicious(
       chalk.gray("  Run with --write to apply safe proposals automatically.")
     );
   }
+
+  // Generate diffs for preview mode
+  if (options.diff && report.safeProposals.length > 0) {
+    const mappings = report.safeProposals.map((proposal) => ({
+      from: proposal.originalKey,
+      to: proposal.proposedKey,
+    }));
+
+    const renamer = new KeyRenamer(config, { workspaceRoot: projectRoot });
+    const diffSummary = await renamer.renameBatch(mappings, {
+      write: false,
+      diff: true,
+      allowConflicts: true,
+    });
+
+    return diffSummary.diffs;
+  }
 }
 
 async function handleRewriteShape(

package/src/commands/transform.ts

@@ -1,5 +1,7 @@
 import fs from 'fs/promises';
 import path from 'path';
+import { createRequire } from 'module';
+import { fileURLToPath } from 'url';
 import chalk from 'chalk';
 import type { Command } from 'commander';
 import { loadConfigWithMeta } from '@i18nsmith/core';
@@ -8,6 +10,8 @@ import type { TransformProgress, TransformSummary } from '@i18nsmith/transformer
 import { printLocaleDiffs, writeLocaleDiffPatches } from '../utils/diff-utils.js';
 import { applyPreviewFile, writePreviewFile } from '../utils/preview.js';
 import { CliError, withErrorHandling } from '../utils/errors.js';
+import inquirer from 'inquirer';
+import { detectPackageManager, installDependencies } from '../utils/package-manager.js';
 
 interface TransformOptions {
   config?: string;
@@ -32,6 +36,7 @@ const collectTargetPatterns = (value: string | string[], previous: string[]) =>
   return [...previous, ...tokens];
 };
 
+/* Re-enabled after framework migration stabilization */
 function printTransformSummary(summary: TransformSummary) {
   const counts = summary.candidates.reduce(
     (acc, c) => {
@@ -68,7 +73,8 @@ function printTransformSummary(summary: TransformSummary) {
 
   console.table(preview);
 
-  const pending = summary.candidates.filter((candidate) => candidate.status === 'pending').length;
+  const pending = summary.candidateStats?.pending
+    ?? summary.candidates.filter((candidate) => candidate.status === 'pending').length;
   if (pending > 0) {
     console.log(
       chalk.yellow(
@@ -97,6 +103,13 @@ function printTransformSummary(summary: TransformSummary) {
     console.log(chalk.yellow('Skipped items:'));
     summary.skippedFiles.forEach((item) => console.log(`  • ${item.filePath}: ${item.reason}`));
   }
+
+  if (summary.skippedReasons && Object.keys(summary.skippedReasons).length) {
+    console.log(chalk.yellow('Skipped reasons:'));
+    (Object.entries(summary.skippedReasons) as [string, number][])
+      .sort((a, b) => b[1] - a[1])
+      .forEach(([reason, count]) => console.log(`  • ${reason}: ${count}`));
+  }
 }
 
 function createProgressLogger() {
@@ -194,7 +207,7 @@ export function registerTransform(program: Command) {
     .option('--apply-preview <path>', 'Apply a previously saved transform preview JSON file safely')
     .action(
       withErrorHandling(async (options: TransformOptions) => {
-      if (options.applyPreview) {
+        if (options.applyPreview) {
         await applyPreviewFile('transform', options.applyPreview);
         return;
       }
@@ -225,6 +238,45 @@ export function registerTransform(program: Command) {
           console.log(chalk.gray(`Config found at ${path.relative(cwd, configPath)}`));
           console.log(chalk.gray(`Using project root: ${projectRoot}\n`));
         }
+
+        // Proactively check if Vue files are targeted but the parser is missing
+        const includesVue = config.include?.some(pattern => pattern.includes('.vue')) ?? false;
+        let isVueParserAvailable = false;
+        try {
+          const require = createRequire(import.meta.url);
+          const moduleDir = path.dirname(fileURLToPath(import.meta.url));
+          require.resolve('vue-eslint-parser', { paths: [projectRoot, moduleDir] });
+          isVueParserAvailable = true;
+        } catch {
+          isVueParserAvailable = false;
+        }
+
+        if (includesVue && !isVueParserAvailable) {
+          console.log(chalk.yellow('⚠️  Vue files detected but "vue-eslint-parser" is not installed.'));
+          console.log(chalk.yellow('   Verification of Vue templates might be incomplete or fail.'));
+          
+          if (process.stdout.isTTY) {
+            const { install } = await inquirer.prompt<{ install: boolean }>([
+              {
+                type: 'confirm',
+                name: 'install',
+                message: 'Do you want to install "vue-eslint-parser" (dev dependency) now?',
+                default: true,
+              },
+            ]);
+
+            if (install) {
+              const pm = await detectPackageManager(projectRoot);
+              const cmd = pm === 'npm' ? 'npm install --save-dev vue-eslint-parser' : `${pm} add -D vue-eslint-parser`;
+              console.log(chalk.gray(`> ${cmd}`));
+              // We use installDependencies helper but need to pass dev flag args if not flexible
+              // The helper seems simple: const args = manager === 'npm' ? ['install', ...deps] : ['add', ...deps];
+              // So for dev we need to include -D in deps
+              await installDependencies(pm, ['-D', 'vue-eslint-parser'], projectRoot);
+              console.log(chalk.green('✔ Installed. Continuing...'));
+            }
+          }
+        }
         
         const transformer = new Transformer(config, { workspaceRoot: projectRoot });
         const progressLogger = createProgressLogger();

package/src/e2e.test.ts

@@ -281,13 +281,13 @@ describe('E2E Fixture Tests', () => {
   const renameMap = parseRenameMap(mapContents);
   const helloKey = renameMap['Hello World'];
   expect(helloKey).toBeDefined();
-  const submitKey = renameMap['buttons.submit'];
-  expect(submitKey).toBeDefined();
+  const saveKey = renameMap['Save'];
+  expect(saveKey).toBeDefined();
 
   expect(enLocale).toHaveProperty(helloKey!);
   expect(frLocale).toHaveProperty(helloKey!);
-  expect(enLocale).toHaveProperty(submitKey!);
-  expect(frLocale).toHaveProperty(submitKey!);
+  expect(enLocale).toHaveProperty(saveKey!);
+  expect(frLocale).toHaveProperty(saveKey!);
 
   const sourceFile = await fs.readFile(path.join(fixtureDir, 'src', 'BadKeys.tsx'), 'utf8');
   expect(sourceFile).toContain(`t('${helloKey!}')`);

package/src/fixtures/suspicious-keys/locales/en.json

@@ -1,11 +1,11 @@
 {
-  "Hello World": "Hello World",
-  "Welcome to our app!": "Welcome to our app!",
-  "Click Here": "Click Here",
-  "Save": "Save",
-  "The Quick Brown Fox": "The Quick Brown Fox",
-  "When to use this feature:": "When to use this feature:",
+  "common.badkeys.buttons-submit.3b94a6": "Submit",
+  "common.badkeys.click-here.788c1e": "Click Here",
+  "common.badkeys.hello-world.66bf53": "Hello World",
+  "common.badkeys.save.a495bf": "Save",
+  "common.badkeys.welcome-to-our-app.a53bf0": "Welcome to our app!",
+  "common.title": "Application Title",
   "proper.namespaced.key": "This is a properly namespaced key",
-  "buttons.submit": "Submit",
-  "common.title": "Application Title"
+  "The Quick Brown Fox": "The Quick Brown Fox",
+  "When to use this feature:": "When to use this feature:"
 }

package/src/fixtures/suspicious-keys/locales/fr.json

@@ -1,11 +1,11 @@
 {
-  "Hello World": "Bonjour le monde",
-  "Welcome to our app!": "Bienvenue dans notre application!",
-  "Click Here": "Cliquez ici",
-  "Save": "Sauvegarder",
-  "The Quick Brown Fox": "Le Renard Brun Rapide",
-  "When to use this feature:": "Quand utiliser cette fonctionnalité:",
+  "common.badkeys.buttons-submit.3b94a6": "Soumettre",
+  "common.badkeys.click-here.788c1e": "Cliquez ici",
+  "common.badkeys.hello-world.66bf53": "Bonjour le monde",
+  "common.badkeys.save.a495bf": "Sauvegarder",
+  "common.badkeys.welcome-to-our-app.a53bf0": "Bienvenue dans notre application!",
+  "common.title": "Titre de l'application",
   "proper.namespaced.key": "Ceci est une clé correctement nommée",
-  "buttons.submit": "Soumettre",
-  "common.title": "Titre de l'application"
+  "The Quick Brown Fox": "Le Renard Brun Rapide",
+  "When to use this feature:": "Quand utiliser cette fonctionnalité:"
 }

package/src/fixtures/suspicious-keys/preview.json

@@ -0,0 +1,419 @@
+{
+  "type": "sync-preview",
+  "version": 1,
+  "command": "i18nsmith sync --diff --auto-rename-suspicious --preview-output preview.json",
+  "args": [
+    "sync",
+    "--diff",
+    "--auto-rename-suspicious",
+    "--preview-output",
+    "preview.json"
+  ],
+  "timestamp": "2026-02-08T16:49:09.709Z",
+  "summary": {
+    "filesScanned": 1,
+    "references": [
+      {
+        "key": "Hello World",
+        "filePath": "src/BadKeys.tsx",
+        "position": {
+          "line": 9,
+          "column": 12
+        }
+      },
+      {
+        "key": "Welcome to our app!",
+        "filePath": "src/BadKeys.tsx",
+        "position": {
+          "line": 10,
+          "column": 11
+        }
+      },
+      {
+        "key": "Click Here",
+        "filePath": "src/BadKeys.tsx",
+        "position": {
+          "line": 11,
+          "column": 20
+        }
+      },
+      {
+        "key": "Save",
+        "filePath": "src/BadKeys.tsx",
+        "position": {
+          "line": 12,
+          "column": 16
+        }
+      },
+      {
+        "key": "proper.namespaced.key",
+        "filePath": "src/BadKeys.tsx",
+        "position": {
+          "line": 15,
+          "column": 11
+        }
+      },
+      {
+        "key": "buttons.submit",
+        "filePath": "src/BadKeys.tsx",
+        "position": {
+          "line": 16,
+          "column": 16
+        }
+      }
+    ],
+    "missingKeys": [
+      {
+        "key": "Hello World",
+        "references": [
+          {
+            "key": "Hello World",
+            "filePath": "src/BadKeys.tsx",
+            "position": {
+              "line": 9,
+              "column": 12
+            }
+          }
+        ],
+        "suspicious": true
+      },
+      {
+        "key": "Welcome to our app!",
+        "references": [
+          {
+            "key": "Welcome to our app!",
+            "filePath": "src/BadKeys.tsx",
+            "position": {
+              "line": 10,
+              "column": 11
+            }
+          }
+        ],
+        "suspicious": true
+      },
+      {
+        "key": "Click Here",
+        "references": [
+          {
+            "key": "Click Here",
+            "filePath": "src/BadKeys.tsx",
+            "position": {
+              "line": 11,
+              "column": 20
+            }
+          }
+        ],
+        "suspicious": true
+      },
+      {
+        "key": "Save",
+        "references": [
+          {
+            "key": "Save",
+            "filePath": "src/BadKeys.tsx",
+            "position": {
+              "line": 12,
+              "column": 16
+            }
+          }
+        ],
+        "suspicious": true
+      },
+      {
+        "key": "buttons.submit",
+        "references": [
+          {
+            "key": "buttons.submit",
+            "filePath": "src/BadKeys.tsx",
+            "position": {
+              "line": 16,
+              "column": 16
+            }
+          }
+        ],
+        "suspicious": false
+      }
+    ],
+    "unusedKeys": [
+      {
+        "key": "common.badkeys.buttons-submit.3b94a6",
+        "locales": [
+          "en",
+          "fr"
+        ]
+      },
+      {
+        "key": "common.badkeys.click-here.788c1e",
+        "locales": [
+          "en",
+          "fr"
+        ]
+      },
+      {
+        "key": "common.badkeys.hello-world.66bf53",
+        "locales": [
+          "en",
+          "fr"
+        ]
+      },
+      {
+        "key": "common.badkeys.save.a495bf",
+        "locales": [
+          "en",
+          "fr"
+        ]
+      },
+      {
+        "key": "common.badkeys.welcome-to-our-app.a53bf0",
+        "locales": [
+          "en",
+          "fr"
+        ]
+      },
+      {
+        "key": "common.title",
+        "locales": [
+          "en",
+          "fr"
+        ]
+      },
+      {
+        "key": "The Quick Brown Fox",
+        "locales": [
+          "en",
+          "fr"
+        ]
+      },
+      {
+        "key": "When to use this feature:",
+        "locales": [
+          "en",
+          "fr"
+        ]
+      }
+    ],
+    "localeStats": [],
+    "localePreview": [],
+    "diffs": [],
+    "localeDiffs": [],
+    "placeholderIssues": [],
+    "emptyValueViolations": [],
+    "dynamicKeyWarnings": [],
+    "suspiciousKeys": [
+      {
+        "key": "Hello World",
+        "filePath": "src/BadKeys.tsx",
+        "position": {
+          "line": 9,
+          "column": 12
+        },
+        "reason": "contains-spaces"
+      },
+      {
+        "key": "Welcome to our app!",
+        "filePath": "src/BadKeys.tsx",
+        "position": {
+          "line": 10,
+          "column": 11
+        },
+        "reason": "contains-spaces"
+      },
+      {
+        "key": "Click Here",
+        "filePath": "src/BadKeys.tsx",
+        "position": {
+          "line": 11,
+          "column": 20
+        },
+        "reason": "contains-spaces"
+      },
+      {
+        "key": "Save",
+        "filePath": "src/BadKeys.tsx",
+        "position": {
+          "line": 12,
+          "column": 16
+        },
+        "reason": "single-word-no-namespace"
+      }
+    ],
+    "validation": {
+      "interpolations": false,
+      "emptyValuePolicy": "warn"
+    },
+    "assumedKeys": [],
+    "write": false,
+    "actionableItems": [
+      {
+        "kind": "suspicious-keys",
+        "severity": "warn",
+        "message": "4 suspicious keys detected (contains spaces or special chars) — auto-insert skipped until keys are renamed.",
+        "details": {
+          "count": 4,
+          "policy": "skip",
+          "keys": [
+            "Hello World",
+            "Welcome to our app!",
+            "Click Here",
+            "Save"
+          ],
+          "fallbackLiterals": []
+        }
+      },
+      {
+        "kind": "missing-key",
+        "severity": "error",
+        "key": "Hello World",
+        "filePath": "src/BadKeys.tsx",
+        "message": "Key \"Hello World\" referenced 1 time but missing from source locale",
+        "details": {
+          "referenceCount": 1
+        }
+      },
+      {
+        "kind": "missing-key",
+        "severity": "error",
+        "key": "Welcome to our app!",
+        "filePath": "src/BadKeys.tsx",
+        "message": "Key \"Welcome to our app!\" referenced 1 time but missing from source locale",
+        "details": {
+          "referenceCount": 1
+        }
+      },
+      {
+        "kind": "missing-key",
+        "severity": "error",
+        "key": "Click Here",
+        "filePath": "src/BadKeys.tsx",
+        "message": "Key \"Click Here\" referenced 1 time but missing from source locale",
+        "details": {
+          "referenceCount": 1
+        }
+      },
+      {
+        "kind": "missing-key",
+        "severity": "error",
+        "key": "Save",
+        "filePath": "src/BadKeys.tsx",
+        "message": "Key \"Save\" referenced 1 time but missing from source locale",
+        "details": {
+          "referenceCount": 1
+        }
+      },
+      {
+        "kind": "missing-key",
+        "severity": "error",
+        "key": "buttons.submit",
+        "filePath": "src/BadKeys.tsx",
+        "message": "Key \"buttons.submit\" referenced 1 time but missing from source locale",
+        "details": {
+          "referenceCount": 1
+        }
+      },
+      {
+        "kind": "unused-key",
+        "severity": "warn",
+        "key": "common.badkeys.buttons-submit.3b94a6",
+        "message": "Key \"common.badkeys.buttons-submit.3b94a6\" is present in locales (en, fr) but not referenced in code",
+        "details": {
+          "locales": [
+            "en",
+            "fr"
+          ]
+        }
+      },
+      {
+        "kind": "unused-key",
+        "severity": "warn",
+        "key": "common.badkeys.click-here.788c1e",
+        "message": "Key \"common.badkeys.click-here.788c1e\" is present in locales (en, fr) but not referenced in code",
+        "details": {
+          "locales": [
+            "en",
+            "fr"
+          ]
+        }
+      },
+      {
+        "kind": "unused-key",
+        "severity": "warn",
+        "key": "common.badkeys.hello-world.66bf53",
+        "message": "Key \"common.badkeys.hello-world.66bf53\" is present in locales (en, fr) but not referenced in code",
+        "details": {
+          "locales": [
+            "en",
+            "fr"
+          ]
+        }
+      },
+      {
+        "kind": "unused-key",
+        "severity": "warn",
+        "key": "common.badkeys.save.a495bf",
+        "message": "Key \"common.badkeys.save.a495bf\" is present in locales (en, fr) but not referenced in code",
+        "details": {
+          "locales": [
+            "en",
+            "fr"
+          ]
+        }
+      },
+      {
+        "kind": "unused-key",
+        "severity": "warn",
+        "key": "common.badkeys.welcome-to-our-app.a53bf0",
+        "message": "Key \"common.badkeys.welcome-to-our-app.a53bf0\" is present in locales (en, fr) but not referenced in code",
+        "details": {
+          "locales": [
+            "en",
+            "fr"
+          ]
+        }
+      },
+      {
+        "kind": "unused-key",
+        "severity": "warn",
+        "key": "common.title",
+        "message": "Key \"common.title\" is present in locales (en, fr) but not referenced in code",
+        "details": {
+          "locales": [
+            "en",
+            "fr"
+          ]
+        }
+      },
+      {
+        "kind": "unused-key",
+        "severity": "warn",
+        "key": "The Quick Brown Fox",
+        "message": "Key \"The Quick Brown Fox\" is present in locales (en, fr) but not referenced in code",
+        "details": {
+          "locales": [
+            "en",
+            "fr"
+          ]
+        }
+      },
+      {
+        "kind": "unused-key",
+        "severity": "warn",
+        "key": "When to use this feature:",
+        "message": "Key \"When to use this feature:\" is present in locales (en, fr) but not referenced in code",
+        "details": {
+          "locales": [
+            "en",
+            "fr"
+          ]
+        }
+      }
+    ],
+    "renameDiffs": [
+      {
+        "path": "/Users/arturlavrov/Documents/GitHub/i18nsmith/packages/cli/src/fixtures/suspicious-keys/src/BadKeys.tsx",
+        "relativePath": "src/BadKeys.tsx",
+        "diff": "Index: src/BadKeys.tsx\n===================================================================\n--- src/BadKeys.tsx\n+++ src/BadKeys.tsx\n@@ -5,12 +5,12 @@\n   \n   return (\n     <div>\n       {/* These are bad keys - text as key */}\n-      <h1>{t('Hello World')}</h1>\n-      <p>{t('Welcome to our app!')}</p>\n-      <a href=\"#\">{t('Click Here')}</a>\n-      <button>{t('Save')}</button>\n+      <h1>{t('common.badkeys.hello-world.66bf53')}</h1>\n+      <p>{t('common.badkeys.welcome-to-our-app.a53bf0')}</p>\n+      <a href=\"#\">{t('common.badkeys.click-here.788c1e')}</a>\n+      <button>{t('common.badkeys.save.a495bf')}</button>\n       \n       {/* These are good keys */}\n       <p>{t('proper.namespaced.key')}</p>\n       <button>{t('buttons.submit')}</button>\n",
+        "changes": 8
+      }
+    ]
+  }
+}