Actual CLI stuff

Author: PythonCoderAS

README.md

@@ -1,11 +1,2 @@
-# typescript-project-template
-Template repo for new TypeScript projects.
-
-This repo assumes the following:
-
-* Source code lives in the `src` directory.
-* The main export is located in `src/index.ts`.
-* Tests live in the `test` directory.
-* Each test is name `<name>.test.ts`.
-* The `npm_token`, `app_id`, and `app_private_key` secrets are present in the repo.
-* The code will be a CommonJS module.
+# github-run-script
+Run a script on multiple repositories, cloning them if needed.

package-lock.json

@@ -1,7 +1,7 @@
 {
-  "name": "<package-name>",
+  "name": "github-run-script",
   "version": "1.0.0",
-  "description": "<package-description>",
+  "description": "Run a script on multiple repositories, cloning them if needed.",
   "main": "dist/index.js",
   "type": "commonjs",
   "types": "dist/index.d.ts",
@@ -16,16 +16,19 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/PythonCoderAS/<package-name>.git"
+    "url": "git+https://github.com/PythonCoderAS/github-run-script.git"
   },
   "keywords": [],
   "author": "PythonCoderAS",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/PythonCoderAS/<package-name>/issues"
+    "url": "https://github.com/PythonCoderAS/github-run-script/issues"
   },
-  "homepage": "https://github.com/PythonCoderAS/<package-name>#readme",
+  "homepage": "https://github.com/PythonCoderAS/github-run-script#readme",
   "dependencies": {
+    "array-string-map": "^3.0.0",
+    "node-filter-async": "^2.0.0",
+    "sade": "^1.8.1"
   },
   "devDependencies": {
     "@types/chai": "^4.3.1",

package.json

@@ -0,0 +1,20 @@
+import * as sade from "sade";
+import handler from "./handler";
+
+// eslint-disable-next-line @typescript-eslint/no-var-requires -- Needed in order to not copy over package.json and make new src directory inside of dist
+const { version, description } = require("../package.json");
+
+const cli = sade("github-run-script <script>", true)
+  .version(version)
+  .describe(description)
+  .option(
+    "-o, --owner",
+    "The owner for repositories without an explicit owner."
+  )
+  .option(
+    "-s, --search-path",
+    "A path to search for already-cloned repositories."
+  )
+  .action(handler);
+
+export default cli;

src/cli.ts

@@ -0,0 +1,97 @@
+import { mkdtemp, readdir, stat, rm } from "fs/promises";
+import { spawn } from "child_process";
+import { CliFlags, RepoOwner } from "./types";
+import { getRepoAndOwner, waitOnChildProcessToExit } from "./utils";
+import ArrayStringMap from "array-string-map";
+import filterAsync from "node-filter-async";
+import { tmpdir } from "os";
+
+export default async function handler(script: string, flags: CliFlags) {
+  console.log(script, flags);
+  const { owner: defaultOwner, _: repoNames } = flags;
+  const repos: RepoOwner[] = [];
+  for (const repoName of repoNames) {
+    try {
+      const [owner, repo] = getRepoAndOwner(repoName, defaultOwner);
+      repos.push([owner, repo]);
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any -- We need the `message` attribute.
+    } catch (e: any) {
+      console.error(e.message);
+      process.exit(1);
+    }
+  }
+  const tempDir = await mkdtemp(`${tmpdir()}/github-run-script-`);
+  try {
+    const directoryMapping: ArrayStringMap<RepoOwner, string> =
+      new ArrayStringMap();
+    const scanDirectories: Map<string, string[]> = new Map();
+    if (flags.searchPath) {
+      // If it's one path, it won't be in an array. This converts it into an array.
+      if (typeof flags.searchPath === "string") {
+        flags.searchPath = [flags.searchPath];
+      }
+      // What this code block does is simple. It stores in `scanDirectories`
+      // a mapping of source path name to an array of directories in that directory.
+      await Promise.all(
+        flags.searchPath.map(async (path) => {
+          scanDirectories.set(
+            path,
+            await filterAsync(await readdir(path), async (item) => {
+              return (await stat(`${path}/${item}`)).isDirectory();
+            })
+          );
+        })
+      );
+    }
+    await Promise.all(
+      repos.map(async ([owner, repo]) => {
+        // First, we need to check if the repository exists in `scanDirectories`.
+        // TODO: Handle cases where the same repo is present multiple times in
+        // TODO: different directories, or if two repos with the same name but
+        // TODO: different owners is provided. (Maybe we can check `.git`.)
+        for (const [path, directories] of scanDirectories) {
+          for (const directory of directories) {
+            if (repo === directory) {
+              directoryMapping.set([owner, repo], path);
+              break;
+            }
+          }
+          // If we already found a match earlier, no need to re-iterate over the other
+          // directories.
+          if (directoryMapping.has([owner, repo])) {
+            break;
+          }
+        }
+        // Deal wit the special case where we did not find a match. Time to clone.
+        if (!directoryMapping.has([owner, repo])) {
+          const destPath = `${tempDir}/${repo}`;
+          console.log(`Cloning ${owner}/${repo} to ${destPath}`);
+          const childProc = await spawn(
+            "git",
+            ["clone", `https://github.com/${owner}/${repo}.git`, destPath],
+            { stdio: "inherit" }
+          );
+          await waitOnChildProcessToExit(childProc);
+          directoryMapping.set([owner, repo], destPath);
+        }
+        // Time to execute the script!
+        const path = directoryMapping.get([owner, repo]);
+        const childProc = await spawn(script, [], {
+          cwd: path,
+          env: {
+            ...process.env,
+            REPO_OWNER: owner,
+            REPO_NAME: repo,
+            REPO: `${owner}/${repo}`,
+            REPO_PATH: path,
+          },
+          stdio: "inherit",
+        });
+        await waitOnChildProcessToExit(childProc);
+      })
+    );
+  } finally {
+    // We need to clean up the temporary directory.
+    await rm(tempDir, { recursive: true, force: true });
+  }
+}

src/handler.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import cli from "./cli";
+
+cli.parse(process.argv);

src/index.ts

@@ -0,0 +1,10 @@
+export interface CliFlags {
+  owner?: string;
+  searchPath?: string | string[];
+  _: string[];
+}
+
+/**
+ * A two-element tuple that contains [owner, repository].
+ */
+export type RepoOwner = [string, string];

src/types.ts

@@ -0,0 +1,30 @@
+import { RepoOwner } from "./types";
+import { ChildProcess } from "child_process";
+
+export function getRepoAndOwner(
+  input: string,
+  defaultOwner?: string
+): RepoOwner {
+  let [owner, repo] = input.split("/");
+  if (!repo) {
+    // This means that there was no slash, so we need to do some reassignments.
+    repo = owner;
+
+    if (!defaultOwner) {
+      throw new Error(
+        `${input}: No owner specified and no default owner was provided.`
+      );
+    }
+
+    owner = defaultOwner;
+  }
+
+  return [owner, repo];
+}
+
+export async function waitOnChildProcessToExit(process: ChildProcess) {
+  return new Promise((resolve, reject) => {
+    process.on("exit", resolve);
+    process.on("error", reject);
+  });
+}