@inquirer/demo 0.1.0

package/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2023 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/demos/checkbox.mjs

@@ -0,0 +1,65 @@
+import * as url from 'node:url';
+import { checkbox, Separator } from '@inquirer/prompts';
+
+const demo = async () => {
+  let answer;
+
+  answer = await checkbox({
+    message: 'Select a package manager',
+    choices: [
+      { name: 'npm', value: 'npm' },
+      { name: 'yarn', value: 'yarn' },
+      new Separator(),
+      { name: 'jspm', value: 'jspm', disabled: true },
+      {
+        name: 'pnpm',
+        value: 'pnpm',
+        disabled: '(pnpm is not available)',
+      },
+    ],
+  });
+  console.log('Answer:', answer);
+
+  answer = await checkbox({
+    message: 'Select your favorite letters',
+    choices: [
+      new Separator('== Alphabet (choices cycle as you scroll through) =='),
+      { value: 'A', checked: true },
+      { value: 'B' },
+      { value: 'C', checked: true },
+      { value: 'D' },
+      { value: 'E' },
+      { value: 'F' },
+      { value: 'G' },
+      { value: 'H' },
+      { value: 'I' },
+      { value: 'J' },
+      { value: 'K' },
+      { value: 'L' },
+      { value: 'M' },
+      { value: 'N' },
+      { value: 'O' },
+      { value: 'P' },
+      { value: 'Q' },
+      { value: 'R' },
+      { value: 'S' },
+      { value: 'T' },
+      { value: 'U' },
+      { value: 'V' },
+      { value: 'W' },
+      { value: 'X' },
+      { value: 'Y' },
+      { value: 'Z' },
+    ],
+  });
+  console.log('Answer:', answer);
+};
+
+if (import.meta.url.startsWith('file:')) {
+  const modulePath = url.fileURLToPath(import.meta.url);
+  if (process.argv[1] === modulePath) {
+    demo();
+  }
+}
+
+export default demo;

package/demos/confirm.mjs

@@ -0,0 +1,42 @@
+import * as url from 'node:url';
+import { confirm } from '@inquirer/prompts';
+
+const demo = async () => {
+  console.log(
+    'Answer:',
+    await confirm({
+      message: 'Confirm?',
+    })
+  );
+
+  console.log(
+    'Answer:',
+    await confirm({
+      message: 'Confirm with default to no?',
+      default: false,
+    })
+  );
+
+  console.log(
+    'Answer:',
+    await confirm({
+      message: 'Confirm with your custom transformer function?',
+      transformer: (answer) => (answer ? '👍' : '👎'),
+    })
+  );
+
+  console.log('This next prompt will be cleared on exit');
+  console.log(
+    'Cleared prompt answer:',
+    await confirm({ message: 'Confirm?' }, { clearPromptOnDone: true })
+  );
+};
+
+if (import.meta.url.startsWith('file:')) {
+  const modulePath = url.fileURLToPath(import.meta.url);
+  if (process.argv[1] === modulePath) {
+    demo();
+  }
+}
+
+export default demo;

package/demos/editor.mjs

@@ -0,0 +1,25 @@
+import * as url from 'node:url';
+import { editor } from '@inquirer/prompts';
+
+const demo = async () => {
+  const answer = await editor({
+    message: 'Please write a short bio of at least 3 lines.',
+    validate(text) {
+      if (text.trim().split('\n').length < 3) {
+        return 'Must be at least 3 lines.';
+      }
+
+      return true;
+    },
+  });
+  console.log('Answer:', answer);
+};
+
+if (import.meta.url.startsWith('file:')) {
+  const modulePath = url.fileURLToPath(import.meta.url);
+  if (process.argv[1] === modulePath) {
+    demo();
+  }
+}
+
+export default demo;

package/demos/expand.mjs

