ai-localize-validators 2.0.1 → 2.0.4

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # ai-localize-validators
 
+## 2.0.3
+
+### Patch Changes
+
+- Updated dependencies
+  - ai-localize-shared@2.0.3
+  - ai-localize-config@2.0.3
+
+## 2.0.2
+
+### Patch Changes
+
+- Updated dependencies
+  - ai-localize-shared@2.0.2
+
 ## 2.0.1
 
 ### Patch Changes

package/package.json

@@ -1,10 +1,15 @@
 {
   "name": "ai-localize-validators",
-  "version": "2.0.1",
-  "description": "Locale file validation engine",
+  "version": "2.0.4",
+  "description": "Locale file validation engine — missing, duplicate, placeholder and unused key validators",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "CHANGELOG.md"
+  ],
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -12,8 +17,23 @@
       "require": "./dist/index.js"
     }
   },
+  "keywords": [
+    "i18n",
+    "localization",
+    "l10n",
+    "internationalization",
+    "ai-localize",
+    "validation",
+    "locale",
+    "missing-keys",
+    "duplicate-keys",
+    "translation"
+  ],
+  "engines": {
+    "node": ">=18.0.0"
+  },
   "dependencies": {
-    "ai-localize-shared": "2.0.1"
+    "ai-localize-shared": "2.0.4"
   },
   "devDependencies": {
     "tsup": "^8.0.1",

package/src/__tests__/missing-key-validator.test.ts

@@ -1,45 +0,0 @@
-import { describe, it, expect, beforeAll, afterAll } from 'vitest';
-import * as fs from 'fs';
-import * as path from 'path';
-import * as os from 'os';
-import { MissingKeyValidator } from '../missing-key-validator.js';
-
-let tmpDir: string;
-
-beforeAll(() => {
-  tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'ai-localize-test-'));
-  fs.mkdirSync(path.join(tmpDir, 'en'), { recursive: true });
-  fs.mkdirSync(path.join(tmpDir, 'fr'), { recursive: true });
-  fs.writeFileSync(
-    path.join(tmpDir, 'en', 'translation.json'),
-    JSON.stringify({ greeting: 'Hello', farewell: 'Goodbye' })
-  );
-  fs.writeFileSync(
-    path.join(tmpDir, 'fr', 'translation.json'),
-    JSON.stringify({ greeting: 'Bonjour' })
-  );
-});
-
-afterAll(() => {
-  fs.rmSync(tmpDir, { recursive: true, force: true });
-});
-
-describe('MissingKeyValidator', () => {
-  it('detects missing keys in target language', () => {
-    const validator = new MissingKeyValidator(tmpDir, 'en', ['fr']);
-    const { errors } = validator.validate();
-    expect(errors.length).toBeGreaterThan(0);
-    const missingFarewellInFr = errors.find((e) => e.key.includes('farewell') && e.language === 'fr');
-    expect(missingFarewellInFr).toBeDefined();
-  });
-
-  it('returns no errors when all keys present', () => {
-    fs.writeFileSync(
-      path.join(tmpDir, 'fr', 'translation.json'),
-      JSON.stringify({ greeting: 'Bonjour', farewell: 'Au revoir' })
-  );
-    const validator = new MissingKeyValidator(tmpDir, 'en', ['fr']);
-    const { errors } = validator.validate();
-    expect(errors.length).toBe(0);
-  });
-});

package/src/duplicate-key-validator.ts

@@ -1,37 +0,0 @@
-import * as fs from "fs";
-import * as path from "path";
-import type { ValidationError } from "ai-localize-shared";
-import { readJsonSafe } from "ai-localize-shared";
-
-export class DuplicateKeyValidator {
-  constructor(private localesDir: string, private defaultLanguage = "en") {}
-
-  validate(): { errors: ValidationError[]; duplicates: string[] } {
-    const errors: ValidationError[] = [];
-    const duplicates: string[] = [];
-    const defaultDir = path.join(this.localesDir, this.defaultLanguage);
-    if (!fs.existsSync(defaultDir)) return { errors, duplicates };
-
-    const nsFiles = fs.readdirSync(defaultDir).filter((f) => f.endsWith(".json"));
-    for (const nsFile of nsFiles) {
-      const entries = readJsonSafe<Record<string, string>>(path.join(defaultDir, nsFile));
-      if (!entries) continue;
-      const namespace = nsFile.replace(".json", "");
-  const valueMap = new Map<string, string[]>();
-      for (const [key, value] of Object.entries(entries)) {
-        if (!value) continue;
-        const existing = valueMap.get(value) || [];
-        existing.push(key);
-        valueMap.set(value, existing);
-      }
-      for (const [value, keys] of valueMap) {
-        if (keys.length > 1) {
-          const fullKeys = keys.map((k) => `${namespace}.${k}`);
-        duplicates.push(...fullKeys);
-          errors.push({ type: "duplicate-key", key: fullKeys.join(", "), message: `Duplicate value "${value}" for: ${fullKeys.join(", ")}` });
-        }
-  }
-    }
-    return { errors, duplicates };
-  }
-}

