ai-localize-config 2.0.3 → 2.0.4

package/package.json

@@ -1,10 +1,15 @@
 {
   "name": "ai-localize-config",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "description": "Configuration loader and schema validator for ai-localize-core",
   "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,11 +17,25 @@
       "require": "./dist/index.js"
     }
   },
+  "keywords": [
+    "i18n",
+    "localization",
+    "l10n",
+    "internationalization",
+    "ai-localize",
+    "config",
+    "configuration",
+    "zod",
+    "cosmiconfig"
+  ],
+  "engines": {
+    "node": ">=18.0.0"
+  },
   "dependencies": {
     "zod": "^3.22.4",
     "cosmiconfig": "^9.0.0",
     "dotenv": "^16.4.1",
-    "ai-localize-shared": "2.0.3"
+    "ai-localize-shared": "2.0.4"
   },
   "devDependencies": {
     "tsup": "^8.0.1",

package/src/index.ts

@@ -1,2 +0,0 @@
-export * from './schema.js';
-export * from './loader.js';

package/src/loader.ts

@@ -1,256 +0,0 @@
-import * as fs from 'fs';
-import * as path from 'path';
-import { cosmiconfig } from 'cosmiconfig';
-import * as dotenv from 'dotenv';
-
-import type { LocalizationConfig } from 'ai-localize-shared';
-import { CONFIG_FILE_NAME } from 'ai-localize-shared';
-import { LocalizationConfigSchema } from './schema.js';
-
-export interface ConfigLoadResult {
-  config: LocalizationConfig;
-  filePath: string | null;
-}
-
-/**
- * Loads and validates the ai-localize configuration.
- * Searches for config in standard locations using cosmiconfig.
- */
-export async function loadConfig(
-  cwd = process.cwd(),
-  overrides: Partial<LocalizationConfig> = {}
-): Promise<ConfigLoadResult> {
-  // Load .env files for AWS credentials etc.
-  dotenv.config({ path: path.join(cwd, '.env') });
-  dotenv.config({ path: path.join(cwd, '.env.local') });
-
-  const explorer = cosmiconfig('ai-localize', {
-    searchPlaces: [
-      CONFIG_FILE_NAME,
-      'ai-localize.config.js',
-      'ai-localize.config.ts',
-'.ai-localizerc',
-      '.ai-localizerc.json',
-      '.ai-localizerc.js',
-      'package.json',
-    ],
-    packageProp: 'aiLocalize',
-  });
-
-  let rawConfig: Record<string, unknown> = {};
-  let filePath: string | null = null;
-
-  try {
-    const result = await explorer.search(cwd);
-    if (result) {
-      rawConfig = result.config as Record<string, unknown>;
-      filePath = result.filepath;
-    }
-  } catch (err) {
-    // Config not found — use defaults
-  }
-
-  // Merge env vars for AWS
-  const awsFromEnv = extractAwsFromEnv();
-  if (awsFromEnv && !rawConfig.aws) {
-    rawConfig.aws = awsFromEnv;
-  }
-
-  const merged = { ...rawConfig, ...overrides };
-  const validated = LocalizationConfigSchema.parse(merged);
-
-  return {
-    config: validated as LocalizationConfig,
-    filePath,
-  };
-}
-
-/** Extract AWS configuration from environment variables */
-function extractAwsFromEnv(): Record<string, string> | null {
-  const bucket = process.env.AI_LOCALIZE_S3_BUCKET || process.env.AWS_S3_BUCKET;
-  const distributionId =
-    process.env.AI_LOCALIZE_CF_DISTRIBUTION_ID || process.env.AWS_CF_DISTRIBUTION_ID;
-
-  if (!bucket || !distributionId) return null;
-
-  return {
-    bucket,
-    distributionId,
-    region: process.env.AWS_REGION || process.env.AI_LOCALIZE_AWS_REGION || 'us-east-1',
- cdnBaseUrl: process.env.AI_LOCALIZE_CDN_BASE_URL || '',
-    legacyCdnPattern: process.env.AI_LOCALIZE_LEGACY_CDN_PATTERN || '',
-    profile: process.env.AWS_PROFILE || '',
-  };
-}
-
-/**
- * Writes a fully-populated default config file to the project root.
- *
- * Every supported configuration field is included so users can see all
- * available options and edit them directly.  Fields that are optional/unused
- * are set to their default values or left as empty strings / empty arrays.
- */
-export function writeDefaultConfig(cwd = process.cwd(), framework = 'unknown'): string {
-  const configPath = path.join(cwd, CONFIG_FILE_NAME);
-
-  const defaultConfig = {
-    // ── Framework ────────────────────────────────────────────────────────────
-    // Detected automatically by ai-localize init.
-    // Values: "react" | "react-cra" | "react-vite" | "react-nextjs"
-    //   | "angular" | "angular-ngx" | "angular-i18n"
-    //       | "vue" | "vue-i18n" | "jquery" | "vanilla-js" | "jsp" | "unknown"
-    framework,
-
- // ── Languages ────────────────────────────────────────────────────────────
-    // Source language — used as reference for missing-translation detection.
-    defaultLanguage: 'en',
-
-  // Additional languages to generate locale files for.
-    // All target files are seeded with the source value (no blank entries).
-    targetLanguages: ['fr', 'de'],
-
-    // ── Directories ──────────────────────────────────────────────────────────
-    // Root of your source code — scanning starts here.
-    // Keys are generated relative to this directory.
-    sourceDir: 'src',
-
-    // Where locale JSON files are written.
-    localesDir: 'locales',
-
-    // ── Locale file layout ───────────────────────────────────────────────────
-    // "nested" (default): one file per language + namespace
-    //   locales/en/common.json, locales/en/dashboard.json
-    // "flat": one file per language, all keys merged
-    //   locales/en.json  (non-default namespace keys are prefixed: "dashboard.header.title")
-    localeStructure: 'nested',
-
-    // ── Key style ────────────────────────────────────────────────────────────
-    // Controls the format of locale keys generated for scanned hardcoded text.
-    //
-    // "path" (default) — hierarchical dot-notation derived from file path + text:
-    //   src/pages/settings/SettingsPage.tsx + "Save Changes"
-    //   → "settings.settings_page.save_changes"
-    //
-    // "screaming_snake" — UPPER_SNAKE_CASE derived solely from the text value.
-    //   The key equals the value converted to UPPER_SNAKE_CASE:
-    //   "Save Changes" → key: "SAVE_CHANGES",  value: "Save Changes"
-    //   "Max Count"    → key: "MAX_COUNT",    value: "Max Count"
-    //   This mirrors the staticKeys pattern and is ideal for projects that
-    //   prefer constant-style i18n keys.
-    keyStyle: 'path',
-
-    // ── Scan filtering ───────────────────────────────────────────────────────
-    // Directories/patterns to skip during scanning.
-    ignorePatterns: ['node_modules', 'dist', '.git', 'coverage'],
-
-    // Optional: only scan files matching these glob patterns.
-    // If empty/omitted, all files under sourceDir are scanned.
-    // Example: ["src/components/**/*.tsx", "src/pages/**/*.tsx"]
-    includePatterns: [],
-
-    // ── Key generation ───────────────────────────────────────────────────────
-    // Optional prefix prepended to every generated key.
-    // Example: "myapp" → "myapp.components.button.save"
-    keyPrefix: '',
-
-    // Optional explicit list of namespace names.
-    // If omitted, namespace is derived from the first path segment after sourceDir.
-    namespaces: [],
-
-    // ── Static keys ──────────────────────────────────────────────────────────
-    // Key/value pairs to inject into every generated locale file regardless of
-    // what the scanner finds.  Useful for enum labels, status codes, and other
-    // constant strings that are not hardcoded in source files.
-    //
-    // In nested mode these keys land in the default namespace file
-    // (translation.json).  In flat mode they are merged at the top level.
-    //
-// Example:
-    //   "staticKeys": {
-    //     "MAX_COUNT": "Max Count",
-    //     "ALLOWED":   "Allowed",
-    //     "DISABLED":  "Disabled",
-    //     "UNLIMITED": "Unlimited"
-    //   }
-    staticKeys: {},
-
-    // ── Incremental scanning ─────────────────────────────────────────────────
-    // Cache file hashes between runs — only re-scan changed files.
-    incrementalCache: true,
-    cacheDir: '.ai-localize-cache',
-
-    // ── Codemod behaviour ────────────────────────────────────────────────────
-    // Controls what the codemod injects when wrapping hardcoded strings.
-    //
- // importPackage: npm package name OR project-relative path to the hook file.
-    //   npm package:      "react-i18next"
-    //   local hook path:  "src/hooks/useTranslation"   (path relative to project root)
-    //   The codemod computes the correct relative import path per file automatically.
-    //
-    // hookName: the hook function to import and call.
- //   Default: "useTranslation"
-    //
-  // translationFunction: the accessor destructured from the hook.
-    //   Default: "t"
-    //
-  // namespace: passed as argument to the hook, e.g. useTranslation("common").
-    //   Leave empty to omit the argument.
-    //
-    // accessorStyle:
-    //   "function" (default) → t('key')
-    //   "bracket"            → t['key']
-    codemods: {
-      importPackage: 'react-i18next',
-      hookName: 'useTranslation',
-      translationFunction: 't',
-    namespace: '',
-      accessorStyle: 'function',
-    },
-
-    // ── AWS / CloudFront (optional) ──────────────────────────────────────────
-    // Required only for CDN migration commands (migrate-cdn, upload-assets, replace-cdn).
-    // Leave all fields empty if not using CDN migration.
-    // Credentials can also be supplied via environment variables (see docs).
-    aws: {
-  region: 'us-east-1',
-bucket: '',
-      distributionId: '',
-      cdnBaseUrl: '',
-      legacyCdnPattern: '',
-      assetsPrefix: 'assets',
-   profile: '',
-    },
-
-    // ── Plugins ──────────────────────────────────────────────────────────────
-    // Paths to custom plugin modules. See docs/PLUGIN_SYSTEM.md for details.
-    plugins: [],
-  };
-
-  fs.writeFileSync(configPath, JSON.stringify(defaultConfig, null, 2) + '\n', 'utf-8');
-  return configPath;
-}
-
-/** Validate an existing config file */
-export function validateConfig(configPath: string): {
-  valid: boolean;
-  errors: string[];
-} {
-  try {
-    const raw = fs.readFileSync(configPath, 'utf-8');
- const parsed = JSON.parse(raw);
-  LocalizationConfigSchema.parse(parsed);
-    return { valid: true, errors: [] };
-  } catch (err: unknown) {
-    if (err && typeof err === 'object' && 'errors' in err) {
-    const zodError = err as { errors: Array<{ path: unknown[]; message: string }> };
-      return {
-        valid: false,
-        errors: zodError.errors.map((e) => `${e.path.join('.')}: ${e.message}`),
-      };
-    }
-    return {
-  valid: false,
-      errors: [err instanceof Error ? err.message : String(err)],
-    };
-  }
-}

package/src/schema.ts

@@ -1,127 +0,0 @@
-import { z } from 'zod';
-
-const AwsConfigSchema = z.object({
-  region: z.string().default('us-east-1'),
-  bucket: z.string().min(1, 'S3 bucket name is required'),
-  distributionId: z.string().min(1, 'CloudFront distribution ID is required'),
-  cdnBaseUrl: z.string().url().optional(),
-  legacyCdnPattern: z.string().optional(),
-  assetsPrefix: z.string().default('assets'),
-  profile: z.string().optional(),
-});
-
-const FrameworkSchema = z.enum([
-  'react',
-  'react-cra',
-  'react-vite',
-  'react-nextjs',
-  'angular',
-  'angular-ngx',
-  'angular-i18n',
-  'vue',
-  'vue-i18n',
-  'jquery',
-  'vanilla-js',
-  'jsp',
-  'unknown',
-]);
-
-/**
- * Optional codemod behaviour overrides.
- * Controls which i18n library / hook / pipe the codemod injects.
- */
-const CodemodConfigSchema = z.object({
-  /**
-   * The npm package to import from.
-   * React default:   "react-i18next"
-   * Vue default:     "vue-i18n"
-   * Angular default: "@ngx-translate/core"
-   */
-  importPackage: z.string().optional(),
-  /**
-   * The hook / function name to import and call.
-   * React default:   "useTranslation"
-   * Vue default:     "useI18n"
-   */
-  hookName: z.string().optional(),
-  /**
-   * The translation function identifier returned by the hook (default: "t").
-   */
-  translationFunction: z.string().optional(),
-  /**
-   * Namespace to pass as the first argument to the hook call.
-   * When omitted no namespace argument is injected.
-   */
-  namespace: z.string().optional(),
-  /**
-* How the translation accessor is written in generated code.
-   *   "function" (default) — t('key')
-   *   "bracket"        — t['key']
-   */
-  accessorStyle: z.enum(['function', 'bracket']).optional(),
-});
-
-export const LocalizationConfigSchema = z.object({
-  framework: FrameworkSchema.default('unknown'),
-  defaultLanguage: z.string().default('en'),
-targetLanguages: z.array(z.string()).default([]),
-  sourceDir: z.string().default('src'),
-  localesDir: z.string().default('locales'),
-  keyPrefix: z.string().optional(),
-  namespaces: z.array(z.string()).optional(),
-  ignorePatterns: z
-    .array(z.string())
-    .default(['node_modules', 'dist', '.git', 'coverage']),
-  includePatterns: z.array(z.string()).optional(),
-  incrementalCache: z.boolean().default(true),
-  cacheDir: z.string().default('.ai-localize-cache'),
-  aws: AwsConfigSchema.optional().nullable(),
-  plugins: z.array(z.string()).default([]),
-  /** Codemod behaviour overrides — all fields are optional. */
-  codemods: CodemodConfigSchema.optional(),
-  /**
-   * Locale file layout.
-   *   "nested" (default) — one file per language + namespace:
-   *   locales/en/common.json, locales/fr/dashboard.json
-   *   "flat" — one file per language, all keys merged:
-   *    locales/en.json, locales/fr.json
-   */
-  localeStructure: z.enum(['nested', 'flat']).default('nested'),
-  /**
-   * Controls the format of generated locale keys for hardcoded text found
-   * during scanning.
-   *
-   *   "path" (default) — hierarchical dot-notation derived from file path + text:
-   *       src/pages/settings/SettingsPage.tsx + "Save Changes"
-   *       → "settings.settings_page.save_changes"
-   *
-   *   "screaming_snake" — UPPER_SNAKE_CASE derived solely from the text value.
-   *       The key equals the value converted to UPPER_SNAKE_CASE:
-   *       "Save Changes"  → key: "SAVE_CHANGES",  value: "Save Changes"
-   *     "Max Count"     → key: "MAX_COUNT", value: "Max Count"
-   *       This matches the pattern used by staticKeys and is ideal for
-   *       projects that use constant-style i18n keys.
-*/
-  keyStyle: z.enum(['path', 'screaming_snake']).default('path'),
-  /**
-   * Static locale keys to inject into every generated locale file.
-   * These key/value pairs are merged with scanned keys and written to all
-   * languages (defaultLanguage + targetLanguages).
-   *
-   * Example:
-   *   "staticKeys": {
-   *     "MAX_COUNT": "Max Count",
-   *   "ALLOWED": "Allowed",
-   *     "DISABLED": "Disabled",
-   *     "UNLIMITED": "Unlimited"
-   *   }
-   *
-   * In nested mode these keys are placed in the default namespace file
-   * (translation.json / common.json). In flat mode they are merged at the
-   * top level of the single per-language file.
-   */
-  staticKeys: z.record(z.string(), z.string()).optional(),
-});
-
-export type LocalizationConfigInput = z.input<typeof LocalizationConfigSchema>;
-export type LocalizationConfigOutput = z.output<typeof LocalizationConfigSchema>;

package/tsconfig.json

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