@@ -0,0 +1,98 @@
+import * as url from 'node:url';
+import { expand } from '@inquirer/prompts';
+
+const demo = async () => {
+  let answer;
+
+  answer = await expand({
+    message: '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);
+
+  answer = await expand({
+    message: '(With default) Conflict on `file.js`:',
+    default: 'y',
+    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);
+
+  answer = await expand({
+    expanded: true,
+    message: '(Auto-expand) 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);
+};
+
+if (import.meta.url.startsWith('file:')) {
+  const modulePath = url.fileURLToPath(import.meta.url);
+  if (process.argv[1] === modulePath) {
+    demo();
+  }
+}
+
+export default demo;

package/demos/input.mjs

@@ -0,0 +1,57 @@
+import * as url from 'node:url';
+import chalk from 'chalk';
+import { input } from '@inquirer/prompts';
+
+const hexRegEx = /([0-9]|[a-f])/gim;
+const isHex = (value) =>
+  (value.match(hexRegEx) || []).length === value.length &&
+  (value.length === 3 || value.length === 6);
+
+const demo = async () => {
+  let answer;
+
+  answer = await input({
+    message: "What's your favorite food?",
+    default: 'Croissant',
+  });
+  console.log('Answer:', answer);
+
+  answer = await input({
+    message: 'Enter an hex color?',
+    transformer(value = '', { isFinal }) {
+      const color = chalk.hex(isHex(value) ? value : 'fff');
+      return isFinal ? color.underline(value) : color(value);
+    },
+    validate: (value = '') => isHex(value) || 'Pass a valid hex value',
+  });
+  console.log('Answer:', answer);
+
+  answer = await input({
+    message: '(Slow validation) provide a number:',
+    validate: (value) =>
+      new Promise((resolve) => {
+        setTimeout(
+          () => resolve(!Number.isNaN(Number(value)) || 'You must provide a number'),
+          3000
+        );
+      }),
+  });
+  console.log('Answer:', answer);
+
+  answer = await input({
+    message: () =>
+      new Promise((resolve) => {
+        setTimeout(() => resolve('(Slow message) Input any value:'), 3000);
+      }),
+  });
+  console.log('Answer:', answer);
+};
+
+if (import.meta.url.startsWith('file:')) {
+  const modulePath = url.fileURLToPath(import.meta.url);
+  if (process.argv[1] === modulePath) {
+    demo();
+  }
+}
+
+export default demo;

package/demos/password.mjs

@@ -0,0 +1,28 @@
+import * as url from 'node:url';
+import { password } from '@inquirer/prompts';
+
+const demo = async () => {
+  console.log(
+    'Answer:',
+    await password({
+      message: 'Enter a silent password?',
+    })
+  );
+
+  console.log(
+    'Answer:',
+    await password({
+      message: 'Enter a masked password?',
+      mask: '*',
+    })
+  );
+};
+
+if (import.meta.url.startsWith('file:')) {
+  const modulePath = url.fileURLToPath(import.meta.url);
+  if (process.argv[1] === modulePath) {
+    demo();
+  }
+}
+
+export default demo;

package/demos/rawlist.mjs

@@ -0,0 +1,67 @@
+import * as url from 'node:url';
+import { rawlist, Separator } from '@inquirer/prompts';
+
+const demo = 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',
+      },
+      new Separator(),
+      {
+        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',
+      },
+      new Separator(),
+      {
+        key: 'x',
+        name: 'Abort',
+        value: 'abort',
+      },
+    ],
+  });
+  console.log('Answer:', answer);
+};
+
+if (import.meta.url.startsWith('file:')) {
+  const modulePath = url.fileURLToPath(import.meta.url);
+  if (process.argv[1] === modulePath) {
+    demo();
+  }
+}
+
+export default demo;

package/demos/select.mjs

