@inquirer/i18n 1.0.1 → 1.0.2

package/dist/create.d.ts

@@ -0,0 +1,32 @@
+import { checkbox as checkboxPrompt, confirm as confirmPrompt, editor as editorPrompt, expand as expandPrompt, input as inputPrompt, number as numberPrompt, password as passwordPrompt, rawlist as rawlistPrompt, search as searchPrompt, select as selectPrompt } from '@inquirer/prompts';
+import type { Locale } from './types.js';
+export type { Locale } from './types.js';
+type ConfirmConfig = Parameters<typeof confirmPrompt>[0];
+type SelectConfig<Value> = Parameters<typeof selectPrompt<Value>>[0];
+type CheckboxConfig<Value> = Parameters<typeof checkboxPrompt<Value>>[0];
+type SearchConfig<Value> = Parameters<typeof searchPrompt<Value>>[0];
+type ExpandConfig<Value> = Parameters<typeof expandPrompt<Value>>[0];
+type RawlistConfig<Value> = Parameters<typeof rawlistPrompt<Value>>[0];
+type EditorConfig = Parameters<typeof editorPrompt>[0];
+type InputConfig = Parameters<typeof inputPrompt>[0];
+type NumberConfig<Required extends boolean = boolean> = Parameters<typeof numberPrompt<Required>>[0];
+type PasswordConfig = Parameters<typeof passwordPrompt>[0];
+type Context = Parameters<typeof confirmPrompt>[1];
+/**
+ * Factory function that creates localized prompt wrappers for a given locale.
+ *
+ * @param locale - The locale object containing all localized strings
+ * @returns An object containing all prompt functions with localization applied
+ */
+export declare function createLocalizedPrompts(locale: Locale): {
+    confirm(this: void, config: ConfirmConfig, context?: Context): Promise<boolean>;
+    select<Value>(this: void, config: SelectConfig<Value>, context?: Context): Promise<Value>;
+    checkbox<Value>(this: void, config: CheckboxConfig<Value>, context?: Context): Promise<Value[]>;
+    search<Value>(this: void, config: SearchConfig<Value>, context?: Context): Promise<Value>;
+    expand<Value>(this: void, config: ExpandConfig<Value>, context?: Context): Promise<Value>;
+    rawlist<Value>(this: void, config: RawlistConfig<Value>, context?: Context): Promise<Value>;
+    editor(this: void, config: EditorConfig, context?: Context): Promise<string>;
+    input(this: void, config: InputConfig, context?: Context): Promise<string>;
+    number<Required extends boolean = boolean>(this: void, config: NumberConfig<Required>, context?: Context): Promise<Required extends true ? number : number | undefined>;
+    password(this: void, config: PasswordConfig, context?: Context): Promise<string>;
+};

package/dist/create.js

