@inquirer/i18n 1.2.0 → 1.3.0

package/README.md

@@ -89,7 +89,7 @@ import { createLocalizedPrompts, registerLocale } from '@inquirer/i18n';
 import type { Locale } from '@inquirer/i18n';
 
 const deLocale: Locale = {
-  confirm: { yesLabel: 'Ja', noLabel: 'Nein', hintYes: 'J/n', hintNo: 'j/N' },
+  confirm: { yesLabel: 'Ja', noLabel: 'Nein' },
   select: { helpNavigate: 'Navigieren', helpSelect: 'Auswählen' },
   checkbox: {
     helpNavigate: 'Navigieren',

package/dist/create.js

@@ -10,23 +10,16 @@ import { styleText } from 'node:util';
 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})`);
-                    },
+            // The labels are the keywords: confirm shows their first character in
+            // the hint, matches them prefix-based, and displays the label once done.
+            const theme = {
+                ...config.theme,
+                keywords: {
+                    yes: locale.confirm.yesLabel,
+                    no: locale.confirm.noLabel,
                 },
-            });
-            return confirmPrompt({
-                ...config,
-                theme,
-                transformer: config.transformer ??
-                    ((answer) => answer ? locale.confirm.yesLabel : locale.confirm.noLabel),
-            }, context);
+            };
+            return confirmPrompt({ ...config, theme }, context);
         },
         select(config, context) {
             const theme = makeTheme(config.theme, {
@@ -116,6 +109,16 @@ export function createLocalizedPrompts(locale) {
             const theme = makeTheme(config.theme, {
                 style: {
                     maskedText: locale.password.maskedText,
+                    keysHelpTip: (keys) => {
+                        const localizedKeys = keys.map(([key, label]) => {
+                            if (label === 'toggle visibility')
+                                return [key, locale.password.helpToggle];
+                            return [key, label];
+                        });
+                        return localizedKeys
+                            .map(([k, l]) => `${styleText('bold', k)} ${styleText('dim', l)}`)
+                            .join(styleText('dim', ' • '));
+                    },
                 },
             });
             return passwordPrompt({ ...config, theme }, context);

package/dist/locales/es.d.ts

@@ -1,8 +1,31 @@
+import type { Locale } from '../types.ts';
+export declare const locale: Locale;
 export declare const confirm: (this: void, config: {
+    message: string;
+    default?: boolean | undefined | undefined;
+    transformer?: ((value: boolean) => string) | undefined;
+    theme?: import("@inquirer/type").PartialDeep<import("@inquirer/core").Theme<{
+        keywords: {
+            yes: string;
+            no: string;
+        };
+        style: {
+            confirmDefault: (text: string) => string;
+        };
+    }>> | undefined;
+} & {
     message: string;
     default?: boolean | undefined;
     transformer?: (value: boolean) => string;
-    theme?: import("@inquirer/type").PartialDeep<import("@inquirer/core").Theme>;
+    theme?: import("@inquirer/type").PartialDeep<import("@inquirer/core").Theme<{
+        keywords: {
+            yes: string;
+            no: string;
+        };
+        style: {
+            confirmDefault: (text: string) => string;
+        };
+    }>>;
 }, context?: import("@inquirer/type").Context | undefined) => Promise<boolean>, select: <Value>(this: void, config: {
     message: string;
     choices: readonly (import("@inquirer/prompts").Separator | Value | {
@@ -30,6 +53,33 @@ export declare const confirm: (this: void, config: {
         };
         indexMode: "hidden" | "number";
     }>> | undefined;
+} & {
+    message: string;
+    choices: readonly (import("@inquirer/prompts").Separator | Value | {
+        value: Value;
+        name?: string;
+        description?: string;
+        short?: string;
+        disabled?: boolean | string;
+        type?: never;
+    })[];
+    pageSize?: number;
+    loop?: boolean;
+    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";
+    }>>;
 }, context?: import("@inquirer/type").Context | undefined) => Promise<Value>, checkbox: <Value>(this: void, config: {
     message: string;
     prefix?: string | undefined;
@@ -93,6 +143,69 @@ export declare const confirm: (this: void, config: {
         all?: string | null;
         invert?: string | null;
     } | undefined;
+} & {
+    message: string;
+    prefix?: string;
+    pageSize?: number;
+    choices: readonly (import("@inquirer/prompts").Separator | Value | {
+        value: Value;
+        name?: string;
+        checkedName?: string;
+        description?: string;
+        short?: string;
+        disabled?: boolean | string;
+        checked?: boolean;
+        type?: never;
+    })[];
+    loop?: boolean;
+    required?: boolean;
+    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;
+        };
+    }>>;
+    shortcuts?: {
+        all?: string | null;
+        invert?: string | null;
+    };
 }, context?: import("@inquirer/type").Context | undefined) => Promise<Value[]>, search: <Value>(this: void, config: {
     message: string;
     source: (term: string | undefined, opt: {
@@ -127,23 +240,74 @@ export declare const confirm: (this: void, config: {
             keysHelpTip: (keys: [key: string, action: string][]) => string | undefined;
         };
     }>> | undefined;
+} & {
+    message: string;
+    source: (term: string | undefined, opt: {
+        signal: AbortSignal;
+    }) => readonly (import("@inquirer/prompts").Separator | Value | {
+        value: Value;
+        name?: string;
+        description?: string;
+        short?: string;
+        disabled?: boolean | string;
+        type?: never;
+    })[] | Promise<readonly (import("@inquirer/prompts").Separator | Value | {
+        value: Value;
+        name?: string;
+        description?: string;
+        short?: string;
+        disabled?: boolean | string;
+        type?: never;
+    })[]>;
+    validate?: ((value: Value) => boolean | string | Promise<string | boolean>) | undefined;
+    pageSize?: number;
+    default?: NoInfer<Value> | undefined;
+    initialValue?: string;
+    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;
+        };
+    }>>;
 }, context?: import("@inquirer/type").Context | undefined) => Promise<Value>, expand: <Value>(this: void, config: {
     message: string;
     choices: readonly (import("@inquirer/prompts").Separator | {
-        key: "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "f" | "s" | "a" | "b" | "c" | "d" | "e" | "g" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "t" | "u" | "v" | "w" | "x" | "y" | "z";
+        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: Value & string;
         value?: never;
     } | ({
-        key: "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "f" | "s" | "a" | "b" | "c" | "d" | "e" | "g" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "t" | "u" | "v" | "w" | "x" | "y" | "z";
+        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" | "f" | "s" | "a" | "b" | "c" | "d" | "e" | "g" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "t" | "u" | "v" | "w" | "x" | "y" | "z";
+        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" | "f" | "s" | "a" | "b" | "c" | "d" | "e" | "g" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "t" | "u" | "v" | "w" | "x" | "y" | "z") | "h") | undefined;
+    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;
+} & {
+    message: string;
+    choices: 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;
+    }) | {
+        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: Value & string;
+        value?: never;
+    })[];
+    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";
+    expanded?: boolean;
+    theme?: import("@inquirer/type").PartialDeep<import("@inquirer/core").Theme>;
 }, context?: import("@inquirer/type").Context | undefined) => Promise<Value>, rawlist: <Value>(this: void, config: {
     message: string;
     choices: readonly (import("@inquirer/prompts").Separator | Value | {
@@ -160,7 +324,37 @@ export declare const confirm: (this: void, config: {
         };
     }>> | undefined;
     default?: NoInfer<Value> | undefined;
+} & {
+    message: string;
+    choices: readonly (import("@inquirer/prompts").Separator | Value | {
+        value: Value;
+        name?: string;
+        short?: string;
+        key?: string;
+        description?: string;
+    })[];
+    loop?: boolean;
+    theme?: import("@inquirer/type").PartialDeep<import("@inquirer/core").Theme<{
+        style: {
+            description: (text: string) => string;
+        };
+    }>>;
+    default?: NoInfer<Value> | undefined;
 }, context?: import("@inquirer/type").Context | undefined) => Promise<Value>, editor: (this: void, config: {
+    message: string;
+    default?: string | undefined | undefined;
+    postfix?: string | undefined;
+    waitForUserInput?: boolean | undefined;
+    validate?: ((value: string) => boolean | string | Promise<string | boolean>) | undefined;
+    file?: import("@inquirer/external-editor").FileOptions | undefined;
+    theme?: import("@inquirer/type").PartialDeep<import("@inquirer/core").Theme<{
+        validationFailureMode: "keep" | "clear";
+        style: {
+            loadingMessage: () => string;
+            waitingMessage: (enterKey: string) => string;
+        };
+    }>> | undefined;
+} & {
     message: string;
     default?: string | undefined;
     postfix?: string;
@@ -175,6 +369,20 @@ export declare const confirm: (this: void, config: {
         };
     }>>;
 }, context?: import("@inquirer/type").Context | undefined) => Promise<string>, input: (this: void, config: {
+    message: string;
+    default?: string | undefined | undefined;
+    prefill?: "tab" | "editable" | undefined;
+    required?: boolean | undefined;
+    transformer?: ((value: string, { isFinal }: {
+        isFinal: boolean;
+    }) => string) | undefined;
+    validate?: ((value: string) => boolean | string | Promise<string | boolean>) | undefined;
+    theme?: import("@inquirer/type").PartialDeep<import("@inquirer/core").Theme<{
+        validationFailureMode: "keep" | "clear";
+    }>> | undefined;
+    pattern?: RegExp | undefined;
+    patternError?: string | undefined;
+} & {
     message: string;
     default?: string | undefined;
     prefill?: "tab" | "editable";
@@ -197,13 +405,35 @@ export declare const confirm: (this: void, config: {
     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;
+} & {
+    message: string;
+    default?: number | undefined;
+    min?: number;
+    max?: number;
+    step?: number | "any";
+    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>;
 }, context?: import("@inquirer/type").Context | undefined) => Promise<Required extends true ? number : number | undefined>, password: (this: void, config: {
+    message: string;
+    mask?: boolean | string | undefined;
+    toggleMask?: boolean | undefined;
+    validate?: ((value: string) => boolean | string | Promise<string | boolean>) | undefined;
+    theme?: import("@inquirer/type").PartialDeep<import("@inquirer/core").Theme<{
+        style: {
+            maskedText: string;
+            keysHelpTip: (keys: [key: string, action: string][]) => string | undefined;
+        };
+    }>> | undefined;
+} & {
     message: string;
     mask?: boolean | string;
+    toggleMask?: boolean;
     validate?: (value: string) => boolean | string | Promise<string | boolean>;
     theme?: import("@inquirer/type").PartialDeep<import("@inquirer/core").Theme<{
         style: {
             maskedText: string;
+            keysHelpTip: (keys: [key: string, action: string][]) => string | undefined;
         };
     }>>;
 }, context?: import("@inquirer/type").Context | undefined) => Promise<string>;

package/dist/locales/es.js

@@ -1,10 +1,8 @@
 import { createLocalizedPrompts } from "../create.js";
-const esLocale = {
+export const locale = {
     confirm: {
         yesLabel: 'Sí',
         noLabel: 'No',
-        hintYes: 'S/n',
-        hintNo: 's/N',
     },
     select: {
         helpNavigate: 'navegar',
@@ -27,7 +25,8 @@ const esLocale = {
     },
     password: {
         maskedText: '[entrada oculta]',
+        helpToggle: 'alternar visibilidad',
     },
 };
-export const { confirm, select, checkbox, search, expand, rawlist, editor, input, number, password, } = createLocalizedPrompts(esLocale);
+export const { confirm, select, checkbox, search, expand, rawlist, editor, input, number, password, } = createLocalizedPrompts(locale);
 export { Separator } from '@inquirer/prompts';