package/src/index.ts

@@ -1,5 +0,0 @@
-export * from "./missing-key-validator.js";
-export * from "./duplicate-key-validator.js";
-export * from "./placeholder-validator.js";
-export * from "./unused-key-validator.js";
-export * from "./locale-validator.js";

package/src/locale-validator.ts

@@ -1,44 +0,0 @@
-import type { ValidationResult } from "ai-localize-shared";
-import { MissingKeyValidator } from "./missing-key-validator.js";
-import { DuplicateKeyValidator } from "./duplicate-key-validator.js";
-import { PlaceholderValidator } from "./placeholder-validator.js";
-import { UnusedKeyValidator } from "./unused-key-validator.js";
-
-export interface ValidatorOptions {
-  localesDir: string;
-  sourceDir: string;
-  defaultLanguage?: string;
-  targetLanguages?: string[];
-  checkUnused?: boolean;
-  checkDuplicates?: boolean;
-  checkPlaceholders?: boolean;
-}
-
-export class LocaleValidator {
-  constructor(private options: ValidatorOptions) {}
-
-  validate(): ValidationResult {
-    const errors: ValidationResult["errors"] = [];
-    const warnings: ValidationResult["warnings"] = [];
-    const lang = this.options.defaultLanguage || "en";
-
-    const { errors: missingErrors } = new MissingKeyValidator(this.options.localesDir, lang, this.options.targetLanguages || []).validate();
-    errors.push(...missingErrors);
-
-    if (this.options.checkDuplicates !== false) {
-      const { errors: dupErrors } = new DuplicateKeyValidator(this.options.localesDir, lang).validate();
-      errors.push(...dupErrors);
-    }
-
-    if (this.options.checkPlaceholders !== false) {
-      errors.push(...new PlaceholderValidator(this.options.localesDir, lang).validate());
-    }
-
-    if (this.options.checkUnused !== false) {
-      const { warnings: unusedWarnings } = new UnusedKeyValidator(this.options.localesDir, this.options.sourceDir, lang).validate();
-      warnings.push(...unusedWarnings);
-    }
-
-    return { valid: errors.length === 0, errors, warnings };
-  }
-}

package/src/missing-key-validator.ts

@@ -1,46 +0,0 @@
-import * as fs from "fs";
-import * as path from "path";
-import type { ValidationError } from "ai-localize-shared";
-import { readJsonSafe } from "ai-localize-shared";
-
-export class MissingKeyValidator {
-  constructor(
-    private localesDir: string,
-    private defaultLanguage = "en",
-    private targetLanguages: string[] = []
-  ) {}
-
-  validate(): { errors: ValidationError[]; missingByLanguage: Record<string, string[]> } {
-    const errors: ValidationError[] = [];
-    const missingByLanguage: Record<string, string[]> = {};
-
-    const defaultDir = path.join(this.localesDir, this.defaultLanguage);
-    if (!fs.existsSync(defaultDir)) return { errors, missingByLanguage };
-
-    const nsFiles = fs.readdirSync(defaultDir).filter((f) => f.endsWith(".json"));
-    const langs = this.targetLanguages.length > 0
-      ? this.targetLanguages
-    : fs.readdirSync(this.localesDir, { withFileTypes: true })
-          .filter((e) => e.isDirectory() && e.name !== this.defaultLanguage)
-          .map((e) => e.name);
-
-    for (const nsFile of nsFiles) {
-  const defaultEntries = readJsonSafe<Record<string, string>>(path.join(defaultDir, nsFile));
-      if (!defaultEntries) continue;
-      const namespace = nsFile.replace(".json", "");
-      for (const lang of langs) {
-        const targetPath = path.join(this.localesDir, lang, nsFile);
-    const targetEntries = readJsonSafe<Record<string, string>>(targetPath) || {};
-        for (const key of Object.keys(defaultEntries)) {
-    if (!(key in targetEntries) || targetEntries[key] === "") {
-   const fullKey = `${namespace}.${key}`;
- errors.push({ type: "missing-key", key: fullKey, language: lang, message: `Missing key "${fullKey}" in "${lang}"`, filePath: targetPath });
-      if (!missingByLanguage[lang]) missingByLanguage[lang] = [];
-            missingByLanguage[lang].push(fullKey);
-    }
-        }
-      }
-    }
-    return { errors, missingByLanguage };
-  }
-}

package/src/placeholder-validator.ts

