Added documentation on cli

2025-01-22 14:24:55 +01:00
parent 8a5461827e
commit 75a9591f6a
8 changed files with 175 additions and 94 deletions
@@ -0,0 +1,40 @@
+import {
+  CLI,
+  CLIAsyncCommand,
+  CLICommand,
+  displayHelp,
+} from "$root/toolbox/cli/help.ts";
+
+/**
+ * Run the command given by arguments.
+ * @param commands The given arguments.
+ * @param cli The CLI (sub-)configuration object.
+ * @returns The command or the help if commands are not valid.
+ */
+export function runCommand(
+  commands: Array<string | number>,
+  cli: CLI,
+): never | {
+  command: CLICommand | CLIAsyncCommand;
+  args: Array<string | number>;
+} {
+  if (commands.length == 0) {
+    displayHelp(cli, `No command provided.`);
+  }
+
+  const command = commands.shift()!.toString();
+
+  if (cli[command] == undefined) {
+    displayHelp(cli, `Command "${command}" doesn't exist.`);
+  }
+
+  if (typeof cli[command] == "object") {
+    return runCommand(commands, cli[command]);
+  }
+
+  if (cli[command].length != commands.length) {
+    displayHelp(cli[command], `Wrong usage of command "${command}".`);
+  }
+
+  return { command: cli[command], args: commands };
+}