@i18n-micro/cli 0.0.0-stage → 2.0.0

package/dist/src/spec.d.ts

@@ -0,0 +1,57 @@
+/**
+ * The command table: one source of truth for parsing, `--help` and the generated
+ * [command reference](https://s00d.github.io/nuxt-i18n-micro/api/cli).
+ *
+ * This file imports nothing, and handlers load on demand, so `--help` stays instant and the
+ * docs generator can read the table without pulling in parsers or vendor drivers.
+ */
+export interface ArgSpec {
+    type: 'string' | 'boolean' | 'positional';
+    description: string;
+    default?: string | boolean;
+    required?: boolean;
+    alias?: string;
+    /** Accepted values: anything else is a usage error. */
+    values?: readonly string[];
+    /** Parsed to a number and checked to be positive. */
+    numeric?: 'int' | 'number';
+    /** Shown in the docs where a computed default has no literal value. */
+    defaultHint?: string;
+}
+export type CommandHandler = (args: never) => Promise<void>;
+export interface CommandSpec {
+    description: string;
+    group: CommandGroup;
+    args: Record<string, ArgSpec>;
+    examples?: string[];
+    load: () => Promise<{
+        default: CommandHandler;
+    }>;
+}
+export declare const COMMAND_GROUPS: readonly ["Inspect", "Translation workflow", "Refactoring", "Exchange"];
+export type CommandGroup = (typeof COMMAND_GROUPS)[number];
+/** Translation services of `translate`. A test keeps this equal to the drivers. */
+export declare const SERVICES: readonly ["ai", "azure", "deepl", "google", "libretranslate", "yandexcloud"];
+/** What `check` looks for. `duplicates` is off by default: the same word under two keys is often fine. */
+export declare const CHECK_TYPES: readonly ["missing", "empty", "extra", "placeholders", "undefined", "unused", "duplicates"];
+export type CheckType = (typeof CHECK_TYPES)[number];
+export declare const LINT_RULES: readonly [{
+    readonly name: "no-trailing-spaces";
+    readonly description: "Spaces at the end of a value or a line";
+    readonly fixable: true;
+}, {
+    readonly name: "no-multiple-spaces";
+    readonly description: "Two or more spaces in a row";
+    readonly fixable: true;
+}, {
+    readonly name: "no-empty-translation";
+    readonly description: "An empty or blank value";
+    readonly fixable: false;
+}];
+export type LintRuleName = (typeof LINT_RULES)[number]['name'];
+export declare const EXIT_CODES: ReadonlyArray<readonly [code: number, meaning: string]>;
+export declare const CONFIG_FILES: ReadonlyArray<readonly [file: string, purpose: string]>;
+export declare const ENVIRONMENT: ReadonlyArray<readonly [name: string, purpose: string]>;
+/** Commands that went away, and what to run instead. */
+export declare const REMOVED_COMMANDS: Record<string, string>;
+export declare const commands: Record<string, CommandSpec>;

package/dist/src/text-to-i18n.d.ts

@@ -0,0 +1,46 @@
+import { JsonObject } from './json.js';
+export declare function toSlug(text: string): string;
+export interface NewTranslation {
+    key: string;
+    value: string;
+    file: string;
+    line: number;
+}
+export interface Hardcoded {
+    file: string;
+    line: number;
+    text: string;
+}
+export interface ConvertOptions {
+    context?: string;
+    keyOverrides?: Record<string, string>;
+    skippedKeys?: string[];
+}
+/** Shared across files: known text reuses its key, generated keys stay unique. */
+export declare class KeyRegistry {
+    private readonly options;
+    readonly created: Map<string, NewTranslation>;
+    /** Text left alone because its key would overwrite a value of the translation file. */
+    readonly blocked: Hardcoded[];
+    private readonly byText;
+    private readonly used;
+    /** The file with this run's keys in it: `pages.user` and `pages.user.save` cannot both be text. */
+    private readonly planned;
+    constructor(existing: Record<string, string>, tree?: JsonObject, options?: ConvertOptions);
+    private generate;
+    private block;
+    /** Key for `text`, or `null` when it stays as it is. */
+    keyFor(text: string, file: string, line: number): string | null;
+    /** Take back keys of a conversion that was thrown away. */
+    forget(keep: ReadonlySet<string>): void;
+}
+export interface Conversion {
+    /** The new file content. */
+    content: string;
+    /** Text that is half a sentence: a key per fragment cannot be translated. */
+    mixed: Hardcoded[];
+    /** Text in code. `$t` is not in scope everywhere, so it is reported and never rewritten. */
+    code: Hardcoded[];
+}
+/** One source file: `.vue` templates are rewritten, anything else is only read. */
+export declare function convertSource(content: string, file: string, keys: KeyRegistry): Conversion;

package/dist/src/translate/ai.d.ts

@@ -0,0 +1,2 @@
+import { Driver } from './drivers.js';
+export declare const aiDriver: Driver;