@@ -0,0 +1,123 @@
+import { checkbox as checkboxPrompt, confirm as confirmPrompt, editor as editorPrompt, expand as expandPrompt, input as inputPrompt, number as numberPrompt, password as passwordPrompt, rawlist as rawlistPrompt, search as searchPrompt, select as selectPrompt, } from '@inquirer/prompts';
+import { makeTheme } from '@inquirer/core';
+import { styleText } from 'node:util';
+/**
+ * Factory function that creates localized prompt wrappers for a given locale.
+ *
+ * @param locale - The locale object containing all localized strings
+ * @returns An object containing all prompt functions with localization applied
+ */
+export function createLocalizedPrompts(locale) {
+    return {
+        confirm(config, context) {
+            const theme = makeTheme(config.theme, {
+                style: {
+                    defaultAnswer: (text) => {
+                        if (text === 'Y/n')
+                            return styleText('dim', `(${locale.confirm.hintYes})`);
+                        if (text === 'y/N')
+                            return styleText('dim', `(${locale.confirm.hintNo})`);
+                        return styleText('dim', `(${text})`);
+                    },
+                },
+            });
+            return confirmPrompt({
+                ...config,
+                theme,
+                transformer: config.transformer ??
+                    ((answer) => answer ? locale.confirm.yesLabel : locale.confirm.noLabel),
+            }, context);
+        },
+        select(config, context) {
+            const theme = makeTheme(config.theme, {
+                style: {
+                    keysHelpTip: (keys) => {
+                        const localizedKeys = keys.map(([key, label]) => {
+                            if (label === 'navigate')
+                                return [key, locale.select.helpNavigate];
+                            if (label === 'select')
+                                return [key, locale.select.helpSelect];
+                            return [key, label];
+                        });
+                        return localizedKeys
+                            .map(([k, l]) => `${styleText('bold', k)} ${styleText('dim', l)}`)
+                            .join(styleText('dim', ' • '));
+                    },
+                },
+            });
+            return selectPrompt({ ...config, theme }, context);
+        },
+        checkbox(config, context) {
+            const theme = makeTheme(config.theme, {
+                style: {
+                    keysHelpTip: (keys) => {
+                        const localizedKeys = keys.map(([key, label]) => {
+                            if (label === 'navigate')
+                                return [key, locale.checkbox.helpNavigate];
+                            if (label === 'select')
+                                return [key, locale.checkbox.helpSelect];
+                            if (label === 'submit')
+                                return [key, locale.checkbox.helpSubmit];
+                            if (label === 'all')
+                                return [key, locale.checkbox.helpAll];
+                            if (label === 'invert')
+                                return [key, locale.checkbox.helpInvert];
+                            return [key, label];
+                        });
+                        return localizedKeys
+                            .map(([k, l]) => `${styleText('bold', k)} ${styleText('dim', l)}`)
+                            .join(styleText('dim', ' • '));
+                    },
+                },
+            });
+            return checkboxPrompt({ ...config, theme }, context);
+        },
+        search(config, context) {
+            const theme = makeTheme(config.theme, {
+                style: {
+                    keysHelpTip: (keys) => {
+                        const localizedKeys = keys.map(([key, label]) => {
+                            if (label === 'navigate')
+                                return [key, locale.search.helpNavigate];
+                            if (label === 'select')
+                                return [key, locale.search.helpSelect];
+                            return [key, label];
+                        });
+                        return localizedKeys
+                            .map(([k, l]) => `${styleText('bold', k)} ${styleText('dim', l)}`)
+                            .join(styleText('dim', ' • '));
+                    },
+                },
+            });
+            return searchPrompt({ ...config, theme }, context);
+        },
+        expand(config, context) {
+            return expandPrompt(config, context);
+        },
+        rawlist(config, context) {
+            return rawlistPrompt(config, context);
+        },
+        editor(config, context) {
+            const theme = makeTheme(config.theme, {
+                style: {
+                    waitingMessage: locale.editor.waitingMessage,
+                },
+            });
+            return editorPrompt({ ...config, theme }, context);
+        },
+        input(config, context) {
+            return inputPrompt(config, context);
+        },
+        number(config, context) {
+            return numberPrompt(config, context);
+        },
+        password(config, context) {
+            const theme = makeTheme(config.theme, {
+                style: {
+                    maskedText: locale.password.maskedText,
+                },
+            });
+            return passwordPrompt({ ...config, theme }, context);
+        },
+    };
+}

package/dist/index.d.ts

@@ -0,0 +1,30 @@
+import * as en from './locales/en.js';
+import { createLocalizedPrompts } from './create.js';
+export * from './create.js';
+type LocaleModule = ReturnType<typeof createLocalizedPrompts>;
+/**
+ * Register a custom locale so it is automatically picked up by the
+ * auto-detection logic in the root `@inquirer/i18n` import.
+ *
+ * Call this before any prompt is invoked. Use `createLocalizedPrompts`
+ * to build the locale object.
+ *
+ * @example
+ * ```ts
+ * import { registerLocale, createLocalizedPrompts } from '@inquirer/i18n';
+ *
+ * registerLocale('de', createLocalizedPrompts({ confirm: { ... }, ... }));
+ * ```
+ */
+export declare function registerLocale(code: string, locale: LocaleModule): void;
+export declare const confirm: typeof en.confirm;
+export declare const select: typeof en.select;
+export declare const checkbox: typeof en.checkbox;
+export declare const search: typeof en.search;
+export declare const expand: typeof en.expand;
+export declare const editor: typeof en.editor;
+export declare const input: typeof en.input;
+export declare const number: typeof en.number;
+export declare const password: typeof en.password;
+export declare const rawlist: typeof en.rawlist;
+export { Separator } from '@inquirer/prompts';

package/dist/index.js

