feat(prompt): add prefix option (#233)

c4spar · Jun 30, 2021 · a4943cb · a4943cb
1 parent 39a8075
commit a4943cb
Show file tree

Hide file tree

Showing 18 changed files with 49 additions and 13 deletions.
diff --git a/prompt/_generic_list.ts b/prompt/_generic_list.ts
@@ -5,7 +5,7 @@ import {
   GenericInputPromptOptions,
   GenericInputPromptSettings,
 } from "./_generic_input.ts";
-import { blue, bold, dim, stripColor, yellow } from "./deps.ts";
+import { blue, bold, dim, stripColor } from "./deps.ts";
 import { Figures } from "./figures.ts";
 import { distance } from "../_utils/distance.ts";
 
@@ -139,7 +139,7 @@ export abstract class GenericList<T, V, S extends GenericListSettings<T, V>>
   }
 
   protected message(): string {
-    let message = `${this.settings.indent}${yellow("?")} ` +
+    let message = `${this.settings.indent}${this.settings.prefix}` +
       bold(this.settings.message) +
       this.defaults();
     if (this.settings.search) {

diff --git a/prompt/_generic_prompt.ts b/prompt/_generic_prompt.ts
@@ -1,7 +1,7 @@
 import type { Cursor } from "../ansi/cursor_position.ts";
 import { tty } from "../ansi/tty.ts";
 import { KeyCode, parse } from "../keycode/key_code.ts";
-import { blue, bold, dim, green, italic, red, yellow } from "./deps.ts";
+import { blue, bold, dim, green, italic, red } from "./deps.ts";
 import { Figures } from "./figures.ts";
 
 /** Prompt validation return tape. */
@@ -23,13 +23,15 @@ export interface GenericPromptOptions<T, V> {
   indent?: string;
   keys?: GenericPromptKeys;
   cbreak?: boolean;
+  prefix?: string;
 }
 
 /** Generic prompt settings. */
 export interface GenericPromptSettings<T, V>
   extends GenericPromptOptions<T, V> {
   pointer: string;
   indent: string;
+  prefix: string;
 }
 
 /** Static generic prompt interface. */
@@ -183,7 +185,7 @@ export abstract class GenericPrompt<
   }
 
   protected message(): string {
-    return `${this.settings.indent}${yellow("?")} ` +
+    return `${this.settings.indent}${this.settings.prefix}` +
       bold(this.settings.message) + this.defaults();
   }
 
@@ -197,7 +199,7 @@ export abstract class GenericPrompt<
 
   /** Get prompt success message. */
   protected success(value: T): string | undefined {
-    return `${this.settings.indent}${yellow("?")} ` +
+    return `${this.settings.indent}${this.settings.prefix}` +
       bold(this.settings.message) + this.defaults() +
       " " + this.settings.pointer +
       " " + green(this.format(value));

diff --git a/prompt/checkbox.ts b/prompt/checkbox.ts
@@ -1,5 +1,5 @@
 import type { KeyCode } from "../keycode/mod.ts";
-import { blue, dim, green, red } from "./deps.ts";
+import { blue, dim, green, red, yellow } from "./deps.ts";
 import { Figures } from "./figures.ts";
 import {
   GenericList,
@@ -69,6 +69,7 @@ export class Checkbox
   public static prompt(options: CheckboxOptions): Promise<string[]> {
     return new this({
       pointer: blue(Figures.POINTER_SMALL),
+      prefix: yellow("? "),
       indent: " ",
       listPointer: blue(Figures.POINTER),
       maxRows: 10,

diff --git a/prompt/confirm.ts b/prompt/confirm.ts
@@ -5,7 +5,7 @@ import {
   GenericSuggestionsOptions,
   GenericSuggestionsSettings,
 } from "./_generic_suggestions.ts";
-import { blue, dim } from "./deps.ts";
+import { blue, dim, yellow } from "./deps.ts";
 import { Figures } from "./figures.ts";
 
 export type ConfirmKeys = GenericSuggestionsKeys;
@@ -41,6 +41,7 @@ export class Confirm
 
     return new this({
       pointer: blue(Figures.POINTER_SMALL),
+      prefix: yellow("? "),
       indent: " ",
       listPointer: blue(Figures.POINTER),
       maxRows: 8,

diff --git a/prompt/input.ts b/prompt/input.ts
@@ -5,7 +5,7 @@ import {
   GenericSuggestionsOptions,
   GenericSuggestionsSettings,
 } from "./_generic_suggestions.ts";
-import { blue } from "./deps.ts";
+import { blue, yellow } from "./deps.ts";
 import { Figures } from "./figures.ts";
 
 export type InputKeys = GenericSuggestionsKeys;
@@ -35,6 +35,7 @@ export class Input extends GenericSuggestions<string, string, InputSettings> {
 
     return new this({
       pointer: blue(Figures.POINTER_SMALL),
+      prefix: yellow("? "),
       indent: " ",
       listPointer: blue(Figures.POINTER),
       maxRows: 8,

diff --git a/prompt/list.ts b/prompt/list.ts
@@ -5,7 +5,7 @@ import {
   GenericSuggestionsOptions,
   GenericSuggestionsSettings,
 } from "./_generic_suggestions.ts";
-import { blue, dim, underline } from "./deps.ts";
+import { blue, dim, underline, yellow } from "./deps.ts";
 import { Figures } from "./figures.ts";
 
 /** List key options. */
@@ -42,6 +42,7 @@ export class List extends GenericSuggestions<string[], string, ListSettings> {
 
     return new this({
       pointer: blue(Figures.POINTER_SMALL),
+      prefix: yellow("? "),
       indent: " ",
       listPointer: blue(Figures.POINTER),
       maxRows: 8,

diff --git a/prompt/number.ts b/prompt/number.ts
@@ -7,7 +7,7 @@ import {
   GenericSuggestionsSettings,
 } from "./_generic_suggestions.ts";
 import { parseNumber } from "./_utils.ts";
-import { blue } from "./deps.ts";
+import { blue, yellow } from "./deps.ts";
 import { Figures } from "./figures.ts";
 
 /** Number key options. */
@@ -45,6 +45,7 @@ export class Number extends GenericSuggestions<number, string, NumberSettings> {
 
     return new this({
       pointer: blue(Figures.POINTER_SMALL),
+      prefix: yellow("? "),
       indent: " ",
       listPointer: blue(Figures.POINTER),
       maxRows: 8,

diff --git a/prompt/secret.ts b/prompt/secret.ts
@@ -1,5 +1,5 @@
 import { GenericPrompt } from "./_generic_prompt.ts";
-import { blue, underline } from "./deps.ts";
+import { blue, underline, yellow } from "./deps.ts";
 import { Figures } from "./figures.ts";
 import {
   GenericInput,
@@ -40,6 +40,7 @@ export class Secret extends GenericInput<string, string, SecretSettings> {
 
     return new this({
       pointer: blue(Figures.POINTER_SMALL),
+      prefix: yellow("? "),
       indent: " ",
       label: "Password",
       hidden: false,

diff --git a/prompt/select.ts b/prompt/select.ts
@@ -1,4 +1,4 @@
-import { blue, underline } from "./deps.ts";
+import { blue, underline, yellow } from "./deps.ts";
 import { Figures } from "./figures.ts";
 import {
   GenericList,
@@ -53,6 +53,7 @@ export class Select<S extends SelectSettings = SelectSettings>
   public static prompt(options: SelectOptions): Promise<string> {
     return new this({
       pointer: blue(Figures.POINTER_SMALL),
+      prefix: yellow("? "),
       indent: " ",
       listPointer: blue(Figures.POINTER),
       maxRows: 10,

diff --git a/prompt/test/integration/fixtures/input_no_prefix.in b/prompt/test/integration/fixtures/input_no_prefix.in
@@ -0,0 +1 @@
+bar
diff --git a/prompt/test/integration/fixtures/input_no_prefix.out b/prompt/test/integration/fixtures/input_no_prefix.out
@@ -0,0 +1,2 @@
+ Whats your name? (foo) › \x1b[27G\x1b[G\x1b[0J Whats your name? (foo) › bar
+\x1b[?25h\x1b[?25h
diff --git a/prompt/test/integration/fixtures/input_no_prefix.ts b/prompt/test/integration/fixtures/input_no_prefix.ts
@@ -0,0 +1,7 @@
+import { Input } from "../../../input.ts";
+
+await Input.prompt({
+  message: "Whats your name?",
+  default: "foo",
+  prefix: "",
+});
diff --git a/prompt/test/integration/fixtures/input_no_prefix.windows.out b/prompt/test/integration/fixtures/input_no_prefix.windows.out
@@ -0,0 +1,3 @@
+ Whats your name? (foo) » 
+\x1b[1A\x1b[27G\x1b[G\x1b[0J Whats your name? (foo) » bar
+\x1b[?25h\x1b[?25h
diff --git a/prompt/test/integration/fixtures/input_prefix.in b/prompt/test/integration/fixtures/input_prefix.in
@@ -0,0 +1 @@
+bar
diff --git a/prompt/test/integration/fixtures/input_prefix.out b/prompt/test/integration/fixtures/input_prefix.out
@@ -0,0 +1,2 @@
+ PREFIX Whats your name? (foo) › \x1b[34G\x1b[G\x1b[0J PREFIX Whats your name? (foo) › bar
+\x1b[?25h\x1b[?25h
diff --git a/prompt/test/integration/fixtures/input_prefix.ts b/prompt/test/integration/fixtures/input_prefix.ts
@@ -0,0 +1,7 @@
+import { Input } from "../../../input.ts";
+
+await Input.prompt({
+  message: "Whats your name?",
+  default: "foo",
+  prefix: "PREFIX ",
+});
diff --git a/prompt/test/integration/fixtures/input_prefix.windows.out b/prompt/test/integration/fixtures/input_prefix.windows.out
@@ -0,0 +1,3 @@
+ PREFIX Whats your name? (foo) » 
+\x1b[1A\x1b[34G\x1b[G\x1b[0J PREFIX Whats your name? (foo) » bar
+\x1b[?25h\x1b[?25h
diff --git a/prompt/toggle.ts b/prompt/toggle.ts
@@ -1,5 +1,5 @@
 import type { KeyCode } from "../keycode/key_code.ts";
-import { blue, dim, underline } from "./deps.ts";
+import { blue, dim, underline, yellow } from "./deps.ts";
 import { Figures } from "./figures.ts";
 import {
   GenericPrompt,
@@ -44,6 +44,7 @@ export class Toggle extends GenericPrompt<boolean, string, ToggleSettings> {
 
     return new this({
       pointer: blue(Figures.POINTER_SMALL),
+      prefix: yellow("? "),
       indent: " ",
       active: "Yes",
       inactive: "No",