@inquirer/select 0.0.29-alpha.0 → 1.0.0

package/README.md

@@ -35,6 +35,11 @@ const answer = await select({
       value: 'jspm',
       disabled: true,
     },
+    {
+      name: 'pnpm',
+      value: 'pnpm',
+      disabled: '(pnpm is not available)',
+    },
   ],
 });
 ```
@@ -44,7 +49,7 @@ const answer = await select({
 | Property | Type      | Required | Description                    |
 | -------- | --------- | -------- | ------------------------------ |
 | message  | `string`  | yes      | The question to ask            |
-| choices  | `Array<{ value: string, name?: string, description?: string, disabled?: boolean }>` | yes       | List of the available choices. The `value` will be returned as the answer, and used as display if no `name` is defined. Choices who're `disabled` will be displayed, but not selectable. The `description` will be displayed under the prompt when the cursor land over the choice. |
+| choices  | `Array<{ value: string, name?: string, description?: string, disabled?: boolean \| string }>` | yes       | List of the available choices. The `value` will be returned as the answer, and used as display if no `name` is defined. Choices who're `disabled` will be displayed, but not selectable. The `description` will be displayed under the prompt when the cursor land over the choice. |
 | pageSize  | `number`  | no      | By default, lists of choice longer than 7 will be paginated. Use this option to control how many choices will appear on the screen at once. |
 
 # License

package/dist/cjs/index.js

@@ -0,0 +1,69 @@
+"use strict";
+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"));
+const figures_1 = __importDefault(require("figures"));
+const ansi_escapes_1 = __importDefault(require("ansi-escapes"));
+exports.default = (0, core_1.createPrompt)((config, done) => {
+    const { choices } = config;
+    const startIndex = Math.max(choices.findIndex(({ disabled }) => !disabled), 0);
+    const paginator = (0, core_1.useRef)(new core_1.Paginator()).current;
+    const firstRender = (0, core_1.useRef)(true);
+    const prefix = (0, core_1.usePrefix)();
+    const [status, setStatus] = (0, core_1.useState)('pending');
+    const [cursorPosition, setCursorPos] = (0, core_1.useState)(startIndex);
+    (0, core_1.useKeypress)((key) => {
+        if ((0, core_1.isEnterKey)(key)) {
+            setStatus('done');
+            done(choices[cursorPosition].value);
+        }
+        else if ((0, core_1.isUpKey)(key) || (0, core_1.isDownKey)(key)) {
+            let newCursorPosition = cursorPosition;
+            const offset = (0, core_1.isUpKey)(key) ? -1 : 1;
+            let selectedOption;
+            while (!selectedOption || selectedOption.disabled) {
+                newCursorPosition =
+                    (newCursorPosition + offset + choices.length) % choices.length;
+                selectedOption = choices[newCursorPosition];
+            }
+            setCursorPos(newCursorPosition);
+        }
+        else if ((0, core_1.isNumberKey)(key)) {
+            // Adjust index to start at 1
+            const newCursorPosition = Number(key.name) - 1;
+            // Abort if the choice doesn't exists or if disabled
+            if (!choices[newCursorPosition] || choices[newCursorPosition].disabled) {
+                return;
+            }
+            setCursorPos(newCursorPosition);
+        }
+    });
+    let message = chalk_1.default.bold(config.message);
+    if (firstRender.current) {
+        message += chalk_1.default.dim(' (Use arrow keys)');
+        firstRender.current = false;
+    }
+    if (status === 'done') {
+        const choice = choices[cursorPosition];
+        return `${prefix} ${message} ${chalk_1.default.cyan(choice.name || choice.value)}`;
+    }
+    const allChoices = choices
+        .map(({ name, value, disabled }, index) => {
+        const line = name || value;
+        if (disabled) {
+            return chalk_1.default.dim(`- ${line} ${typeof disabled === 'string' ? disabled : '(disabled)'}`);
+        }
+        if (index === cursorPosition) {
+            return chalk_1.default.cyan(`${figures_1.default.pointer} ${line}`);
+        }
+        return `  ${line}`;
+    })
+        .join('\n');
+    const windowedChoices = paginator.paginate(allChoices, cursorPosition, config.pageSize);
+    const choice = choices[cursorPosition];
+    const choiceDescription = choice && choice.description ? `\n${choice.description}` : ``;
+    return `${prefix} ${message}\n${windowedChoices}${choiceDescription}${ansi_escapes_1.default.cursorHide}`;
+});

package/dist/{index.d.ts → cjs/types/index.d.mts}

@@ -1,10 +1,10 @@
 import { AsyncPromptConfig } from '@inquirer/core';
-declare type SelectConfig = AsyncPromptConfig & {
+type SelectConfig = AsyncPromptConfig & {
     choices: {
         value: string;
         name?: string;
         description?: string;
-        disabled?: boolean;
+        disabled?: boolean | string;
     }[];
     pageSize?: number;
 };

package/dist/{index.js → esm/index.mjs}

@@ -49,7 +49,7 @@ export default createPrompt((config, done) => {
         .map(({ name, value, disabled }, index) => {
         const line = name || value;
         if (disabled) {
-            return chalk.dim(`- ${line} (disabled)`);
+            return chalk.dim(`- ${line} ${typeof disabled === 'string' ? disabled : '(disabled)'}`);
         }
         if (index === cursorPosition) {
             return chalk.cyan(`${figures.pointer} ${line}`);

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

@@ -0,0 +1,12 @@
+import { AsyncPromptConfig } from '@inquirer/core';
+type SelectConfig = AsyncPromptConfig & {
+    choices: {
+        value: string;
+        name?: string;
+        description?: string;
+        disabled?: boolean | string;
+    }[];
+    pageSize?: number;
+};
+declare const _default: import("@inquirer/type").Prompt<string, SelectConfig>;
+export default _default;

package/package.json

@@ -1,21 +1,22 @@
 {
   "name": "@inquirer/select",
-  "type": "module",
-  "version": "0.0.29-alpha.0",
+  "version": "1.0.0",
   "description": "Inquirer select/list prompt",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "./dist/cjs/index.js",
+  "typings": "./dist/cjs/types/index.d.mts",
   "files": [
-    "dist/"
+    "dist/**/*"
   ],
-  "repository": "SBoudrias/Inquirer.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/SBoudrias/Inquirer.js.git"
+  },
   "keywords": [
     "answer",
     "answers",
     "ask",
     "base",
     "cli",
-    "cli",
     "command",
     "command-line",
     "confirm",
@@ -49,20 +50,40 @@
     "yo",
     "zsh"
   ],
-  "author": "Simon Boudrias",
+  "author": "Simon Boudrias <admin@simonboudrias.com>",
   "license": "MIT",
   "homepage": "https://github.com/SBoudrias/Inquirer.js/blob/master/packages/select/README.md",
   "dependencies": {
-    "@inquirer/core": "^0.0.30-alpha.0",
+    "@inquirer/core": "^1.0.1",
+    "@inquirer/type": "^1.0.0",
     "ansi-escapes": "^6.0.0",
-    "chalk": "^5.1.2",
+    "chalk": "^5.2.0",
     "figures": "^5.0.0"
   },
   "scripts": {
-    "tsc": "tsc"
+    "tsc": "yarn run clean && yarn run tsc:esm && yarn run tsc:cjs",
+    "clean": "rm -rf dist",
+    "tsc:esm": "tsc -p ./tsconfig.esm.json",
+    "tsc:cjs": "tsc -p ./tsconfig.cjs.json && yarn run fix-ext",
+    "fix-ext": "ts-node ../../tools/rename-ext.ts"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "f532af8be2d622caa5e54adf4c084d588c9ffad6"
+  "engines": {
+    "node": ">=14.18.0"
+  },
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/esm/types/index.d.mts",
+        "default": "./dist/esm/index.mjs"
+      },
+      "require": {
+        "types": "./dist/cjs/types/index.d.mts",
+        "default": "./dist/cjs/index.js"
+      }
+    }
+  },
+  "gitHead": "e93c4cb14f0c35ebd1efb065776b90f48899b075"
 }