doc-detective 3.4.1-dev.1 → 3.5.0-dev.0

package/src/checkDependencies.js

@@ -1,84 +1,84 @@
-#!/usr/bin/env node
-
-const path = require("path");
-const fs = require("fs");
-const readline = require("readline");
-
-// Check if package.json exists, and if it's for doc-detective
-if (fs.existsSync(path.resolve(process.cwd(), "package.json"))) {
-  try {
-    const json = JSON.parse(
-      fs.readFileSync(path.resolve(process.cwd(), "package.json"))
-    );
-    if (json.name === "doc-detective") {
-      // Check if dependencies are installed
-      checkDependencies();
-    }
-  } catch (error) {
-    console.error(`Failed to parse package.json: ${error.message}`);
-  }
-}
-
-// Check if dependencies are installed
-function checkDependencies() {
-  if (!fs.existsSync(path.resolve(process.cwd(), "node_modules"))) {
-    const rl = readline.createInterface({
-      input: process.stdin,
-      output: process.stdout,
-    });
-
-    // Handle SIGINT (Ctrl+C)
-    rl.on('SIGINT', () => {
-      console.log('\nOperation cancelled by user');
-      rl.close();
-      process.exit(0);
-    });
-
-    rl.question(
-      "It looks like you haven't installed the local dependencies yet. Would you like to install them now? (yes/no): ",
-      (answer) => {
-        const normalizedAnswer = answer.toLowerCase().trim();
-        if (normalizedAnswer === "yes" || normalizedAnswer === "y") {
-          console.log("Installing dependencies. This may take a few minutes.");
-          const { spawn } = require("child_process");
-          const npmCmd = process.platform === 'win32' ? 'npm.cmd' : 'npm';
-          const install = spawn(npmCmd, ["install"], { 
-            stdio: "inherit",
-            shell: true 
-          });
-
-          // Set timeout
-          const timeout = setTimeout(() => {
-            console.error('Installation timed out after 5 minutes');
-            install.kill();
-            rl.close();
-          }, 5 * 60 * 1000);
-
-          install.on("close", (code) => {
-            clearTimeout(timeout);
-            if (code !== 0) {
-              console.error(
-                `Failed to install dependencies (exit code ${code}). Try running 'npm install' manually and check for errors.`
-              );
-              process.exit(1);
-            } else {
-              console.log("Dependencies installed successfully.");
-            }
-            rl.close();
-          });
-
-          install.on("error", (error) => {
-            clearTimeout(timeout);
-            console.error(`Failed to start 'npm install': ${error.message}`);
-            rl.close();
-            process.exit(1);
-          });
-        } else {
-          console.log("Dependencies not installed. Please run 'npm install' manually before proceeding.");
-          rl.close();
-          process.exit(1);
-        }
-      }
-    );
-  }
-}
+#!/usr/bin/env node
+
+const path = require("path");
+const fs = require("fs");
+const readline = require("readline");
+
+// Check if package.json exists, and if it's for doc-detective
+if (fs.existsSync(path.resolve(process.cwd(), "package.json"))) {
+  try {
+    const json = JSON.parse(
+      fs.readFileSync(path.resolve(process.cwd(), "package.json"))
+    );
+    if (json.name === "doc-detective") {
+      // Check if dependencies are installed
+      checkDependencies();
+    }
+  } catch (error) {
+    console.error(`Failed to parse package.json: ${error.message}`);
+  }
+}
+
+// Check if dependencies are installed
+function checkDependencies() {
+  if (!fs.existsSync(path.resolve(process.cwd(), "node_modules"))) {
+    const rl = readline.createInterface({
+      input: process.stdin,
+      output: process.stdout,
+    });
+
+    // Handle SIGINT (Ctrl+C)
+    rl.on('SIGINT', () => {
+      console.log('\nOperation cancelled by user');
+      rl.close();
+      process.exit(0);
+    });
+
+    rl.question(
+      "It looks like you haven't installed the local dependencies yet. Would you like to install them now? (yes/no): ",
+      (answer) => {
+        const normalizedAnswer = answer.toLowerCase().trim();
+        if (normalizedAnswer === "yes" || normalizedAnswer === "y") {
+          console.log("Installing dependencies. This may take a few minutes.");
+          const { spawn } = require("child_process");
+          const npmCmd = process.platform === 'win32' ? 'npm.cmd' : 'npm';
+          const install = spawn(npmCmd, ["install"], { 
+            stdio: "inherit",
+            shell: true 
+          });
+
+          // Set timeout
+          const timeout = setTimeout(() => {
+            console.error('Installation timed out after 5 minutes');
+            install.kill();
+            rl.close();
+          }, 5 * 60 * 1000);
+
+          install.on("close", (code) => {
+            clearTimeout(timeout);
+            if (code !== 0) {
+              console.error(
+                `Failed to install dependencies (exit code ${code}). Try running 'npm install' manually and check for errors.`
+              );
+              process.exit(1);
+            } else {
+              console.log("Dependencies installed successfully.");
+            }
+            rl.close();
+          });
+
+          install.on("error", (error) => {
+            clearTimeout(timeout);
+            console.error(`Failed to start 'npm install': ${error.message}`);
+            rl.close();
+            process.exit(1);
+          });
+        } else {
+          console.log("Dependencies not installed. Please run 'npm install' manually before proceeding.");
+          rl.close();
+          process.exit(1);
+        }
+      }
+    );
+  }
+}