@@ -0,0 +1,69 @@
+import * as url from 'node:url';
+import { select, Separator } from '@inquirer/prompts';
+
+const demo = async () => {
+  let answer;
+
+  answer = await select({
+    message: 'Select a package manager',
+    choices: [
+      {
+        name: 'npm',
+        value: 'npm',
+        description: 'npm is the most popular package manager',
+      },
+      { name: 'yarn', value: 'yarn', description: 'yarn is an awesome package manager' },
+      new Separator(),
+      { name: 'jspm', value: 'jspm', disabled: true },
+      {
+        name: 'pnpm',
+        value: 'pnpm',
+        disabled: '(pnpm is not available)',
+      },
+    ],
+  });
+  console.log('Answer:', answer);
+
+  answer = await select({
+    message: 'Select your favorite letter',
+    choices: [
+      new Separator('== Alphabet (choices cycle as you scroll through) =='),
+      { value: 'A' },
+      { value: 'B' },
+      { value: 'C' },
+      { value: 'D' },
+      { value: 'E' },
+      { value: 'F' },
+      { value: 'G' },
+      { value: 'H' },
+      { value: 'I' },
+      { value: 'J' },
+      { value: 'K' },
+      { value: 'L' },
+      { value: 'M' },
+      { value: 'N' },
+      { value: 'O', description: 'Letter O, not number 0' },
+      { value: 'P' },
+      { value: 'Q' },
+      { value: 'R' },
+      { value: 'S' },
+      { value: 'T' },
+      { value: 'U' },
+      { value: 'V' },
+      { value: 'W' },
+      { value: 'X' },
+      { value: 'Y' },
+      { value: 'Z' },
+    ],
+  });
+  console.log('Answer:', answer);
+};
+
+if (import.meta.url.startsWith('file:')) {
+  const modulePath = url.fileURLToPath(import.meta.url);
+  if (process.argv[1] === modulePath) {
+    demo();
+  }
+}
+
+export default demo;

package/index.mjs

@@ -0,0 +1,48 @@
+#!/usr/bin/env node
+/* eslint-disable no-await-in-loop */
+
+import { select } from '@inquirer/prompts';
+import checkboxDemo from './demos/checkbox.mjs';
+import confirmDemo from './demos/confirm.mjs';
+import editorDemo from './demos/editor.mjs';
+import expandDemo from './demos/expand.mjs';
+import inputDemo from './demos/input.mjs';
+import passwordDemo from './demos/password.mjs';
+import rawlistDemo from './demos/rawlist.mjs';
+import selectDemo from './demos/select.mjs';
+
+const demos = {
+  checkbox: checkboxDemo,
+  confirm: confirmDemo,
+  editor: editorDemo,
+  expand: expandDemo,
+  input: inputDemo,
+  password: passwordDemo,
+  rawlist: rawlistDemo,
+  select: selectDemo,
+};
+
+function askNextDemo() {
+  return select({
+    message: 'Which prompt demo do you want to run?',
+    choices: [
+      { name: 'Input', value: 'input' },
+      { name: 'Password', value: 'password' },
+      { name: 'Confirm', value: 'confirm' },
+      { name: 'Select', value: 'select' },
+      { name: 'Checkbox', value: 'checkbox' },
+      { name: 'Expand', value: 'expand' },
+      { name: 'Rawlist', value: 'rawlist' },
+      { name: 'Editor', value: 'editor' },
+      { name: "Exit (I'm done)", value: 'exit' },
+    ],
+  });
+}
+
+(async () => {
+  let nextDemo = await askNextDemo();
+  while (nextDemo !== 'exit') {
+    await demos[nextDemo]();
+    nextDemo = await askNextDemo();
+  }
+})();

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@inquirer/demo",
+  "version": "0.1.0",
+  "engines": {
+    "node": ">=14.18.0"
+  },
+  "type": "module",
+  "description": "Inquirer demos",
+  "main": "index.mjs",
+  "bin": {
+    "inquirer-demo": "index.mjs"
+  },
+  "files": [
+    "index.mjs",
+    "demos/"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/SBoudrias/Inquirer.js.git"
+  },
+  "keywords": [
+    "answer",
+    "answers",
+    "ask",
+    "base",
+    "cli",
+    "command",
+    "command-line",
+    "confirm",
+    "enquirer",
+    "generate",
+    "generator",
+    "hyper",
+    "input",
+    "inquire",
+    "inquirer",
+    "interface",
+    "iterm",
+    "javascript",
+    "menu",
+    "node",
+    "nodejs",
+    "prompt",
+    "promptly",
+    "prompts",
+    "question",
+    "readline",
+    "scaffold",
+    "scaffolder",
+    "scaffolding",
+    "stdin",
+    "stdout",
+    "terminal",
+    "tty",
+    "ui",
+    "yeoman",
+    "yo",
+    "zsh"
+  ],
+  "author": "Simon Boudrias <admin@simonboudrias.com>",
+  "license": "MIT",
+  "homepage": "https://github.com/SBoudrias/Inquirer.js",
+  "dependencies": {
+    "@inquirer/prompts": "^1.2.3",
+    "chalk": "^4.1.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "235c18f13650735b201a8853b28eda001f953d0f"
+}