Feat: Add choose

Author: japiirainen

README.md

@@ -101,6 +101,13 @@ const resp = await ask("What is your name?");
 console.log(resp);
 ```
 
+`choose` prompts the user to choose from the provided options.
+
+```ts
+const resp = await choose("Would you like a foo or a bar?", ["foo", "bar"]);
+console.log(resp);
+```
+
 `sleep` sleeps for specified ms.
 
 ```ts

deps.ts

@@ -28,6 +28,11 @@ export {
   Writable,
 } from "https://deno.land/[email protected]/node/stream.ts";
 
+//
+// external packages
+//
+export * as input from "https://deno.land/x/[email protected]/index.ts";
+
 //
 // internal
 //

examples/choose.ts

@@ -0,0 +1,15 @@
+#!/usr/bin/env vl
+
+//
+// Copyright 2022 Joona Piirainen
+// MIT License
+//
+
+import "../globals.d.ts";
+
+const age = await choose(
+  "How old are you?",
+  Array.from({ length: 120 }).map((_, i) => `${i}`),
+);
+
+await $`echo You are ${age} years old!`;

globals.d.ts

@@ -7,6 +7,7 @@ import {
   $Internal,
   askInternal,
   cdInternal,
+  chooseInternal,
   ColorsInternal,
   fsInternal,
   noThrowInternal,
@@ -24,6 +25,7 @@ declare global {
   const $: $Internal;
   const cd: typeof cdInternal;
   const ask: typeof askInternal;
+  const choose: typeof chooseInternal;
   const fs: typeof fsInternal;
   const os: typeof osInternal;
   const rmrf: typeof rmrfInternal;

index.ts

@@ -8,6 +8,7 @@ import {
   child_process,
   ChildProcess,
   Colors,
+  input,
   inspect,
   nodeFs as fsInternal,
   os as osInternal,
@@ -37,6 +38,7 @@ export const initEnv = () =>
     quiet: quietInternal,
     retry: retryInternal,
     startSpinner: startSpinnerInternal,
+    choose: chooseInternal,
   });
 
 export interface $Internal {
@@ -378,12 +380,31 @@ export const cdInternal = (path: string) => {
   Deno.chdir(path);
 };
 
-export const askInternal = async (question: string) => {
-  console.log(question);
+export const getLine = async () => {
   for await (const line of readLines(Deno.stdin)) {
     return line;
   }
-  return "";
+  throw new Error("EOL");
+};
+
+const write = (text: string) =>
+  Deno.stdout.write(new TextEncoder().encode(text));
+
+export const writeLine = (text: string) => write(text + "\n");
+
+export const askInternal = async (question: string) => {
+  const loop = new input.default();
+  return await loop.question(question);
+};
+
+export const chooseInternal = async (question: string, choices: string[]) => {
+  const loop = new input.default();
+  await writeLine(question);
+  const idx = (await loop.choose(choices)).findIndex(Boolean);
+  if (idx === -1) {
+    throw new Error("Answer not in the given choices.");
+  }
+  return choices[idx];
 };
 
 export const rmrfInternal = async (path: string) =>
@@ -421,10 +442,7 @@ export const retryInternal = (count = 0, delay = 0) =>
 
 export const startSpinnerInternal = (title = "") => {
   let i = 0;
-  const spin = () =>
-    Deno.stdout.write(
-      new TextEncoder().encode(`  ${"⠋⠙⠹⠸⠼⠴⠦⠧⠇⠏"[i++ % 10]} ${title}\r`),
-    );
+  const spin = () => write(`  ${"⠋⠙⠹⠸⠼⠴⠦⠧⠇⠏"[i++ % 10]} ${title}\r`);
   return ((id) => ({
     stopSpinner: () => clearInterval(id),
   }))(setInterval(spin, 100));

scratch.mjs

@@ -0,0 +1,5 @@
+#!/usr/bin/env vl
+
+const token = await ask("Do you have GitHub token in env? ");
+const fooOrBar = await choose("foo or bar? ", ["foo", "bar"]);
+console.log(fooOrBar, token);