chore(scripts): multi-commands for cli dispatcher (#1712)

Author: kuhe

scripts/cli-dispatcher/index.js

@@ -1,18 +1,18 @@
 #!/usr/bin/env node
 
-const fs = require("fs");
 const path = require("path");
 const readline = require("readline");
 
 const findFolders = require("./lib/findFolders");
 const findScripts = require("./lib/findScripts");
 const Package = require("./lib/Package");
+const { listFolders } = require("../utils/list-folders");
 
 /**
  * This script takes your command line arguments and infers the
  * package in which to execute them.
  *
- * It is supposed to save time moving among packages folders
+ * It is supposed to save time moving among packages/private folders
  * for building and running other test commands.
  */
 async function main() {
@@ -21,42 +21,32 @@ async function main() {
   const root = path.join(__dirname, "..", "..");
   const argv = process.argv;
 
-  const packages = fs.readdirSync(path.join(root, "packages"));
-  const private = fs.readdirSync(path.join(root, "private"));
+  const packages = listFolders(path.join(root, "packages"));
+  const _private = listFolders(path.join(root, "private"));
 
   const allPackages = [
     ...packages.map((p) => new Package(p, path.join(root, "packages", p))),
-    ...private.map((p) => new Package(p, path.join(root, "private", p))),
+    ..._private.map((p) => new Package(p, path.join(root, "private", p))),
   ];
 
   const [node, dispatcher, ...rest] = argv;
   const flags = rest.filter((f) => f.startsWith("--"));
   const options = {
-    dry: flags.includes("--dry"),
     help: flags.includes("--help") || rest.length === 0,
-    confirm: flags.includes("--c"),
   };
 
   if (options.help) {
     console.info(`
     Usage:
       b [package query words] - [command query words]
-      b cor - b t
+      b cor - build,test
 
       matches to:
-      (cd packages/core && yarn build:types)
+      (cd packages/core && yarn build && yarn test)
 
       Query words are substrings that match against the package name and npm scripts.
       The substrings must appear in order for a match.
       Match priority goes to whole-word matching and initial matching.
-
-    Options:
-      --dry
-        dry run with no command execution.
-      --help
-        show this message.
-      --c
-        ask for confirmation before executing command.
 `);
     return 0;
   }
@@ -65,6 +55,10 @@ async function main() {
   const separatorIndex = rest.indexOf("-") !== -1 ? rest.indexOf("-") : rest.length;
   const query = nonFlags.slice(0, separatorIndex);
   const commands = nonFlags.slice(separatorIndex + 1);
+  const multiCommands = commands
+    .join(" ")
+    .split(/,\s?/)
+    .map((c) => c.split(" "));
 
   const matchedPackages = findFolders(allPackages, ...query);
 
@@ -80,59 +74,42 @@ async function main() {
   );
 
   const [target] = matchedPackages;
-
   const targetPkgJson = require(path.join(target.location, "package.json"));
-  const matchedScripts = findScripts(Object.keys(targetPkgJson.scripts || {}), ...commands);
-  const [script] = matchedScripts;
-
-  if (commands.length === 0) {
-    console.info("No commands entered");
-    return 0;
-  }
 
-  if (matchedScripts.length === 0) {
-    console.error("No matching scripts for command query:", commands);
-    return 0;
-  }
+  for (const commands of multiCommands) {
+    const matchedScripts = findScripts(Object.keys(targetPkgJson.scripts || {}), ...commands);
 
-  console.log("commands:", ...commands);
-  console.log("matched commands:", matchedScripts);
+    if (commands.length === 0) {
+      console.info("No commands entered");
+      return 0;
+    }
 
-  const command = `yarn ${script} in ${target.location}`;
+    if (matchedScripts.length === 0) {
+      console.error("No matching scripts for command query:", commands);
+      return 0;
+    }
 
-  if (options.dry) {
-    console.log("DRYRUN:", command);
-    return 0;
+    console.log("commands:", ...commands);
+    console.log("matched commands:", matchedScripts);
   }
 
-  const execute = async () => {
-    const { spawnProcess } = require("../utils/spawn-process");
-    console.info("Running:", "yarn", script);
-    console.info("Location:", target.location);
-    await spawnProcess("yarn", [script], {
-      cwd: target.location,
-      stdio: "inherit",
-    });
-    return;
-  };
-
-  if (options.confirm) {
-    const rl = readline.createInterface({
-      input: process.stdin,
-      output: process.stdout,
-    });
-
-    rl.question(`run script "${script}" in ${target.location} (y)/n?:`, async (confirm) => {
-      if (confirm.toLowerCase().trim() === "y" || confirm === "") {
-        await execute();
-      }
-      rl.close();
-    });
-    return 0;
+  for (const commands of multiCommands) {
+    const matchedScripts = findScripts(Object.keys(targetPkgJson.scripts || {}), ...commands);
+    const [script] = matchedScripts;
+
+    const execute = async () => {
+      const { spawnProcess } = require("../utils/spawn-process");
+      console.info("Running:", "yarn", script);
+      console.info("Location:", target.location);
+      await spawnProcess("yarn", [script], {
+        cwd: target.location,
+        stdio: "inherit",
+      });
+    };
+
+    await execute();
   }
 
-  await execute();
-
   return 0;
 }
 

scripts/utils/list-folders.js

@@ -0,0 +1,25 @@
+const fs = require("node:fs");
+const path = require("node:path");
+
+/**
+ * @param dir - directory.
+ * @param basenameOnly - if true, return only the basename of the subdirectories
+ * @returns {string[]} list of full-paths of subdirectories (not files) in the given directory.
+ */
+function listFolders(dir, basenameOnly = true) {
+  const folders = [];
+  for (const fileSystemEntry of fs.readdirSync(dir, { withFileTypes: true })) {
+    if (fileSystemEntry.isDirectory()) {
+      if (basenameOnly) {
+        folders.push(fileSystemEntry.name);
+      } else {
+        folders.push(path.join(dir, fileSystemEntry.name));
+      }
+    }
+  }
+  return folders;
+}
+
+module.exports = {
+  listFolders,
+};