Merge pull request #67 from RecuencoJones/master

feat: add inquirer-ordinal-prompt and --ordered option

Author: ruyadorno

man/man1/ipt.1

@@ -32,6 +32,9 @@ Allows the selection of multiple items          [boolean]
 \fB\-M\fR, \fB\-\-message\fR
 Replaces interface message                       [string]
 .TP
+\fB\-o\fR, \fB\-\-ordered\fR
+Selects multiple items in order                 [boolean]
+.TP
 \fB\-p\fR, \fB\-\-extract\-path\fR
 Returns only a valid path for each item         [boolean]
 .TP

package-lock.json

@@ -43,6 +43,7 @@
     "get-stdin": "^7.0.0",
     "inquirer": "^7.1.0",
     "inquirer-autocomplete-prompt-ipt": "^2.0.0",
+    "inquirer-ordinal-prompt": "^1.0.0",
     "reopen-tty": "^1.1.2",
     "string-width": "~4.2.0",
     "yargs": "^15.3.0"

package.json

@@ -42,6 +42,8 @@ const { argv } = yargs
 	.describe("h", "Shows this help message")
 	.alias("m", "multiple")
 	.describe("m", "Allows the selection of multiple items")
+	.alias("o", "ordered")
+	.describe("o", "Selects multiple items in order")
 	.alias("M", "message")
 	.describe("M", "Replaces interface message")
 	.alias("0", "null")
@@ -57,7 +59,7 @@ const { argv } = yargs
 	.alias("u", "unquoted")
 	.describe("u", "Force the output to be unquoted")
 	.alias("v", "version")
-	.boolean(["0", "a", "c", "d", "h", "m", "0", "t", "p", "u", "v"])
+	.boolean(["0", "a", "c", "d", "h", "m", "o", "0", "t", "p", "u", "v"])
 	.string(["e", "M", "s", "D", "P"])
 	.number(["S"])
 	.epilog("Visit https://github.com/ruyadorno/ipt for more info");

src/cli.js

@@ -50,7 +50,7 @@ function iPipeTo(
 			return options.default;
 		}
 
-		if (promptType.type === "checkbox") {
+		if (promptType.type === "checkbox" || promptType.type === "ordinal") {
 			return options.default.split(
 				options["default-separator"] || options.separator
 			);
@@ -90,6 +90,13 @@ function iPipeTo(
 		);
 	}
 
+	if (options.ordered) {
+		prompt.registerPrompt(
+			"ordinal",
+			require("inquirer-ordinal-prompt").default
+		);
+	}
+
 	const promptTypes = {
 		base: {
 			...opts,
@@ -100,6 +107,11 @@ function iPipeTo(
 			type: "checkbox",
 			message: options.message || "Select multiple items:"
 		},
+		ordered: {
+			...opts,
+			type: "ordinal",
+			message: options.message || "Select multiple items in order:"
+		},
 		autocomplete: {
 			...opts,
 			type: "autocomplete",
@@ -116,6 +128,7 @@ function iPipeTo(
 	};
 
 	const promptType =
+		(options.ordered && promptTypes.ordered) ||
 		(options.multiple && promptTypes.multiple) ||
 		(options.autocomplete && promptTypes.autocomplete) ||
 		promptTypes.base;

src/index.js

@@ -11,6 +11,7 @@ Options:
   -e, --file-encoding      Encoding for file <path>, defaults to utf8   [string]
   -h, --help               Shows this help message                     [boolean]
   -m, --multiple           Allows the selection of multiple items      [boolean]
+  -o, --ordered            Selects multiple items in order             [boolean]
   -M, --message            Replaces interface message                   [string]
   -p, --extract-path       Returns only a valid path for each item     [boolean]
   -s, --separator          Separator to to split input into items       [string]
@@ -26,4 +27,3 @@ Examples:
   ls | ipt | sed   Builds an interactive interface and pipe stdout result
 
 Visit https://github.com/ruyadorno/ipt for more info
-

test/fixtures/help

@@ -54,6 +54,7 @@ test.afterEach(t => {
 });
 
 const key = {
+	up: [null, { name: "up" }],
 	down: [null, { name: "down" }],
 	space: [null, { name: "space" }],
 	l: ["l"],
@@ -144,6 +145,18 @@ test(
 	})
 );
 
+test(
+	"should be able to use multiple ordered items mode and select many",
+	unit({
+		input: ["foo", "bar", "lorem", "ipsum"],
+		output: ["lorem", "foo"],
+		actions: [key.down, key.down, key.space, key.up, key.up, key.space],
+		opts: {
+			ordered: true
+		}
+	})
+);
+
 test(
 	"should be able to use autocomplete interface",
 	unit({