From 8ec2ae1c7f0bb0e29fc0e3b2003bfd5b1b6b896c Mon Sep 17 00:00:00 2001
From: Jake Chapman <jake.chapman@mark43.com>
Date: Thu, 12 Jan 2023 21:50:03 -0700
Subject: [PATCH] Added --silent flag to silence console logging.

---
 src/index.js      |  3 ++-
 src/index.test.js | 25 +++++++++++++++++++++++++
 src/run.js        | 25 ++++++++++++++++---------
 src/scanner.js    | 13 ++++++++-----
 4 files changed, 51 insertions(+), 15 deletions(-)

diff --git a/src/index.js b/src/index.js
index e3e2396..ecccc3e 100644
--- a/src/index.js
+++ b/src/index.js
@@ -6,12 +6,13 @@ const packageJson = require("../package.json");
 sade("react-scanner", true)
   .version(packageJson.version)
   .describe(packageJson.description)
+  .option("-s, --silent", "Silence logging")
   .option("-c, --config", "Path to config file")
   .example("-c /path/to/react-scanner.config.js")
   .action((options) => {
     const configPath = path.resolve(process.cwd(), options.config);
     const configDir = path.dirname(configPath);
     const config = require(configPath);
-    run(config, configDir, "cli");
+    run(config, configDir, "cli", options.silent);
   })
   .parse(process.argv);
diff --git a/src/index.test.js b/src/index.test.js
index 63158bc..25989f8 100644
--- a/src/index.test.js
+++ b/src/index.test.js
@@ -209,4 +209,29 @@ Index("no files found", async () => {
   }
 });
 
+Index("silent - no error", async () => {
+  const { exitCode, stdout } = await execa("./bin/react-scanner", [
+    "-c",
+    "./test/configs/noProcessors.config.js",
+    "--silent",
+  ]);
+  const { firstLine, restOutput } = parseStdout(stdout);
+  assert.is(exitCode, 0);
+  assert.ok(/^$/.test(firstLine));
+  assert.ok(/^$/, restOutput);
+});
+
+Index("silent - error", async () => {
+  try {
+    await execa("./bin/react-scanner", [
+      "-c",
+      "./test/configs/noFilesFound.config.js",
+      "--silent",
+    ]);
+  } catch ({ exitCode, stderr }) {
+    assert.is(exitCode, 1);
+    assert.is(stderr, "");
+  }
+});
+
 Index.run();
diff --git a/src/run.js b/src/run.js
index 11133fb..d04a7f2 100644
--- a/src/run.js
+++ b/src/run.js
@@ -19,6 +19,7 @@ async function run({
   crawlFrom,
   startTime,
   method = "cli",
+  silent,
 }) {
   const rootDir = config.rootDir || configDir;
   const globs = config.globs || DEFAULT_GLOBS;
@@ -30,7 +31,9 @@ async function run({
     .sync();
 
   if (files.length === 0) {
-    console.error(`No files found to scan.`);
+    if (!silent) {
+      console.error(`No files found to scan.`);
+    }
     process.exit(1);
   }
 
@@ -61,12 +64,14 @@ async function run({
 
   const endTime = process.hrtime.bigint();
 
-  // eslint-disable-next-line no-console
-  console.log(
-    `Scanned ${pluralize(files.length, "file")} in ${
-      Number(endTime - startTime) / 1e9
-    } seconds`
-  );
+  if (!silent) {
+    // eslint-disable-next-line no-console
+    console.log(
+      `Scanned ${pluralize(files.length, "file")} in ${
+        Number(endTime - startTime) / 1e9
+      } seconds`
+    );
+  }
 
   const processors =
     config.processors && config.processors.length > 0
@@ -82,8 +87,10 @@ async function run({
 
     switch (dest) {
       case "stdout": {
-        // eslint-disable-next-line no-console
-        console.log(dataStr);
+        if (!silent) {
+          // eslint-disable-next-line no-console
+          console.log(dataStr);
+        }
         break;
       }
       case "return": {
diff --git a/src/scanner.js b/src/scanner.js
index 328af81..d8852f1 100644
--- a/src/scanner.js
+++ b/src/scanner.js
@@ -4,7 +4,7 @@ const { validateConfig } = require("./utils");
 const runScan = require("./run");
 
 const scanner = {
-  run: async function run(config, configDir, method = "programmatic") {
+  run: async function run(config, configDir, method = "programmatic", silent) {
     const { crawlFrom, errors } = validateConfig(config, configDir);
 
     if (errors.length === 0) {
@@ -14,13 +14,16 @@ const scanner = {
         crawlFrom,
         startTime,
         method: method,
+        silent,
       });
     } else {
-      console.error(`Config errors:`);
+      if (!silent) {
+        console.error(`Config errors:`);
 
-      errors.forEach((error) => {
-        console.error(`- ${error}`);
-      });
+        errors.forEach((error) => {
+          console.error(`- ${error}`);
+        });
+      }
 
       process.exit(1);
     }