doc-detective 3.3.0 → 3.4.0-dev.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "doc-detective",
-  "version": "3.3.0",
+  "version": "3.4.0-dev.2",
   "description": "Treat doc content as testable assertions to validate doc accuracy and product UX.",
   "bin": {
     "doc-detective": "src/index.js"
@@ -33,14 +33,14 @@
   "homepage": "https://github.com/doc-detective/doc-detective#readme",
   "dependencies": {
     "@ffmpeg-installer/ffmpeg": "^1.1.0",
-    "doc-detective-common": "^3.3.0",
-    "doc-detective-core": "^3.3.0",
+    "doc-detective-common": "^3.4.0",
+    "doc-detective-core": "^3.4.0",
     "yargs": "^17.7.2"
   },
   "devDependencies": {
     "body-parser": "^2.2.0",
-    "chai": "^5.2.1",
+    "chai": "^6.2.0",
     "express": "^5.1.0",
-    "mocha": "^11.7.1"
+    "mocha": "^11.7.4"
   }
 }

package/src/utils.js

@@ -67,6 +67,31 @@ async function setConfig({ configPath, args }) {
     }
   }
 
+  // Check for DOC_DETECTIVE_CONFIG environment variable
+  if (process.env.DOC_DETECTIVE_CONFIG) {
+    try {
+      // Parse the environment variable as JSON
+      const envConfig = JSON.parse(process.env.DOC_DETECTIVE_CONFIG);
+      
+      // Validate the environment variable config
+      const envValidation = validate({
+        schemaKey: "config_v3",
+        object: envConfig,
+      });
+      
+      if (!envValidation.valid) {
+        console.error("Invalid config from DOC_DETECTIVE_CONFIG environment variable.", envValidation.errors);
+        process.exit(1);
+      }
+      
+      // Merge with file config, preferring environment variable config (use raw envConfig, not validated with defaults)
+      config = { ...config, ...envConfig };
+    } catch (error) {
+      console.error(`Error parsing DOC_DETECTIVE_CONFIG environment variable: ${error.message}`);
+      process.exit(1);
+    }
+  }
+
   // Validate config
   const validation = validate({
     schemaKey: "config_v3",

package/test/utils.test.js

@@ -204,6 +204,59 @@ describe("Util tests", function () {
     // Clean up
     fs.unlinkSync(outputResultsPath);
   });
+
+  // Test environment variable config detection
+  it("Config from DOC_DETECTIVE_CONFIG environment variable is loaded and merged", async function () {
+    this.timeout(5000);
+    
+    // Save the original environment variable value
+    const originalEnvConfig = process.env.DOC_DETECTIVE_CONFIG;
+    
+    try {
+      // Test 1: Valid environment variable config without file config
+      process.env.DOC_DETECTIVE_CONFIG = JSON.stringify({
+        logLevel: "debug"
+      });
+      
+      const config1 = await setConfig({ args: setArgs(["node", "runTests.js"]) });
+      expect(config1.logLevel).to.equal("debug");
+      
+      // Test 2: Environment variable config merged with file config (env var takes precedence)
+      process.env.DOC_DETECTIVE_CONFIG = JSON.stringify({
+        logLevel: "error"
+      });
+      
+      const config2 = await setConfig({ 
+        configPath: "./test/test-config.json",
+        args: setArgs(["node", "runTests.js", "--config", "./test/test-config.json"]) 
+      });
+      // Environment variable should override file config
+      expect(config2.logLevel).to.equal("error");
+      // Check that other values from file config are preserved
+      expect(config2.telemetry.send).to.equal(false);
+      
+      // Test 3: Environment variable config with command line args (args take precedence)
+      process.env.DOC_DETECTIVE_CONFIG = JSON.stringify({
+        logLevel: "warning",
+        input: "env-input.json"
+      });
+      
+      const config3 = await setConfig({ 
+        args: setArgs(["node", "runTests.js", "--input", "cli-input.json", "--logLevel", "debug"]) 
+      });
+      // Command line args should override environment variable
+      expect(config3.logLevel).to.equal("debug");
+      expect(config3.input).to.deep.equal([path.resolve(process.cwd(), "cli-input.json")]);
+      
+    } finally {
+      // Restore the original environment variable value
+      if (originalEnvConfig !== undefined) {
+        process.env.DOC_DETECTIVE_CONFIG = originalEnvConfig;
+      } else {
+        delete process.env.DOC_DETECTIVE_CONFIG;
+      }
+    }
+  });
 });
 
 // Deeply compares two objects