@@ -0,0 +1,78 @@
+import * as en from './locales/en.js';
+import * as es from './locales/es.js';
+import * as fr from './locales/fr.js';
+import * as pt from './locales/pt.js';
+import * as zh from './locales/zh.js';
+export * from './create.js';
+const localeMap = { en, es, fr, pt, zh };
+/**
+ * Register a custom locale so it is automatically picked up by the
+ * auto-detection logic in the root `@inquirer/i18n` import.
+ *
+ * Call this before any prompt is invoked. Use `createLocalizedPrompts`
+ * to build the locale object.
+ *
+ * @example
+ * ```ts
+ * import { registerLocale, createLocalizedPrompts } from '@inquirer/i18n';
+ *
+ * registerLocale('de', createLocalizedPrompts({ confirm: { ... }, ... }));
+ * ```
+ */
+export function registerLocale(code, locale) {
+    localeMap[code] = locale;
+    // Invalidate the memo so the next prompt call re-runs detection.
+    cachedLocale = undefined;
+}
+function normalize(value) {
+    const [withoutEncoding = ''] = value.split('.');
+    const [lang = ''] = withoutEncoding.split(/[_-]/);
+    return lang.toLowerCase();
+}
+function detectLocale() {
+    // 1. LANGUAGE (GNU/Linux colon-separated preference list)
+    for (const seg of (process.env['LANGUAGE'] ?? '').split(':')) {
+        const lang = normalize(seg);
+        if (lang && lang in localeMap)
+            return lang;
+    }
+    // 2–4. LC_ALL, LC_MESSAGES, LANG
+    for (const key of ['LC_ALL', 'LC_MESSAGES', 'LANG']) {
+        const lang = normalize(process.env[key] ?? '');
+        if (lang && lang in localeMap)
+            return lang;
+    }
+    // 5. Intl API (cross-platform / primary Windows path)
+    try {
+        const lang = normalize(Intl.DateTimeFormat().resolvedOptions().locale);
+        if (lang && lang in localeMap)
+            return lang;
+    }
+    catch {
+        // ignore
+    }
+    return 'en';
+}
+// Memoized on a fingerprint of the four env vars we consult.
+// Cleared by `registerLocale()` so newly registered locales are picked up.
+let cachedLocale;
+let cachedEnvKey;
+function getLocale() {
+    const envKey = `${process.env['LANGUAGE'] ?? ''}|${process.env['LC_ALL'] ?? ''}|${process.env['LC_MESSAGES'] ?? ''}|${process.env['LANG'] ?? ''}`;
+    if (cachedLocale && envKey === cachedEnvKey)
+        return cachedLocale;
+    cachedEnvKey = envKey;
+    cachedLocale = localeMap[detectLocale()] ?? en;
+    return cachedLocale;
+}
+export const confirm = (config, context) => getLocale().confirm(config, context);
+export const select = (config, context) => getLocale().select(config, context);
+export const checkbox = (config, context) => getLocale().checkbox(config, context);
+export const search = (config, context) => getLocale().search(config, context);
+export const expand = (config, context) => getLocale().expand(config, context);
+export const editor = (config, context) => getLocale().editor(config, context);
+export const input = (config, context) => getLocale().input(config, context);
+export const number = (config, context) => getLocale().number(config, context);
+export const password = (config, context) => getLocale().password(config, context);
+export const rawlist = (config, context) => getLocale().rawlist(config, context);
+export { Separator } from '@inquirer/prompts';

package/dist/locales/en.d.ts

@@ -0,0 +1 @@
+export * from '@inquirer/prompts';

package/dist/locales/en.js

@@ -0,0 +1 @@
+export * from '@inquirer/prompts';

package/dist/locales/es.d.ts