package/dist/src/translate/drivers.d.ts

@@ -0,0 +1,26 @@
+import { RequestOptions } from '../http.js';
+export type DriverOptions = Record<string, string>;
+export interface BatchRequest {
+    texts: string[];
+    from: string;
+    to: string;
+    token: string;
+    options: DriverOptions;
+    http: Pick<RequestOptions, 'retries' | 'retryDelayMs' | 'timeoutMs'>;
+}
+export interface Driver {
+    label: string;
+    /** Most strings one request may carry. */
+    maxBatch: number;
+    /** Most characters one request may carry. */
+    maxChars?: number;
+    /** Works without a key (free tier or a self-hosted server). */
+    keyOptional?: boolean;
+    /** Language codes as the service spells them. */
+    sourceLang?: (code: string) => string;
+    targetLang?: (code: string) => string;
+    translate(request: BatchRequest): Promise<string[]>;
+}
+export declare const drivers: Record<string, Driver>;
+/** Services the old `nuxt-i18n-micro-cli` had: each name fails with the reason it is gone. */
+export declare const removedServices: Record<string, string>;

package/dist/src/translate/engine.d.ts

@@ -0,0 +1,33 @@
+import { Driver, DriverOptions } from './drivers.js';
+export interface TranslateItem {
+    key: string;
+    text: string;
+}
+export interface TranslationResult {
+    key: string;
+    value: string;
+}
+export interface EngineOptions {
+    service: string;
+    token: string;
+    options: DriverOptions;
+    chunkSize?: number;
+    pluralSeparator: string;
+}
+export declare function resolveDriver(service: string): Driver;
+/** Parses `key:value,key:value`. Only the first colon splits: values are often URLs. */
+export declare function parseOptions(text: string | undefined): DriverOptions;
+/** Batches within what the service accepts, by count and by characters. */
+export declare function buildBatches<T>(items: T[], size: (item: T) => number, maxCount: number, maxChars?: number): T[][];
+export interface EngineResult {
+    translated: TranslationResult[];
+    /** Keys with no usable answer, a placeholder lost or no text: left untranslated rather than broken. */
+    rejected: string[];
+}
+/**
+ * Translate one list of messages, plural forms and placeholders handled, into `to`.
+ *
+ * `onBatch` hears about every item as soon as its last form is back, so what was paid for can
+ * be saved before the next request. A failed request throws, and costs only what it carried.
+ */
+export declare function translateItems(items: TranslateItem[], from: string, to: string, config: EngineOptions, extra?: DriverOptions, onBatch?: (result: EngineResult) => void): Promise<EngineResult>;

package/dist/src/translate/protect.d.ts

@@ -0,0 +1,11 @@
+export interface Protected {
+    masked: string;
+    tokens: string[];
+}
+/** Replaces placeholders with XML tags, the one thing every service with markup support leaves alone. */
+export declare function protect(text: string): Protected;
+export declare function restore(masked: string, tokens: string[]): string;
+/** A placeholder lost, repeated, added or still masked after translation: such a value must not reach a locale file. */
+export declare const isIntact: (translated: string, tokens: string[]) => boolean;
+/** Services in HTML mode return `'` for an apostrophe. */
+export declare const decodeEntities: (text: string) => string;

package/package.json

@@ -1,6 +1,74 @@
 {
   "name": "@i18n-micro/cli",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "2.0.0",
+  "description": "Command-line tools for nuxt-i18n-micro: extract, sync, translate, lint and audit locale files.",
+  "keywords": [
+    "cli",
+    "i18n",
+    "localization",
+    "nuxt",
+    "translation"
+  ],
+  "homepage": "https://github.com/s00d/nuxt-i18n-micro/tree/main/packages/cli#readme",
+  "bugs": {
+    "url": "https://github.com/s00d/nuxt-i18n-micro/issues"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "s00d",
+    "email": "Virus191288@gmail.com",
+    "url": "https://s00d.github.io/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/s00d/nuxt-i18n-micro.git",
+    "directory": "packages/cli"
+  },
+  "bin": {
+    "i18n-micro": "./bin/i18n-micro.mjs",
+    "i18n-micro-cli": "./bin/i18n-micro.mjs"
+  },
+  "files": [
+    "bin",
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "types": "./dist/src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "default": "./dist/index.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@vue/compiler-sfc": "^3.5.44",
+    "citty": "^0.2.2",
+    "@i18n-micro/utils": "^2.0.0"
+  },
+  "devDependencies": {
+    "@nuxt/kit": "^3.18.0 || ^4.0.0",
+    "@types/node": "^22.19.0",
+    "nuxt": "^4.6.4",
+    "publint": "^0.3.25",
+    "typescript": "6.0.3",
+    "vite": "^8.3.5",
+    "vite-plugin-dts": "^5.1.2",
+    "vitest": "^5.1.0"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "build": "vite build",
+    "check:package": "publint",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit"
+  }
 }