@@ -1,48 +0,0 @@
-import * as fs from "fs";
-import * as path from "path";
-import type { ValidationError } from "ai-localize-shared";
-import { readJsonSafe } from "ai-localize-shared";
-
-const PATTERNS = [/\{\{([^}]+)\}\}/g, /\{([^}]+)\}/g, /%\(([^)]+)\)s/g, /%(\w+)/g];
-
-export class PlaceholderValidator {
-  constructor(private localesDir: string, private defaultLanguage = "en") {}
-
-  validate(): ValidationError[] {
-    const errors: ValidationError[] = [];
-    const defaultDir = path.join(this.localesDir, this.defaultLanguage);
-    if (!fs.existsSync(defaultDir)) return errors;
-
-    const nsFiles = fs.readdirSync(defaultDir).filter((f) => f.endsWith(".json"));
-    const langs = fs.readdirSync(this.localesDir, { withFileTypes: true })
-      .filter((e) => e.isDirectory() && e.name !== this.defaultLanguage)
-      .map((e) => e.name);
-
-    for (const nsFile of nsFiles) {
-      const defaultEntries = readJsonSafe<Record<string, string>>(path.join(defaultDir, nsFile));
-      if (!defaultEntries) continue;
-      const namespace = nsFile.replace(".json", "");
-      for (const lang of langs) {
-   const targetEntries = readJsonSafe<Record<string, string>>(path.join(this.localesDir, lang, nsFile)) || {};
-        for (const [key, defaultVal] of Object.entries(defaultEntries)) {
-      const targetVal = targetEntries[key];
-        if (!targetVal) continue;
-    const defPh = this.extract(defaultVal);
-        const tgtPh = this.extract(targetVal);
-     const missing = defPh.filter((p) => !tgtPh.includes(p));
-   const extra = tgtPh.filter((p) => !defPh.includes(p));
-    if (missing.length > 0 || extra.length > 0) {
-            errors.push({ type: "placeholder-mismatch", key: `${namespace}.${key}`, language: lang, message: `Placeholder mismatch in "${lang}": missing [${missing.join(", ")}], extra [${extra.join(", ")}]` });
-  }
-      }
-  }
-    }
-    return errors;
-  }
-
-  private extract(value: string): string[] {
-    const result: string[] = [];
-    for (const p of PATTERNS) { p.lastIndex = 0; let m; while ((m = p.exec(value)) !== null) result.push(m[0]); }
-    return [...new Set(result)];
-  }
-}

package/src/unused-key-validator.ts

@@ -1,50 +0,0 @@
-import * as fs from "fs";
-import * as path from "path";
-import type { ValidationWarning } from "ai-localize-shared";
-import { readJsonSafe, collectFiles } from "ai-localize-shared";
-
-export class UnusedKeyValidator {
-  constructor(
-    private localesDir: string,
-    private sourceDir: string,
-    private defaultLanguage = "en"
-  ) {}
-
-  validate(): { warnings: ValidationWarning[]; unusedKeys: string[] } {
-    const warnings: ValidationWarning[] = [];
-    const unusedKeys: string[] = [];
-    const allKeys = this.collectLocaleKeys();
- const sourceContent = this.collectSourceContent();
-
-    for (const key of allKeys) {
-      const shortKey = key.includes(".") ? key.split(".").slice(1).join(".") : key;
-      const referenced =
-      sourceContent.includes(`'${key}'`) || sourceContent.includes(`"${key}"`) ||
-   sourceContent.includes(`'${shortKey}'`) || sourceContent.includes(`"${shortKey}"`);
-  if (!referenced) {
-  unusedKeys.push(key);
- warnings.push({ type: "unused-key", key, message: `Key "${key}" not referenced in source` });
- }
-    }
-    return { warnings, unusedKeys };
-  }
-
-  private collectLocaleKeys(): string[] {
-    const keys: string[] = [];
-    const defaultDir = path.join(this.localesDir, this.defaultLanguage);
-    if (!fs.existsSync(defaultDir)) return keys;
-    for (const file of fs.readdirSync(defaultDir).filter((f) => f.endsWith(".json"))) {
-      const ns = file.replace(".json", "");
-      const entries = readJsonSafe<Record<string, string>>(path.join(defaultDir, file)) || {};
-      for (const key of Object.keys(entries)) keys.push(`${ns}.${key}`);
-    }
-    return keys;
-  }
-
-  private collectSourceContent(): string {
-const files = collectFiles(this.sourceDir, ["ts", "tsx", "js", "jsx", "vue", "html"], ["node_modules", "dist"]);
-    let content = "";
-    for (const f of files) { try { content += fs.readFileSync(f, 'utf-8') + '\n'; } catch { /**/ } }
-    return content;
-  }
-}

package/tsconfig.json

@@ -1,6 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "compilerOptions": { "outDir": "./dist", "rootDir": "./src" },
-  "include": ["src/**/*"],
-  "exclude": ["node_modules", "dist"]
-}