ai-localize-codemods 2.0.5 → 2.0.6

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # ai-localize-codemods
 
+## 2.0.6
+
+### Patch Changes
+
+- Add per-package README.md files so each package displays documentation on npmjs.com
+- Update README version badge to 2.0.6
+
 ## 2.0.3
 
 ### Patch Changes

package/README.md

@@ -0,0 +1,78 @@
+# ai-localize-codemods
+
+> Automatic i18n codemod injection for React, Vue, and Angular — part of the [ai-localize-core](https://github.com/ai-localize/ai-localize-core) platform.
+
+[![npm version](https://img.shields.io/npm/v/ai-localize-codemods.svg)](https://www.npmjs.com/package/ai-localize-codemods)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+---
+
+## What it does
+
+Transforms source files using Babel AST + Recast to:
+
+1. Add the appropriate import (`useTranslation`, `useI18n`, `TranslateService`, …)
+2. Initialise the hook in each component
+3. Wrap every hardcoded string with the translation call: `t('key')`
+4. Preserve original code formatting (Recast format-preserving transforms)
+
+Supports **CDN URL replacement** in source files using an asset manifest.
+
+## Installation
+
+```bash
+npm install ai-localize-codemods
+```
+
+## Usage
+
+```ts
+import { CodemodRunner } from 'ai-localize-codemods';
+
+const runner = new CodemodRunner(config, process.cwd());
+const result = await runner.run(detectedTexts, { dryRun: false });
+// result.totalReplacements — number of string replacements
+// result.changedFiles       — number of files modified
+```
+
+## Codemod configuration
+
+Control what code is injected via the `codemods` block in `ai-localize.config.json`:
+
+```json
+{
+  "codemods": {
+    "importPackage": "react-i18next",
+    "hookName": "useTranslation",
+    "translationFunction": "t",
+    "namespace": "common",
+    "accessorStyle": "function"
+  }
+}
+```
+
+| Field | Default | Description |
+|---|---|---|
+| `importPackage` | `"react-i18next"` | npm package **or** project-relative path (e.g. `"src/hooks/useTranslation"`) |
+| `hookName` | `"useTranslation"` | Hook/function to import |
+| `translationFunction` | `"t"` | Accessor variable name |
+| `namespace` | — | Namespace arg: `useTranslation("common")` |
+| `accessorStyle` | `"function"` | `"function"` → `t('key')` · `"bracket"` → `t['key']` |
+
+### Local hook path resolution
+
+When `importPackage` is a project-relative path, the codemod computes the correct
+relative import for every transformed file:
+
+```
+src/components/Button.tsx → import { useTranslation } from '../../hooks/useTranslation'
+src/pages/Home.tsx        → import { useTranslation } from '../hooks/useTranslation'
+```
+
+---
+
+## Part of ai-localize-core
+
+Install the CLI for the complete toolset: `npm install -g ai-localize-cli`
+
+MIT © ai-localize-core contributors

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ai-localize-codemods",
-  "version": "2.0.5",
+  "version": "2.0.6",
   "description": "AST-based codemods to inject i18n wrappers into frontend source code",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -41,7 +41,7 @@
     "@babel/generator": "^7.23.9",
     "recast": "^0.23.4",
     "jscodeshift": "^0.15.2",
-    "ai-localize-shared": "2.0.5"
+    "ai-localize-shared": "2.0.6"
   },
   "devDependencies": {
     "@types/babel__generator": "^7.6.8",