aboutsummaryrefslogtreecommitdiffstats
path: root/node_modules/concurrently/dist/src/command-parser/command-parser.d.ts
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/concurrently/dist/src/command-parser/command-parser.d.ts')
-rw-r--r--node_modules/concurrently/dist/src/command-parser/command-parser.d.ts19
1 files changed, 19 insertions, 0 deletions
diff --git a/node_modules/concurrently/dist/src/command-parser/command-parser.d.ts b/node_modules/concurrently/dist/src/command-parser/command-parser.d.ts
new file mode 100644
index 0000000..37ab795
--- /dev/null
+++ b/node_modules/concurrently/dist/src/command-parser/command-parser.d.ts
@@ -0,0 +1,19 @@
+import { CommandInfo } from '../command';
+/**
+ * A command parser encapsulates a specific logic for mapping `CommandInfo` objects
+ * into another `CommandInfo`.
+ *
+ * A prime example is turning an abstract `npm:foo` into `npm run foo`, but it could also turn
+ * the prefix color of a command brighter, or maybe even prefixing each command with `time(1)`.
+ */
+export interface CommandParser {
+ /**
+ * Parses `commandInfo` and returns one or more `CommandInfo`s.
+ *
+ * Returning multiple `CommandInfo` is used when there are multiple possibilities of commands to
+ * run given the original input.
+ * An example of this is when the command contains a wildcard and it must be expanded into all
+ * viable options so that the consumer can decide which ones to run.
+ */
+ parse(commandInfo: CommandInfo): CommandInfo | CommandInfo[];
+}
send patches to the email below
yukais@pinapelz.com
include the subject [PATCH repo_name]
pinapelz.com
homepage