package/src/index.js

@@ -1,72 +1,72 @@
-#!/usr/bin/env node
-
-const { runTests } = require("doc-detective-core");
-const {
-  setArgs,
-  setConfig,
-  outputResults,
-  setMeta,
-  getVersionData,
-  log,
-  getResolvedTestsFromEnv,
-  reportResults,
-} = require("./utils");
-const { argv } = require("node:process");
-const path = require("path");
-const fs = require("fs");
-
-// Run
-setMeta();
-main(argv);
-
-// Run
-async function main(argv) {
-  // Find index of `doc-detective` or `run` in argv
-  const index = argv.findIndex(
-    (arg) => arg.endsWith("doc-detective") || arg.endsWith("index.js")
-  );
-  // Set args
-  argv = setArgs(argv);
-
-  // Get .doc-detective JSON or YAML config, if it exists, preferring a config arg if provided
-  const configPathJSON = path.resolve(process.cwd(), ".doc-detective.json");
-  const configPathYAML = path.resolve(process.cwd(), ".doc-detective.yaml");
-  const configPathYML = path.resolve(process.cwd(), ".doc-detective.yml");
-  const configPath = fs.existsSync(argv.config)
-    ? argv.config
-    : fs.existsSync(configPathJSON)
-    ? configPathJSON
-    : fs.existsSync(configPathYAML)
-    ? configPathYAML
-    : fs.existsSync(configPathYML)
-    ? configPathYML
-    : null;
-
-  // Set config
-  const config = await setConfig({ configPath: configPath, args: argv });
-
-  log(
-    `CLI:VERSION INFO:\n${JSON.stringify(getVersionData(), null, 2)}`,
-    "debug",
-    config
-  );
-  log(`CLI:CONFIG:\n${JSON.stringify(config, null, 2)}`, "debug", config);
-
-  // Check for DOC_DETECTIVE_API environment variable
-  let api = await getResolvedTestsFromEnv(config);
-  let resolvedTests = api?.resolvedTests || null;
-  let apiConfig = api?.apiConfig || null;
-
-  // Run tests
-  const output = config.output;
-  const results = resolvedTests
-    ? await runTests(config, { resolvedTests })
-    : await runTests(config);
-
-  if (apiConfig) {
-    await reportResults({ apiConfig, results });
-  } else {
-    // Output results
-    await outputResults(config, output, results, { command: "runTests" });
-  }
-}
+#!/usr/bin/env node
+
+const { runTests } = require("doc-detective-core");
+const {
+  setArgs,
+  setConfig,
+  outputResults,
+  setMeta,
+  getVersionData,
+  log,
+  getResolvedTestsFromEnv,
+  reportResults,
+} = require("./utils");
+const { argv } = require("node:process");
+const path = require("path");
+const fs = require("fs");
+
+// Run
+setMeta();
+main(argv);
+
+// Run
+async function main(argv) {
+  // Find index of `doc-detective` or `run` in argv
+  const index = argv.findIndex(
+    (arg) => arg.endsWith("doc-detective") || arg.endsWith("index.js")
+  );
+  // Set args
+  argv = setArgs(argv);
+
+  // Get .doc-detective JSON or YAML config, if it exists, preferring a config arg if provided
+  const configPathJSON = path.resolve(process.cwd(), ".doc-detective.json");
+  const configPathYAML = path.resolve(process.cwd(), ".doc-detective.yaml");
+  const configPathYML = path.resolve(process.cwd(), ".doc-detective.yml");
+  const configPath = fs.existsSync(argv.config)
+    ? argv.config
+    : fs.existsSync(configPathJSON)
+    ? configPathJSON
+    : fs.existsSync(configPathYAML)
+    ? configPathYAML
+    : fs.existsSync(configPathYML)
+    ? configPathYML
+    : null;
+
+  // Set config
+  const config = await setConfig({ configPath: configPath, args: argv });
+
+  log(
+    `CLI:VERSION INFO:\n${JSON.stringify(getVersionData(), null, 2)}`,
+    "debug",
+    config
+  );
+  log(`CLI:CONFIG:\n${JSON.stringify(config, null, 2)}`, "debug", config);
+
+  // Check for DOC_DETECTIVE_API environment variable
+  let api = await getResolvedTestsFromEnv(config);
+  let resolvedTests = api?.resolvedTests || null;
+  let apiConfig = api?.apiConfig || null;
+
+  // Run tests
+  const output = config.output;
+  const results = resolvedTests
+    ? await runTests(config, { resolvedTests })
+    : await runTests(config);
+
+  if (apiConfig) {
+    await reportResults({ apiConfig, results });
+  } else {
+    // Output results
+    await outputResults(config, output, results, { command: "runTests" });
+  }
+}