feat: Add new quiet option

PythonCoderAS · PythonCoderAS · commit fb6f95da17c2 · 2023-02-11T23:56:48.000-05:00
diff --git a/README.md b/README.md
@@ -23,7 +23,7 @@ Run a script on multiple repositories, cloning them if needed.
 The script gets run with additional environment variables.
 
 | Environment Variable Name | Description                                                                                         |
-|---------------------------|-----------------------------------------------------------------------------------------------------|
+| ------------------------- | --------------------------------------------------------------------------------------------------- |
 | `REPO_OWNER`              | The owner of the repository                                                                         |
 | `REPO_NAME`               | The name of the repository                                                                          |
 | `REPO`                    | The value of "`REPO_OWNER`/`REPO_NAME`"                                                             |
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -42,7 +42,7 @@
     "@types/chai": "^4.3.1",
     "@types/chai-as-promised": "^7.1.5",
     "@types/mocha": "^10.0.0",
-    "@types/node": "^18.0.0",
+    "@types/node": "^18.13.0",
     "chai": "^4.3.6",
     "chai-as-promised": "^7.1.1",
     "eslint": "^8.17.0",
diff --git a/src/cli.ts b/src/cli.ts
@@ -17,6 +17,11 @@ let cli = sade("github-run-script")
   )
   .option("-s, --search", "A path to search for already-cloned repositories.")
   .option("-t, --terminate", "Terminate any spawned processes on error.")
+  .option(
+    "-q",
+    "--quiet",
+    "Do not make any output that isn't from the invoked scripts."
+  )
   .option("--signal", "The signal to terminate a process with.")
   .action(handler);
 
diff --git a/src/handler.ts b/src/handler.ts
@@ -27,6 +27,7 @@ function terminateSpawnCache(signal: NodeJS.Signals = "SIGTERM") {
 export default async function handler(script: string, flags: CliFlags) {
   const { owner: defaultOwner, _: repoNames } = flags;
   let { search } = flags;
+  const quiet = !!flags.quiet;
   const repos: RepoOwner[] = [];
   for (const repoName of repoNames) {
     try {
@@ -74,7 +75,10 @@ export default async function handler(script: string, flags: CliFlags) {
         for (const [path, directories] of scanDirectories) {
           for (const directory of directories) {
             if (repo === directory) {
-              console.log(`Found ${repo} in ${path}`);
+              if (!quiet) {
+                console.log(`Found ${repo} in ${path}`);
+              }
+
               directoryMapping.set([owner, repo], `${path}/${repo}`);
               break;
             }
@@ -90,10 +94,18 @@ export default async function handler(script: string, flags: CliFlags) {
         // 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}`);
+          if (!quiet) {
+            console.log(`Cloning ${owner}/${repo} to ${destPath}`);
+          }
+
           const childProc = await spawn(
             "git",
-            ["clone", `https://github.com/${owner}/${repo}.git`, destPath],
+            [
+              "clone",
+              "-q",
+              `https://github.com/${owner}/${repo}.git`,
+              destPath,
+            ],
             { stdio: "inherit" }
           );
           await waitOnChildProcessToExit(childProc);
diff --git a/src/types.ts b/src/types.ts
@@ -6,6 +6,7 @@ export interface CliFlags extends BaseCliFlags {
   owner?: string;
   search?: string | string[];
   terminate?: string | boolean;
+  quiet?: string | boolean;
   signal?: string;
 }
 

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@ export interface CliFlags extends BaseCliFlags {`
`6`	`6`	`owner?: string;`
`7`	`7`	`search?: string \| string[];`
`8`	`8`	`terminate?: string \| boolean;`
	`9`	`+ quiet?: string \| boolean;`
`9`	`10`	`signal?: string;`
`10`	`11`	`}`
`11`	`12`