ai-localize-codemods 2.0.0 → 2.0.1

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # ai-localize-codemods
 
+## 2.0.1
+
+### Patch Changes
+
+- Updated dependencies
+  - ai-localize-shared@2.0.1
+
 ## 2.0.0
 
 ### Major Changes

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { DetectedText, CloudFrontAsset, LegacyCdnUrl, LocalizationConfig } from 'ai-localize-shared';
+import { DetectedText, CodemodConfig, CloudFrontAsset, LegacyCdnUrl, LocalizationConfig } from 'ai-localize-shared';
 
 interface CodemodResult {
     filePath: string;
@@ -10,50 +10,102 @@ interface CodemodResult {
     replacedTexts: number;
 }
 /**
- * React i18n codemod: wraps hardcoded JSX text / string literals with t() calls.
+ * React i18n codemod: wraps hardcoded JSX text / string literals with t() or t[''] calls.
  * Preserves formatting, comments, and import order.
+ *
+ * ### Local hook import paths
+ *
+ * When `codemodConfig.importPackage` is a project-relative path (e.g. `"src/Locales/translate"`),
+ * the codemod computes the correct **relative import path for each file** it transforms:
+ *
+ *   src/components/Button.tsx      → `"../../Locales/translate"`
+ *   src/pages/dashboard/Header.tsx → `"../../../Locales/translate"`
+ *
+ * npm package names (no `/` prefix, not starting with `.`) are injected verbatim.
+ *
+ * ### Accessor styles
+ *   accessorStyle "function" (default) → t('key')
+ *   accessorStyle "bracket"  → t['key']
  */
 declare class ReactCodemod {
     private filePath;
     private content;
     private texts;
-    constructor(filePath: string, content: string, texts: DetectedText[]);
+    /** Resolved import specifier string (may differ per file for local paths) */
+    private importSpecifier;
+    private hookName;
+    private translationFn;
+    private namespace?;
+    private accessorStyle;
+    constructor(filePath: string, content: string, texts: DetectedText[], codemodConfig?: CodemodConfig, cwd?: string);
     transform(): CodemodResult;
-    private injectUseTranslationHook;
+    private injectHook;
 }
+/**
+ * Determines the import specifier string to inject for a given `importPackage`
+ * config value and the file being transformed.
+ *
+ * Rules:
+ *   1. If `importPackage` looks like an npm package name (no leading `.` or `/`
+ *      and no path separators in a way that suggests a local path starting with
+ *      a known directory like `src/`) → return verbatim.
+ *
+ *   2. If `importPackage` is an absolute path → compute `path.relative(fileDir, importPackage)`
+ *  and ensure it starts with `./` or `../`.
+ *
+ *   3. If `importPackage` is a project-relative path (starts with `src/`, `app/`,
+ *      `lib/`, `hooks/`, `utils/`, or any path without a leading `.`) that is NOT
+ *      a bare npm package name → resolve it relative to `cwd` first, then compute
+ *      `path.relative(fileDir, resolvedPath)`.
+ *
+ *   4. If `importPackage` starts with `./` or `../` → treat as a path relative to
+ *    `cwd` (config file location), resolve it, then compute relative to each file.
+ */
+declare function resolveImportSpecifier(importPackage: string, filePath: string, cwd: string): string;
 /**
  * Applies the React codemod to a file in-place.
  */
-declare function applyReactCodemod(filePath: string, texts: DetectedText[], dryRun?: boolean): CodemodResult;
+declare function applyReactCodemod(filePath: string, texts: DetectedText[], dryRun?: boolean, codemodConfig?: CodemodConfig, cwd?: string): CodemodResult;
 
 /**
- * Vue i18n codemod: wraps hardcoded text with $t() calls in Vue SFCs.
- * Handles both Options API and Composition API.
+ * Vue i18n codemod: wraps hardcoded text with $t() / t() calls in Vue SFCs.
+ * Handles both Options API (global $t) and Composition API (useI18n / useTranslation).
+ *
+ * The translation function name can be overridden via the `codemods.translationFunction`
+ * config field (default: "$t").
  */
 declare class VueCodemod {
     private filePath;
     private content;
     private texts;
-    constructor(filePath: string, content: string, texts: DetectedText[]);
+    private translationFn;
+    constructor(filePath: string, content: string, texts: DetectedText[], codemodConfig?: CodemodConfig);
     transform(): CodemodResult;
     private unchanged;
 }
-declare function applyVueCodemod(filePath: string, texts: DetectedText[], dryRun?: boolean): CodemodResult;
+declare function applyVueCodemod(filePath: string, texts: DetectedText[], dryRun?: boolean, codemodConfig?: CodemodConfig): CodemodResult;
 
 /**
  * Angular ngx-translate codemod:
  * - In templates: wraps text with {{ 'key' | translate }}
  * - In TS: replaces string literals with this.translateService.instant('key')
+ *
+ * The pipe name used in templates can be overridden via
+ * `codemods.translationFunction` (default: "translate").
+ * The TS service call can be overridden via `codemods.hookName`
+ * (default: "this.translateService.instant").
  */
 declare class AngularCodemod {
     private filePath;
     private content;
     private texts;
-    constructor(filePath: string, content: string, texts: DetectedText[]);
+    private templatePipe;
+    private tsServiceCall;
+    constructor(filePath: string, content: string, texts: DetectedText[], codemodConfig?: CodemodConfig);
     transform(): CodemodResult;
     private unchanged;
 }
-declare function applyAngularCodemod(filePath: string, texts: DetectedText[], dryRun?: boolean): CodemodResult;
+declare function applyAngularCodemod(filePath: string, texts: DetectedText[], dryRun?: boolean, codemodConfig?: CodemodConfig): CodemodResult;
 
 interface CdnReplacementResult {
     filePath: string;
@@ -92,14 +144,25 @@ interface CodemodRunSummary {
 }
 /**
  * Orchestrates codemods across all detected files.
- * Groups detected texts by file and applies the appropriate codemod
- * based on the project framework.
+ *
+ * Groups detected texts by file and applies the appropriate codemod based on
+ * the project framework.  Codemod behaviour (import package, hook name,
+ * translation function, namespace, accessor style) is driven by `config.codemods`
+ * so the user can override defaults in their ai-localize.config.json.
+ *
+ * ### Local hook import path resolution
+ * When `config.codemods.importPackage` is a project-relative path (e.g.
+ * `"src/Locales/translate"`), `cwd` is forwarded to `applyReactCodemod` so it
+ * can compute the correct relative import path for each individual file:
+ *   src/components/Button.tsx      → `"../../Locales/translate"`
+ *   src/pages/dashboard/Header.tsx → `"../../../Locales/translate"`
  */
 declare class CodemodRunner {
     private config;
-    constructor(config: LocalizationConfig);
+    private cwd;
+    constructor(config: LocalizationConfig, cwd?: string);
     run(detectedTexts: DetectedText[], options?: CodemodRunOptions): Promise<CodemodRunSummary>;
     private applyCodemod;
 }
 
-export { AngularCodemod, type CdnReplacementResult, CdnReplacer, type CodemodResult, type CodemodRunOptions, type CodemodRunSummary, CodemodRunner, ReactCodemod, VueCodemod, applyAngularCodemod, applyReactCodemod, applyVueCodemod, batchReplaceCdnUrls };
+export { AngularCodemod, type CdnReplacementResult, CdnReplacer, type CodemodResult, type CodemodRunOptions, type CodemodRunSummary, CodemodRunner, ReactCodemod, VueCodemod, applyAngularCodemod, applyReactCodemod, applyVueCodemod, batchReplaceCdnUrls, resolveImportSpecifier };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { DetectedText, CloudFrontAsset, LegacyCdnUrl, LocalizationConfig } from 'ai-localize-shared';
+import { DetectedText, CodemodConfig, CloudFrontAsset, LegacyCdnUrl, LocalizationConfig } from 'ai-localize-shared';
 
 interface CodemodResult {
     filePath: string;
@@ -10,50 +10,102 @@ interface CodemodResult {
     replacedTexts: number;
 }
 /**
- * React i18n codemod: wraps hardcoded JSX text / string literals with t() calls.
+ * React i18n codemod: wraps hardcoded JSX text / string literals with t() or t[''] calls.
  * Preserves formatting, comments, and import order.
+ *
+ * ### Local hook import paths
+ *
+ * When `codemodConfig.importPackage` is a project-relative path (e.g. `"src/Locales/translate"`),
+ * the codemod computes the correct **relative import path for each file** it transforms:
+ *
+ *   src/components/Button.tsx      → `"../../Locales/translate"`
+ *   src/pages/dashboard/Header.tsx → `"../../../Locales/translate"`
+ *
+ * npm package names (no `/` prefix, not starting with `.`) are injected verbatim.
+ *
+ * ### Accessor styles
+ *   accessorStyle "function" (default) → t('key')
+ *   accessorStyle "bracket"  → t['key']
  */
 declare class ReactCodemod {
     private filePath;
     private content;
     private texts;
-    constructor(filePath: string, content: string, texts: DetectedText[]);
+    /** Resolved import specifier string (may differ per file for local paths) */
+    private importSpecifier;
+    private hookName;
+    private translationFn;
+    private namespace?;
+    private accessorStyle;
+    constructor(filePath: string, content: string, texts: DetectedText[], codemodConfig?: CodemodConfig, cwd?: string);
     transform(): CodemodResult;
-    private injectUseTranslationHook;
+    private injectHook;
 }
+/**
+ * Determines the import specifier string to inject for a given `importPackage`
+ * config value and the file being transformed.
+ *
+ * Rules:
+ *   1. If `importPackage` looks like an npm package name (no leading `.` or `/`
+ *      and no path separators in a way that suggests a local path starting with
+ *      a known directory like `src/`) → return verbatim.
+ *
+ *   2. If `importPackage` is an absolute path → compute `path.relative(fileDir, importPackage)`
+ *  and ensure it starts with `./` or `../`.
+ *
+ *   3. If `importPackage` is a project-relative path (starts with `src/`, `app/`,
+ *      `lib/`, `hooks/`, `utils/`, or any path without a leading `.`) that is NOT
+ *      a bare npm package name → resolve it relative to `cwd` first, then compute
+ *      `path.relative(fileDir, resolvedPath)`.
+ *
+ *   4. If `importPackage` starts with `./` or `../` → treat as a path relative to
+ *    `cwd` (config file location), resolve it, then compute relative to each file.
+ */
+declare function resolveImportSpecifier(importPackage: string, filePath: string, cwd: string): string;
 /**
  * Applies the React codemod to a file in-place.
  */
-declare function applyReactCodemod(filePath: string, texts: DetectedText[], dryRun?: boolean): CodemodResult;
+declare function applyReactCodemod(filePath: string, texts: DetectedText[], dryRun?: boolean, codemodConfig?: CodemodConfig, cwd?: string): CodemodResult;
 
 /**
- * Vue i18n codemod: wraps hardcoded text with $t() calls in Vue SFCs.
- * Handles both Options API and Composition API.
+ * Vue i18n codemod: wraps hardcoded text with $t() / t() calls in Vue SFCs.
+ * Handles both Options API (global $t) and Composition API (useI18n / useTranslation).
+ *
+ * The translation function name can be overridden via the `codemods.translationFunction`
+ * config field (default: "$t").
  */
 declare class VueCodemod {
     private filePath;
     private content;
     private texts;
-    constructor(filePath: string, content: string, texts: DetectedText[]);
+    private translationFn;
+    constructor(filePath: string, content: string, texts: DetectedText[], codemodConfig?: CodemodConfig);
     transform(): CodemodResult;
     private unchanged;
 }
-declare function applyVueCodemod(filePath: string, texts: DetectedText[], dryRun?: boolean): CodemodResult;
+declare function applyVueCodemod(filePath: string, texts: DetectedText[], dryRun?: boolean, codemodConfig?: CodemodConfig): CodemodResult;
 
 /**
  * Angular ngx-translate codemod:
  * - In templates: wraps text with {{ 'key' | translate }}
  * - In TS: replaces string literals with this.translateService.instant('key')
+ *
+ * The pipe name used in templates can be overridden via
+ * `codemods.translationFunction` (default: "translate").
+ * The TS service call can be overridden via `codemods.hookName`
+ * (default: "this.translateService.instant").
  */
 declare class AngularCodemod {
     private filePath;
     private content;
     private texts;
-    constructor(filePath: string, content: string, texts: DetectedText[]);
+    private templatePipe;
+    private tsServiceCall;
+    constructor(filePath: string, content: string, texts: DetectedText[], codemodConfig?: CodemodConfig);
     transform(): CodemodResult;
     private unchanged;
 }
-declare function applyAngularCodemod(filePath: string, texts: DetectedText[], dryRun?: boolean): CodemodResult;
+declare function applyAngularCodemod(filePath: string, texts: DetectedText[], dryRun?: boolean, codemodConfig?: CodemodConfig): CodemodResult;
 
 interface CdnReplacementResult {
     filePath: string;
@@ -92,14 +144,25 @@ interface CodemodRunSummary {
 }
 /**
  * Orchestrates codemods across all detected files.
- * Groups detected texts by file and applies the appropriate codemod
- * based on the project framework.
+ *
+ * Groups detected texts by file and applies the appropriate codemod based on
+ * the project framework.  Codemod behaviour (import package, hook name,
+ * translation function, namespace, accessor style) is driven by `config.codemods`
+ * so the user can override defaults in their ai-localize.config.json.
+ *
+ * ### Local hook import path resolution
+ * When `config.codemods.importPackage` is a project-relative path (e.g.
+ * `"src/Locales/translate"`), `cwd` is forwarded to `applyReactCodemod` so it
+ * can compute the correct relative import path for each individual file:
+ *   src/components/Button.tsx      → `"../../Locales/translate"`
+ *   src/pages/dashboard/Header.tsx → `"../../../Locales/translate"`
  */
 declare class CodemodRunner {
     private config;
-    constructor(config: LocalizationConfig);
+    private cwd;
+    constructor(config: LocalizationConfig, cwd?: string);
     run(detectedTexts: DetectedText[], options?: CodemodRunOptions): Promise<CodemodRunSummary>;
     private applyCodemod;
 }
 
-export { AngularCodemod, type CdnReplacementResult, CdnReplacer, type CodemodResult, type CodemodRunOptions, type CodemodRunSummary, CodemodRunner, ReactCodemod, VueCodemod, applyAngularCodemod, applyReactCodemod, applyVueCodemod, batchReplaceCdnUrls };
+export { AngularCodemod, type CdnReplacementResult, CdnReplacer, type CodemodResult, type CodemodRunOptions, type CodemodRunSummary, CodemodRunner, ReactCodemod, VueCodemod, applyAngularCodemod, applyReactCodemod, applyVueCodemod, batchReplaceCdnUrls, resolveImportSpecifier };