@inquirer/i18n 1.3.4 → 1.4.0

package/README.md

@@ -107,7 +107,11 @@ import { createLocalizedPrompts, registerLocale } from '@inquirer/i18n';
 import type { Locale } from '@inquirer/i18n';
 
 const deLocale: Locale = {
-  confirm: { yesLabel: 'Ja', noLabel: 'Nein' },
+  confirm: {
+    yesLabel: 'Ja',
+    noLabel: 'Nein',
+    invalidAnswer: (yes, no) => `Sie müssen mit "${yes}" oder "${no}" antworten.`,
+  },
   select: { helpNavigate: 'Navigieren', helpSelect: 'Auswählen' },
   checkbox: {
     helpNavigate: 'Navigieren',
@@ -121,7 +125,10 @@ const deLocale: Locale = {
     loadingMessage: () => 'Überprüfung...',
     waitingMessage: (enterKey) => `Drücken Sie ${enterKey}, um Ihren Editor zu öffnen.`,
   },
-  password: { maskedText: '[Eingabe verborgen]' },
+  password: {
+    maskedText: '[Eingabe verborgen]',
+    helpToggle: 'Sichtbarkeit umschalten',
+  },
 };
 
 // Option A — use directly
@@ -135,6 +142,33 @@ registerLocale('de', createLocalizedPrompts(deLocale));
 `import { confirm } from '@inquirer/i18n'` will pick the German locale automatically
 whenever `LANG` (or the other sources) resolve to `de`.
 
+# Themes and locales
+
+The strings above are the localized defaults. A `theme` passed to a prompt applies
+in every language — it overrides the locale strings, exactly as it overrides the
+built-in English ones in `@inquirer/prompts`. For example
+`password({ message, theme: { style: { maskedText: '[***]' } } })` renders `[***]`
+under every locale.
+
+To change the words of a single language, don't put them in the theme: build a
+locale with `createLocalizedPrompts` and register it with `registerLocale` instead:
+
+```js
+import { createLocalizedPrompts, registerLocale } from '@inquirer/i18n';
+import { locale as zh } from '@inquirer/i18n/zh';
+
+registerLocale(
+  'zh',
+  createLocalizedPrompts({
+    ...zh,
+    password: { ...zh.password, maskedText: '[已隐藏]' },
+  }),
+);
+```
+
+Note: a custom `keysHelpTip` formatter receives the help-line labels already
+translated into the active language (e.g. `导航` for `navigate` under `zh`).
+
 # License
 
 Copyright (c) 2025 Simon Boudrias (twitter: [@vaxilart](https://twitter.com/Vaxilart))<br/>

package/dist/create.js

@@ -1,6 +1,81 @@
 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';
+/**
+ * Default help-line renderer, with the same layout as every prompt's built-in
+ * theme: a bold key followed by a dim label, joined with a dim separator.
+ */
+function defaultKeysHelpTip(keys) {
+    return keys
+        .map(([key, label]) => `${styleText('bold', key)} ${styleText('dim', label)}`)
+        .join(styleText('dim', ' • '));
+}
+/**
+ * The user's keysHelpTip formatter from `config.theme`, or the default
+ * renderer when they gave none.
+ *
+ * Merged through `makeTheme` because `config.theme` is a `PartialDeep`, which
+ * widens function members to `{}` and loses their signature — `makeTheme`
+ * returns the fully typed theme, restoring it.
+ */
+function resolveKeysHelpTip(userTheme) {
+    const theme = makeTheme({ style: { keysHelpTip: defaultKeysHelpTip } }, userTheme);
+    return theme.style.keysHelpTip;
+}
+/**
+ * Wrap a help-line renderer so it receives the labels translated into the
+ * active locale instead of the prompt's built-in English ones.
+ */
+function localizedKeysHelpTip(keysHelpTip, translate) {
+    return (keys) => keysHelpTip(keys.map(([key, label]) => [key, translate(label)]));
+}
+/**
+ * The user's theme minus its `keysHelpTip`: the wrapper installs its own
+ * composing formatter, which already delegates to the user's one with
+ * translated labels. Keeping the original in the merge would override the
+ * composer and pass English labels straight through.
+ */
+function themeWithoutKeysHelpTip(theme) {
+    const style = { ...theme.style };
+    delete style.keysHelpTip;
+    return { ...theme, style };
+}
+/** Translate the select prompt's built-in help labels. */
+function translateSelectLabel(strings, label) {
+    if (label === 'navigate')
+        return strings.helpNavigate;
+    if (label === 'select')
+        return strings.helpSelect;
+    return label;
+}
+/** Translate the checkbox prompt's built-in help labels. */
+function translateCheckboxLabel(strings, label) {
+    if (label === 'navigate')
+        return strings.helpNavigate;
+    if (label === 'select')
+        return strings.helpSelect;
+    if (label === 'submit')
+        return strings.helpSubmit;
+    if (label === 'all')
+        return strings.helpAll;
+    if (label === 'invert')
+        return strings.helpInvert;
+    return label;
+}
+/** Translate the search prompt's built-in help labels. */
+function translateSearchLabel(strings, label) {
+    if (label === 'navigate')
+        return strings.helpNavigate;
+    if (label === 'select')
+        return strings.helpSelect;
+    return label;
+}
+/** Translate the password prompt's built-in help labels. */
+function translatePasswordLabel(strings, label) {
+    if (label === 'toggle visibility')
+        return strings.helpToggle;
+    return label;
+}
 /**
  * Factory function that creates localized prompt wrappers for a given locale.
  *
@@ -12,77 +87,41 @@ export function createLocalizedPrompts(locale) {
         confirm(config, context) {
             // 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,
+            // Locale strings are the defaults; config.theme overrides them.
+            const theme = makeTheme({
                 keywords: {
                     yes: locale.confirm.yesLabel,
                     no: locale.confirm.noLabel,
                     error: ({ yes, no }) => locale.confirm.invalidAnswer(yes, no),
                 },
-            };
+            }, config.theme);
             return confirmPrompt({ ...config, theme }, context);
         },
         select(config, context) {
-            const theme = makeTheme(config.theme, {
+            const localeTheme = {
                 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', ' • '));
-                    },
+                    keysHelpTip: localizedKeysHelpTip(resolveKeysHelpTip(config.theme), (label) => translateSelectLabel(locale.select, label)),
                 },
-            });
+            };
+            const theme = makeTheme(localeTheme, themeWithoutKeysHelpTip(config.theme ?? {}));
             return selectPrompt({ ...config, theme }, context);
         },
         checkbox(config, context) {
-            const theme = makeTheme(config.theme, {
+            const localeTheme = {
                 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', ' • '));
-                    },
+                    keysHelpTip: localizedKeysHelpTip(resolveKeysHelpTip(config.theme), (label) => translateCheckboxLabel(locale.checkbox, label)),
                 },
-            });
+            };
+            const theme = makeTheme(localeTheme, themeWithoutKeysHelpTip(config.theme ?? {}));
             return checkboxPrompt({ ...config, theme }, context);
         },
         search(config, context) {
-            const theme = makeTheme(config.theme, {
+            const localeTheme = {
                 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', ' • '));
-                    },
+                    keysHelpTip: localizedKeysHelpTip(resolveKeysHelpTip(config.theme), (label) => translateSearchLabel(locale.search, label)),
                 },
-            });
+            };
+            const theme = makeTheme(localeTheme, themeWithoutKeysHelpTip(config.theme ?? {}));
             return searchPrompt({ ...config, theme }, context);
         },
         expand(config, context) {
@@ -92,12 +131,13 @@ export function createLocalizedPrompts(locale) {
             return rawlistPrompt(config, context);
         },
         editor(config, context) {
-            const theme = makeTheme(config.theme, {
+            const localeTheme = {
                 style: {
                     loadingMessage: locale.editor.loadingMessage,
                     waitingMessage: locale.editor.waitingMessage,
                 },
-            });
+            };
+            const theme = makeTheme(localeTheme, config.theme);
             return editorPrompt({ ...config, theme }, context);
         },
         input(config, context) {
@@ -107,21 +147,13 @@ export function createLocalizedPrompts(locale) {
             return numberPrompt(config, context);
         },
         password(config, context) {
-            const theme = makeTheme(config.theme, {
+            const localeTheme = {
                 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', ' • '));
-                    },
+                    keysHelpTip: localizedKeysHelpTip(resolveKeysHelpTip(config.theme), (label) => translatePasswordLabel(locale.password, label)),
                 },
-            });
+            };
+            const theme = makeTheme(localeTheme, themeWithoutKeysHelpTip(config.theme ?? {}));
             return passwordPrompt({ ...config, theme }, context);
         },
     };

package/dist/index.js

@@ -1,9 +1,9 @@
-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";
+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