@inquirer/input 1.2.15 → 2.0.0

package/README.md

@@ -28,6 +28,27 @@ const answer = await input({ message: 'Enter your name' });
 | default     | `string`                                                    | no       | Default value if no answer is provided (clear it by pressing backspace)                                                                                                                                                 |
 | transformer | `(string, { isFinal: boolean }) => string`                  | no       | Transform/Format the raw value entered by the user. Once the prompt is completed, `isFinal` will be `true`. This function is purely visual, modify the answer in your code if needed.                                   |
 | validate    | `string => boolean \| string \| Promise<string \| boolean>` | no       | On submit, validate the filtered answered content. When returning a string, it'll be used as the error message displayed to the user. Note: returning a rejected promise, we'll assume a code error happened and crash. |
+| theme       | [See Theming](#Theming)                                     | no       | Customize look of the prompt.                                                                                                                                                                                           |
+
+## Theming
+
+You can theme a prompt by passing a `theme` object option. The theme object only need to includes the keys you wish to modify, we'll fallback on the defaults for the rest.
+
+```ts
+type Theme = {
+  prefix: string;
+  spinner: {
+    interval: number;
+    frames: string[];
+  };
+  style: {
+    answer: (text: string) => string;
+    message: (text: string) => string;
+    error: (text: string) => string;
+    defaultAnswer: (text: string) => string;
+  };
+};
+```
 
 # License
 

package/dist/cjs/index.js

@@ -8,20 +8,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 const core_1 = require("@inquirer/core");
-const chalk_1 = __importDefault(require("chalk"));
 exports.default = (0, core_1.createPrompt)((config, done) => {
     const { validate = () => true } = config;
+    const theme = (0, core_1.makeTheme)(config.theme);
     const [status, setStatus] = (0, core_1.useState)('pending');
     const [defaultValue = '', setDefaultValue] = (0, core_1.useState)(config.default);
     const [errorMsg, setError] = (0, core_1.useState)(undefined);
     const [value, setValue] = (0, core_1.useState)('');
     const isLoading = status === 'loading';
-    const prefix = (0, core_1.usePrefix)(isLoading);
+    const prefix = (0, core_1.usePrefix)({ isLoading, theme });
     (0, core_1.useKeypress)((key, rl) => __awaiter(void 0, void 0, void 0, function* () {
         // Ignore keypress while our prompt is doing other processing.
         if (status !== 'pending') {
@@ -58,21 +55,21 @@ exports.default = (0, core_1.createPrompt)((config, done) => {
             setError(undefined);
         }
     }));
-    const message = chalk_1.default.bold(config.message);
+    const message = theme.style.message(config.message);
     let formattedValue = value;
     if (typeof config.transformer === 'function') {
         formattedValue = config.transformer(value, { isFinal: status === 'done' });
     }
-    if (status === 'done') {
-        formattedValue = chalk_1.default.cyan(formattedValue);
+    else if (status === 'done') {
+        formattedValue = theme.style.answer(value);
     }
-    let defaultStr = '';
+    let defaultStr;
     if (defaultValue && status !== 'done' && !value) {
-        defaultStr = chalk_1.default.dim(` (${defaultValue})`);
+        defaultStr = theme.style.defaultAnswer(defaultValue);
     }
     let error = '';
     if (errorMsg) {
-        error = chalk_1.default.red(`> ${errorMsg}`);
+        error = theme.style.error(errorMsg);
     }
-    return [`${prefix} ${message}${defaultStr} ${formattedValue}`, error];
+    return [[prefix, message, defaultStr, formattedValue].filter(Boolean).join(' '), error];
 });

package/dist/cjs/types/index.d.ts

@@ -1,9 +1,13 @@
-declare const _default: import("@inquirer/type").Prompt<string, {
-    message: string | Promise<string> | (() => Promise<string>);
-    default?: string | undefined;
-    transformer?: ((value: string, { isFinal }: {
+import { type Theme } from '@inquirer/core';
+import type { PartialDeep } from '@inquirer/type';
+type InputConfig = {
+    message: string;
+    default?: string;
+    transformer?: (value: string, { isFinal }: {
         isFinal: boolean;
-    }) => string) | undefined;
-    validate?: ((value: string) => string | boolean | Promise<string | boolean>) | undefined;
-}>;
+    }) => string;
+    validate?: (value: string) => boolean | string | Promise<string | boolean>;
+    theme?: PartialDeep<Theme>;
+};
+declare const _default: import("@inquirer/type").Prompt<string, InputConfig>;
 export default _default;

package/dist/esm/index.mjs

@@ -1,13 +1,13 @@
-import { createPrompt, useState, useKeypress, usePrefix, isEnterKey, isBackspaceKey, } from '@inquirer/core';
-import chalk from 'chalk';
+import { createPrompt, useState, useKeypress, usePrefix, isEnterKey, isBackspaceKey, makeTheme, } from '@inquirer/core';
 export default createPrompt((config, done) => {
     const { validate = () => true } = config;
+    const theme = makeTheme(config.theme);
     const [status, setStatus] = useState('pending');
     const [defaultValue = '', setDefaultValue] = useState(config.default);
     const [errorMsg, setError] = useState(undefined);
     const [value, setValue] = useState('');
     const isLoading = status === 'loading';
-    const prefix = usePrefix(isLoading);
+    const prefix = usePrefix({ isLoading, theme });
     useKeypress(async (key, rl) => {
         // Ignore keypress while our prompt is doing other processing.
         if (status !== 'pending') {
@@ -44,21 +44,21 @@ export default createPrompt((config, done) => {
             setError(undefined);
         }
     });
-    const message = chalk.bold(config.message);
+    const message = theme.style.message(config.message);
     let formattedValue = value;
     if (typeof config.transformer === 'function') {
         formattedValue = config.transformer(value, { isFinal: status === 'done' });
     }
-    if (status === 'done') {
-        formattedValue = chalk.cyan(formattedValue);
+    else if (status === 'done') {
+        formattedValue = theme.style.answer(value);
     }
-    let defaultStr = '';
+    let defaultStr;
     if (defaultValue && status !== 'done' && !value) {
-        defaultStr = chalk.dim(` (${defaultValue})`);
+        defaultStr = theme.style.defaultAnswer(defaultValue);
     }
     let error = '';
     if (errorMsg) {
-        error = chalk.red(`> ${errorMsg}`);
+        error = theme.style.error(errorMsg);
     }
-    return [`${prefix} ${message}${defaultStr} ${formattedValue}`, error];
+    return [[prefix, message, defaultStr, formattedValue].filter(Boolean).join(' '), error];
 });

package/dist/esm/types/index.d.mts

@@ -1,9 +1,13 @@
-declare const _default: import("@inquirer/type").Prompt<string, {
-    message: string | Promise<string> | (() => Promise<string>);
-    default?: string | undefined;
-    transformer?: ((value: string, { isFinal }: {
+import { type Theme } from '@inquirer/core';
+import type { PartialDeep } from '@inquirer/type';
+type InputConfig = {
+    message: string;
+    default?: string;
+    transformer?: (value: string, { isFinal }: {
         isFinal: boolean;
-    }) => string) | undefined;
-    validate?: ((value: string) => string | boolean | Promise<string | boolean>) | undefined;
-}>;
+    }) => string;
+    validate?: (value: string) => boolean | string | Promise<string | boolean>;
+    theme?: PartialDeep<Theme>;
+};
+declare const _default: import("@inquirer/type").Prompt<string, InputConfig>;
 export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inquirer/input",
-  "version": "1.2.15",
+  "version": "2.0.0",
   "description": "Inquirer input text prompt",
   "main": "./dist/cjs/index.js",
   "typings": "./dist/cjs/types/index.d.ts",
@@ -54,12 +54,11 @@
   "license": "MIT",
   "homepage": "https://github.com/SBoudrias/Inquirer.js/blob/master/packages/input/README.md",
   "dependencies": {
-    "@inquirer/core": "^5.1.2",
-    "@inquirer/type": "^1.1.6",
-    "chalk": "^4.1.2"
+    "@inquirer/core": "^7.0.0",
+    "@inquirer/type": "^1.2.0"
   },
   "devDependencies": {
-    "@inquirer/testing": "^2.1.10"
+    "@inquirer/testing": "^2.1.11"
   },
   "scripts": {
     "tsc": "yarn run tsc:esm && yarn run tsc:cjs",
@@ -70,7 +69,7 @@
     "access": "public"
   },
   "engines": {
-    "node": ">=14.18.0"
+    "node": ">=18"
   },
   "exports": {
     ".": {
@@ -84,5 +83,5 @@
       }
     }
   },
-  "gitHead": "6c0d1d23e6881a10bc3d718d079a0a09ba382dd5"
+  "gitHead": "44016a40bc9e93455dfdb9fa6c25c27c1c109bd3"
 }