ai-localize-locale-engine 2.0.5 → 2.0.7

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # ai-localize-locale-engine
 
+## 2.0.7
+
+### Patch Changes
+
+- Added `repository`, `homepage`, `bugs`, `author` fields to `package.json` for npm registry display.
+- Added `sideEffects: false` to enable tree-shaking in bundlers.
+- Added `prepublishOnly` script to ensure the package is built before publishing.
+
+## 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
 
 ### Minor Changes

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-2026 ai-localize-core contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,97 @@
+# ai-localize-locale-engine
+
+> Locale file extraction, writing, merging, deduplication, and synchronization for the [ai-localize-core](https://github.com/ai-localize/ai-localize-core) platform.
+
+[![npm version](https://img.shields.io/npm/v/ai-localize-locale-engine.svg)](https://www.npmjs.com/package/ai-localize-locale-engine)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+---
+
+## What it does
+
+- **`LocaleExtractor`** — converts `DetectedText[]` into `LocaleFile[]` with namespace splitting, key deduplication, and `staticKeys` injection
+- **`LocaleWriter`** — writes locale JSON files with merge support (preserves existing translations)
+- **`deduplicateTexts()`** — deduplicates scanned texts by key so the same string isn't extracted twice
+- **Flat and nested layouts** — one file per language, or one per language+namespace
+
+## Installation
+
+```bash
+npm install ai-localize-locale-engine
+```
+
+## Usage
+
+```ts
+import { LocaleExtractor, LocaleWriter, deduplicateTexts } from 'ai-localize-locale-engine';
+
+// Extract
+const extractor = new LocaleExtractor({
+  defaultLanguage: 'en',
+  targetLanguages: ['fr', 'de'],
+  namespaceSplitting: true,       // split by first path segment
+  staticKeys: {                   // injected into every locale file
+    MAX_COUNT: 'Max Count',
+    ALLOWED: 'Allowed',
+  },
+});
+const uniqueTexts = deduplicateTexts(scanResult.detectedTexts);
+const { localeFiles, keyCount, namespaces } = extractor.extract(uniqueTexts);
+
+// Write
+const writer = new LocaleWriter({
+  localesDir: './locales',
+  merge: true,                    // preserve existing translations
+  localeStructure: 'nested',      // or 'flat'
+});
+const { written, created, merged } = writer.write(localeFiles);
+```
+
+## Locale layouts
+
+### `nested` (default)
+
+```
+locales/
+  en/
+    translation.json   ← default namespace
+    dashboard.json
+  fr/
+    translation.json   ← seeded with English values for translators
+    dashboard.json
+```
+
+### `flat`
+
+```
+locales/
+  en.json    ← all namespaces merged
+  fr.json
+```
+
+## Static keys
+
+Inject constant strings into every locale file using `staticKeys`. These are identical across all languages and are **not** flagged as untranslated by the validator:
+
+```ts
+const extractor = new LocaleExtractor({
+  staticKeys: {
+    MAX_COUNT:  'Max Count',
+    ALLOWED:    'Allowed',
+    DISABLED:   'Disabled',
+    UNLIMITED:  'Unlimited',
+  },
+});
+```
+
+## Merge behaviour
+
+When `merge: true` (default), existing translations are preserved. Only **new** keys (or keys with empty values) are updated. This prevents overwriting human-provided translations on re-extraction.
+
+---
+
+## 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,10 +1,22 @@
 {
   "name": "ai-localize-locale-engine",
-  "version": "2.0.5",
+  "version": "2.0.7",
   "description": "Locale file generation, merging, deduplication and synchronization",
+  "author": "ai-localize-core contributors",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ai-localize/ai-localize-core.git",
+    "directory": "packages/locale-engine"
+  },
+  "homepage": "https://github.com/ai-localize/ai-localize-core/tree/main/packages/locale-engine#readme",
+  "bugs": {
+    "url": "https://github.com/ai-localize/ai-localize-core/issues"
+  },
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
+  "sideEffects": false,
   "files": [
     "dist",
     "README.md",
@@ -33,14 +45,13 @@
     "node": ">=18.0.0"
   },
   "dependencies": {
-    "ai-localize-shared": "2.0.5"
+    "ai-localize-shared": "2.0.7"
   },
   "devDependencies": {
     "tsup": "^8.0.1",
     "typescript": "^5.3.3",
     "vitest": "^1.2.1"
   },
-  "license": "MIT",
   "publishConfig": {
     "access": "public"
   },