feat: prompt for repositories if --octoherd-repositories was not used (#34)

Author: gr2m

README.md

@@ -5,29 +5,33 @@
 ## Usage
 
 ```
-Usage: octoherd run [options] [script] [repos...]
-
-Positionals:
-  script  Path to *.js script. Must be an ES Module.
-  repos   One or multiple arrays in the form of 'repo-owner/repo-name'.
-          'repo-owner/*' will find all repositories for one owner. '*' will find
-          all repositories the user has access to          [array] [default: []]
+Usage: octoherd run -S path/to/script.js [options]
 
 Options:
-  --help                      Show help                                [boolean]
-  --version                   Show version number                      [boolean]
-  --octoherd-token            Requires the "public_repo" scope for public
-                              repositories, "repo" scope for private
-                              repositories.                  [string] [required]
-  --octoherd-cache            Cache responses for debugging. Creates a ./cache
-                              folder if flag is set. Override by passing custom
-                              path                                      [string]
-  --octoherd-debug            Show debug logs         [boolean] [default: false]
-  --octoherd-bypass-confirms  Bypass prompts to confirm mutating requests
-                                                      [boolean] [default: false]
+      --help                      Show help                                            [boolean]
+  -S, --octoherd-script           Path to *.js script. Must be an ES Module. [string] [required]
+  -T, --octoherd-token            Requires the "public_repo" scope for public repositories, "rep
+                                  o" scope for private repositories. Creates an OAuth token if n
+                                  ot set.                                               [string]
+  -R, --octoherd-repos            One or multiple repositories in the form of 'repo-owner/repo-n
+                                  ame'. 'repo-owner/*' will find all repositories for one owner.
+                                   '*' will find all repositories the user has access to. Will p
+                                  rompt for repositories if not set.                     [array]
+      --octoherd-cache            Cache responses for debugging. Creates a ./cache folder if fla
+                                  g is set. Override by passing custom path             [string]
+      --octoherd-debug            Show debug logs                     [boolean] [default: false]
+      --octoherd-bypass-confirms  Bypass prompts to confirm mutating requests
+                                                                      [boolean] [default: false]
+      --version                   Show version number                                  [boolean]
 
 Examples:
-  octoherd run --octoherd-token $TOKEN path/to/script.js octoherd/cli
+  octoherd run -S path/to/script.js                 Minimal usage example
+  octoherd run -S path/to/script.js -T $TOKEN  -R   Pass token and repos as CLI flags
+  octoherd/cli
+  octoherd run -S path/to/script.js -T $TOKEN  -R   Avoid prompts for token and repos
+  octoherd/cli
+  octoherd run -S path/to/script.js -T $TOKEN  -R   Avoid any prompts
+  octoherd/cli --octoherd-bypass-confirms
 ```
 
 The `script` must export a `script` function which takes three parameters:

bin/commands/run.js

@@ -12,24 +12,23 @@ Node.js:           ${process.version}, ${process.platform} ${process.arch}`.trim
 
 /** @type { {[key: string]: import("yargs").Options} } */
 const options = {
-  "octoherd-token": {
-    description:
-      'Requires the "public_repo" scope for public repositories, "repo" scope for private repositories.',
-    type: "string",
-    alias: "T",
-  },
   "octoherd-script": {
     description: "Path to *.js script. Must be an ES Module.",
     demandOption: true,
     type: "string",
     alias: "S",
   },
+  "octoherd-token": {
+    description:
+      'Requires the "public_repo" scope for public repositories, "repo" scope for private repositories. Creates an OAuth token if not set.',
+    type: "string",
+    alias: "T",
+  },
   "octoherd-repos": {
     description:
-      "One or multiple repositories in the form of 'repo-owner/repo-name'. 'repo-owner/*' will find all repositories for one owner. '*' will find all repositories the user has access to",
+      "One or multiple repositories in the form of 'repo-owner/repo-name'. 'repo-owner/*' will find all repositories for one owner. '*' will find all repositories the user has access to. Will prompt for repositories if not set.",
     type: "string",
     array: true,
-    demandOption: true,
     alias: "R",
   },
   "octoherd-cache": {
@@ -55,8 +54,23 @@ const runCommand = {
   describe: "",
   builder: (yargs) =>
     yargs
-      .usage("Usage: $0 run [options]")
-      .example("$0 run -T $TOKEN -S path/to/script.js -R octoherd/cli", "")
+      .wrap(96)
+      .usage("Usage: octoherd run -S path/to/script.js [options]")
+      .example([
+        ["octoherd run -S path/to/script.js", "Minimal usage example"],
+        [
+          "octoherd run -S path/to/script.js -T $TOKEN  -R octoherd/cli",
+          "Pass token and repos as CLI flags",
+        ],
+        [
+          "octoherd run -S path/to/script.js -T $TOKEN  -R octoherd/cli",
+          "Avoid prompts for token and repos",
+        ],
+        [
+          "octoherd run -S path/to/script.js -T $TOKEN  -R octoherd/cli --octoherd-bypass-confirms",
+          "Avoid any prompts",
+        ],
+      ])
       .options(options)
       .version(VERSIONS)
       .coerce("octoherd-script", async (script) => {

index.js

@@ -10,7 +10,7 @@ import enquirer from "enquirer";
 import { cache as octokitCachePlugin } from "./lib/octokit-plugin-cache.js";
 import { requestLog } from "./lib/octokit-plugin-request-log.js";
 import { requestConfirm } from "./lib/octokit-plugin-request-confirm.js";
-import { resolveRepositories } from "./lib/resolve-repositories.js";
+import { runScriptAgainstRepositories } from "./lib/run-script-against-repositories.js";
 import { VERSION } from "./version.js";
 
 const levelColor = {
@@ -29,15 +29,10 @@ const levelColor = {
  * @param {string} options.octoherdToken Personal Access Token: Requires the "public_repo" scope for public repositories, "repo" scope for private repositories.
  * @param {boolean} options.octoherdCache Array of repository names in the form of "repo-owner/repo-name". To match all repositories for an owner, pass "repo-owner/*"
  */
-export async function octoherd(
-  options = {
-    octoherdCache: false,
-    octoherdRepos: [],
-  }
-) {
+export async function octoherd(options) {
   const {
     octoherdToken,
-    octoherdCache,
+    octoherdCache = false,
     octoherdDebug,
     octoherdScript,
     octoherdRepos,
@@ -110,43 +105,19 @@ export async function octoherd(
     },
   });
 
-  if (octoherdRepos.length === 0) {
-    throw new Error("[octoherd] No repositories provided");
-  }
-
   // trigger OAuth Device Flow before loading repositories
   // It's not necessary, but a better UX
   await octokit.auth({ type: "oauth-user" });
 
   const state = {
     log: console,
     octokit,
+    script: octoherdScript,
+    userOptions,
+    octoherdReposPassedAsFlag: !!octoherdRepos,
   };
 
-  try {
-    octokit.log.info("Loading repositories ...");
-    const repositories = await resolveRepositories(state, octoherdRepos);
-
-    for (const repository of repositories) {
-      octokit.log.info(
-        { octoherd: true },
-        "Running on %s ...",
-        repository.full_name
-      );
-
-      try {
-        const { id, owner, name } = repository;
-        octokit.log.setContext({ repository: { id, owner, name } });
-        await octoherdScript(octokit, repository, userOptions);
-      } catch (error) {
-        if (!error.cancel) throw error;
-        octokit.log.debug(error.message);
-      }
-    }
-  } catch (error) {
-    octokit.log.error(error);
-    process.exitCode = 1;
-  }
+  await runScriptAgainstRepositories(state, octoherdRepos);
 
   console.log("");
   console.log(chalk.gray("-".repeat(80)));

lib/resolve-repositories.js

@@ -20,11 +20,17 @@ export async function resolveRepositories(state, repositories) {
 
   for (const name of repositoriesWithoutStars) {
     const [owner, repo] = name.split("/");
-    const { data } = await state.octokit.request("/repos/{owner}/{repo}", {
-      owner,
-      repo,
-    });
-    resolvedRepositories.push(data);
+    try {
+      const { data } = await state.octokit.request("/repos/{owner}/{repo}", {
+        owner,
+        repo,
+      });
+      resolvedRepositories.push(data);
+    } catch (error) {
+      if (error.status !== 404) throw error;
+
+      state.octokit.log.warn(`Repository ${owner}/${repo} could not be found`);
+    }
     process.stdout.write(".");
   }
 

lib/run-script-against-repositories.js

@@ -0,0 +1,71 @@
+import enquirer from "enquirer";
+import chalk from "chalk";
+
+import { resolveRepositories } from "./resolve-repositories.js";
+
+export async function runScriptAgainstRepositories(state, octoherdRepos = []) {
+  if (!state.octoherdReposPassedAsFlag) {
+    console.log("");
+    const prompt = new enquirer.List({
+      message: "Enter repositories",
+      separator: / +/,
+      hint:
+        "e.g. octoherd/cli. Use a * to load all repositories for an owner, e.g. octoherd/*. Enter nothing to exit",
+      validate(input) {
+        const values = typeof input === "string" ? [input] : input;
+
+        const invalid = values.find(
+          (value) =>
+            !/^([a-z0-9_.-]+\/([a-z0-9_.-]+|\*)|\*)$/.test(value.trim())
+        );
+
+        if (!invalid) return true;
+
+        return (
+          chalk.red(`"${invalid}" is not a valid repository name.`) +
+          chalk.gray(" The format is <owner>/<repo>")
+        );
+      },
+    });
+
+    octoherdRepos = await prompt.run();
+
+    if (!state.reposNoticeShown) {
+      console.log(
+        `${chalk.gray(
+          "To avoid this prompt in future, pass repositories with --octoherd-repos or -R"
+        )}\n`
+      );
+    }
+    state.reposNoticeShown = true;
+  }
+
+  if (octoherdRepos.length === 0) return;
+
+  try {
+    state.octokit.log.info("Loading repositories ...");
+    const repositories = await resolveRepositories(state, octoherdRepos);
+
+    for (const repository of repositories) {
+      state.octokit.log.info(
+        { octoherd: true },
+        "Running on %s ...",
+        repository.full_name
+      );
+
+      try {
+        const { id, owner, name } = repository;
+        state.octokit.log.setContext({ repository: { id, owner, name } });
+        await state.script(state.octokit, repository, state.userOptions);
+      } catch (error) {
+        if (!error.cancel) throw error;
+        state.octokit.log.debug(error.message);
+      }
+    }
+  } catch (error) {
+    state.octokit.log.error(error);
+    process.exitCode = 1;
+  }
+
+  await runScriptAgainstRepositories(state);
+}