@inquirer/rawlist 0.0.2-alpha.0

package/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2022 Simon Boudrias
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,40 @@
+# `@inquirer/rawlist`
+
+Simple interactive command line prompt to display a raw list of choices (single value select) with minimal interaction.
+
+![rawlist prompt](https://cdn.rawgit.com/SBoudrias/Inquirer.js/28ae8337ba51d93e359ef4f7ee24e79b69898962/assets/screenshots/rawlist.svg)
+
+# Installation
+
+```sh
+npm install @inquirer/rawlist
+
+yarn add @inquirer/rawlist
+```
+
+# Usage
+
+```js
+import rawlist from '@inquirer/rawlist';
+
+const answer = await rawlist({
+  message: 'Select a package manager',
+  choices: [
+    { name: 'npm', value: 'npm' },
+    { name: 'yarn', value: 'yarn' },
+    { name: 'pnpm', value: 'pnpm' },
+  ],
+});
+```
+
+## Options
+
+| Property | Type      | Required | Description                    |
+| -------- | --------- | -------- | ------------------------------ |
+| message  | `string`  | yes      | The question to ask            |
+| choices  | `Array<{ value: string, name?: string, key?: string }>` | yes       | List of the available choices. The `value` will be returned as the answer, and used as display if no `name` is defined. By default, choices will be selected by index. This can be customized by using the `key` option. |
+
+# License
+
+Copyright (c) 2022 Simon Boudrias (twitter: [@vaxilart](https://twitter.com/Vaxilart))
+Licensed under the MIT license.

package/demo.js

@@ -0,0 +1,55 @@
+const rawlist = require('.');
+
+(async () => {
+  let answer;
+
+  answer = await rawlist({
+    message: '(no keys) Conflict on `file.js`:',
+    choices: [
+      {
+        name: 'Overwrite',
+        value: 'overwrite',
+      },
+      {
+        name: 'Overwrite this one and all next',
+        value: 'overwrite_all',
+      },
+      {
+        name: 'Show diff',
+        value: 'diff',
+      },
+      {
+        name: 'Abort',
+        value: 'abort',
+      },
+    ],
+  });
+  console.log('Answer:', answer);
+
+  answer = await rawlist({
+    message: '(with keys) Conflict on `file.js`:',
+    choices: [
+      {
+        key: 'y',
+        name: 'Overwrite',
+        value: 'overwrite',
+      },
+      {
+        key: 'a',
+        name: 'Overwrite this one and all next',
+        value: 'overwrite_all',
+      },
+      {
+        key: 'd',
+        name: 'Show diff',
+        value: 'diff',
+      },
+      {
+        key: 'x',
+        name: 'Abort',
+        value: 'abort',
+      },
+    ],
+  });
+  console.log('Answer:', answer);
+})();

package/index.js

@@ -0,0 +1,70 @@
+const { createPrompt, useState, useKeypress } = require('@inquirer/core/hooks');
+const { usePrefix } = require('@inquirer/core/lib/prefix');
+const { isEnterKey } = require('@inquirer/core/lib/key');
+const chalk = require('chalk');
+
+const numberRegex = /[0-9]+/;
+
+module.exports = createPrompt((config, done) => {
+  const { choices } = config;
+  const [status, setStatus] = useState('pending');
+  const [value, setValue] = useState('');
+  const [errorMsg, setError] = useState();
+  const prefix = usePrefix();
+
+  useKeypress((key, rl) => {
+    if (isEnterKey(key)) {
+      let selectedChoice;
+      if (numberRegex.test(value)) {
+        const answer = parseInt(value, 10) - 1;
+        selectedChoice = choices[answer];
+      } else {
+        const answer = value.toLowerCase();
+        selectedChoice = choices.find(({ key }) => key === answer);
+      }
+
+      if (selectedChoice) {
+        const finalValue = selectedChoice.value || selectedChoice.name;
+        setValue(finalValue);
+        setStatus('done');
+        done(finalValue);
+      } else if (value === '') {
+        setError('Please input a value');
+      } else {
+        setError(`"${chalk.red(value)}" isn't an available option`);
+      }
+    } else {
+      setValue(rl.line);
+      setError(undefined);
+    }
+  });
+
+  const message = chalk.bold(config.message);
+
+  if (status === 'done') {
+    return `${prefix} ${message} ${chalk.cyan(value)}`;
+  }
+
+  const choicesStr = choices
+    .map((choice, index) => {
+      const humanIndex = index + 1;
+      const line = `  ${choice.key || humanIndex}) ${choice.name || choice.value}`;
+
+      if (choice.key === value.toLowerCase() || String(humanIndex) === value) {
+        return chalk.cyan(line);
+      }
+
+      return line;
+    })
+    .join('\n');
+
+  let error = '';
+  if (errorMsg) {
+    error = chalk.red(`> ${errorMsg}`);
+  }
+
+  return [
+    `${prefix} ${message} ${value}`,
+    [choicesStr, error].filter(Boolean).join('\n'),
+  ];
+});

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@inquirer/rawlist",
+  "version": "0.0.2-alpha.0",
+  "description": "Inquirer rawlist prompt",
+  "main": "index.js",
+  "repository": "SBoudrias/Inquirer.js",
+  "keywords": [
+    "cli",
+    "command",
+    "line",
+    "list",
+    "form",
+    "input",
+    "prompt",
+    "terminal"
+  ],
+  "author": "Simon Boudrias <admin@simonboudrias.com>",
+  "license": "MIT",
+  "homepage": "https://github.com/SBoudrias/Inquirer.js/blob/master/packages/rawlist/README.md",
+  "dependencies": {
+    "@inquirer/core": "^0.0.19-alpha.0",
+    "chalk": "^4.1.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "9baee326b04b4e8565e815b1fa577c36e0b93727"
+}