@@ -0,0 +1,209 @@
+export declare const confirm: (this: void, config: {
+    message: string;
+    default?: boolean;
+    transformer?: (value: boolean) => string;
+    theme?: import("@inquirer/type").PartialDeep<import("@inquirer/core").Theme>;
+}, context?: import("@inquirer/type").Context | undefined) => Promise<boolean>, select: <Value>(this: void, config: {
+    message: string;
+    choices: readonly (import("@inquirer/prompts").Separator | Value | {
+        value: Value;
+        name?: string;
+        description?: string;
+        short?: string;
+        disabled?: boolean | string;
+        type?: never;
+    })[];
+    pageSize?: number | undefined;
+    loop?: boolean | undefined;
+    default?: NoInfer<Value> | undefined;
+    theme?: import("@inquirer/type").PartialDeep<import("@inquirer/core").Theme<{
+        icon: {
+            cursor: string;
+        };
+        style: {
+            disabled: (text: string) => string;
+            description: (text: string) => string;
+            keysHelpTip: (keys: [key: string, action: string][]) => string | undefined;
+        };
+        i18n: {
+            disabledError: string;
+        };
+        indexMode: "hidden" | "number";
+        keybindings: ReadonlyArray<import("@inquirer/core").Keybinding>;
+    }>> | undefined;
+}, context?: import("@inquirer/type").Context | undefined) => Promise<Value>, checkbox: <Value>(this: void, config: {
+    message: string;
+    prefix?: string | undefined;
+    pageSize?: number | undefined;
+    choices: readonly (string | import("@inquirer/prompts").Separator)[] | readonly (import("@inquirer/prompts").Separator | {
+        value: Value;
+        name?: string;
+        checkedName?: string;
+        description?: string;
+        short?: string;
+        disabled?: boolean | string;
+        checked?: boolean;
+        type?: never;
+    })[];
+    loop?: boolean | undefined;
+    required?: boolean | undefined;
+    validate?: ((choices: readonly {
+        value: Value;
+        name: string;
+        checkedName: string;
+        description?: string;
+        short: string;
+        disabled: boolean | string;
+        checked: boolean;
+    }[]) => boolean | string | Promise<string | boolean>) | undefined;
+    theme?: import("@inquirer/type").PartialDeep<import("@inquirer/core").Theme<{
+        icon: {
+            checked: string;
+            unchecked: string;
+            cursor: string;
+            disabledChecked: string;
+            disabledUnchecked: string;
+        };
+        style: {
+            disabled: (text: string) => string;
+            renderSelectedChoices: <T>(selectedChoices: ReadonlyArray<{
+                value: T;
+                name: string;
+                checkedName: string;
+                description?: string;
+                short: string;
+                disabled: boolean | string;
+                checked: boolean;
+            }>, allChoices: ReadonlyArray<{
+                value: T;
+                name: string;
+                checkedName: string;
+                description?: string;
+                short: string;
+                disabled: boolean | string;
+                checked: boolean;
+            } | import("@inquirer/prompts").Separator>) => string;
+            description: (text: string) => string;
+            keysHelpTip: (keys: [key: string, action: string][]) => string | undefined;
+        };
+        i18n: {
+            disabledError: string;
+        };
+        keybindings: ReadonlyArray<import("@inquirer/core").Keybinding>;
+    }>> | undefined;
+    shortcuts?: {
+        all?: string | null;
+        invert?: string | null;
+    } | undefined;
+}, context?: import("@inquirer/type").Context | undefined) => Promise<Value[]>, search: <Value>(this: void, config: {
+    message: string;
+    source: (term: string | undefined, opt: {
+        signal: AbortSignal;
+    }) => readonly (string | import("@inquirer/prompts").Separator)[] | Promise<readonly (string | import("@inquirer/prompts").Separator)[]> | readonly (import("@inquirer/prompts").Separator | {
+        value: Value;
+        name?: string;
+        description?: string;
+        short?: string;
+        disabled?: boolean | string;
+        type?: never;
+    })[] | Promise<readonly (import("@inquirer/prompts").Separator | {
+        value: Value;
+        name?: string;
+        description?: string;
+        short?: string;
+        disabled?: boolean | string;
+        type?: never;
+    })[]>;
+    validate?: ((value: Value) => boolean | string | Promise<string | boolean>) | undefined;
+    pageSize?: number | undefined;
+    default?: NoInfer<Value> | undefined;
+    theme?: import("@inquirer/type").PartialDeep<import("@inquirer/core").Theme<{
+        icon: {
+            cursor: string;
+        };
+        style: {
+            disabled: (text: string) => string;
+            searchTerm: (text: string) => string;
+            description: (text: string) => string;
+            keysHelpTip: (keys: [key: string, action: string][]) => string | undefined;
+        };
+    }>> | undefined;
+}, context?: import("@inquirer/type").Context | undefined) => Promise<Value>, expand: <Value>(this: void, config: {
+    message: string;
+    choices: readonly {
+        key: "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z";
+        name: string;
+    }[] | readonly (import("@inquirer/prompts").Separator | ({
+        key: "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z";
+        value: Value;
+    } | {
+        key: "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z";
+        name: string;
+        value: Value;
+    }))[];
+    default?: (("0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z") | "h") | undefined;
+    expanded?: boolean | undefined;
+    theme?: import("@inquirer/type").PartialDeep<import("@inquirer/core").Theme> | undefined;
+}, context?: import("@inquirer/type").Context | undefined) => Promise<Value>, rawlist: <Value>(this: void, config: {
+    message: string;
+    choices: readonly (import("@inquirer/prompts").Separator | Value | {
+        value: Value;
+        name?: string;
+        short?: string;
+        key?: string;
+        description?: string;
+    })[];
+    loop?: boolean | undefined;
+    theme?: import("@inquirer/type").PartialDeep<import("@inquirer/core").Theme<{
+        style: {
+            description: (text: string) => string;
+        };
+    }>> | undefined;
+    default?: NoInfer<Value> | undefined;
+}, context?: import("@inquirer/type").Context | undefined) => Promise<Value>, editor: (this: void, config: {
+    message: string;
+    default?: string;
+    postfix?: string;
+    waitForUserInput?: boolean;
+    validate?: (value: string) => boolean | string | Promise<string | boolean>;
+    file?: import("@inquirer/external-editor").IFileOptions;
+    theme?: import("@inquirer/type").PartialDeep<import("@inquirer/core").Theme<{
+        validationFailureMode: "keep" | "clear";
+        style: {
+            waitingMessage: (enterKey: string) => string;
+        };
+    }>>;
+}, context?: import("@inquirer/type").Context | undefined) => Promise<string>, input: (this: void, config: {
+    message: string;
+    default?: string;
+    prefill?: "tab" | "editable";
+    required?: boolean;
+    transformer?: (value: string, { isFinal }: {
+        isFinal: boolean;
+    }) => string;
+    validate?: (value: string) => boolean | string | Promise<string | boolean>;
+    theme?: import("@inquirer/type").PartialDeep<import("@inquirer/core").Theme<{
+        validationFailureMode: "keep" | "clear";
+    }>>;
+    pattern?: RegExp;
+    patternError?: string;
+}, context?: import("@inquirer/type").Context | undefined) => Promise<string>, number: <Required extends boolean = boolean>(this: void, config: {
+    message: string;
+    default?: number | undefined;
+    min?: number | undefined;
+    max?: number | undefined;
+    step?: number | "any" | undefined;
+    required?: Required | undefined;
+    validate?: ((value: Required extends true ? number : number | undefined) => boolean | string | Promise<string | boolean>) | undefined;
+    theme?: import("@inquirer/type").PartialDeep<import("@inquirer/core").Theme> | undefined;
+}, context?: import("@inquirer/type").Context | undefined) => Promise<Required extends true ? number : number | undefined>, password: (this: void, config: {
+    message: string;
+    mask?: boolean | string;
+    validate?: (value: string) => boolean | string | Promise<string | boolean>;
+    theme?: import("@inquirer/type").PartialDeep<import("@inquirer/core").Theme<{
+        style: {
+            maskedText: string;
+        };
+    }>>;
+}, context?: import("@inquirer/type").Context | undefined) => Promise<string>;
+export { Separator } from '@inquirer/prompts';

package/dist/locales/es.js

@@ -0,0 +1,32 @@
+import { createLocalizedPrompts } from "../create.js";
+const esLocale = {
+    confirm: {
+        yesLabel: 'Sí',
+        noLabel: 'No',
+        hintYes: 'S/n',
+        hintNo: 's/N',
+    },
+    select: {
+        helpNavigate: 'navegar',
+        helpSelect: 'seleccionar',
+    },
+    checkbox: {
+        helpNavigate: 'navegar',
+        helpSelect: 'seleccionar',
+        helpSubmit: 'enviar',
+        helpAll: 'todos',
+        helpInvert: 'invertir',
+    },
+    search: {
+        helpNavigate: 'navegar',
+        helpSelect: 'seleccionar',
+    },
+    editor: {
+        waitingMessage: (enterKey) => `Presione ${enterKey} para lanzar su editor preferido.`,
+    },
+    password: {
+        maskedText: '[entrada oculta]',
+    },
+};
+export const { confirm, select, checkbox, search, expand, rawlist, editor, input, number, password, } = createLocalizedPrompts(esLocale);
+export { Separator } from '@inquirer/prompts';