doc-detective 2.15.1 → 2.16.0

package/.github/workflows/npm-publish.yml

@@ -20,48 +20,38 @@ jobs:
         node: 
           - 18
           - 20
+          - 22
     steps:
-      - uses: actions/checkout@v3
-
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
-
-      - name: Cache node_modules
-        uses: actions/cache@v3
-        with:
-          # Cache key uses the contents of `package-lock.json` to identify unique cache
-          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.OS }}-node-
-          path: |
-            node_modules
-          
       - run: npm ci
-
       - run: npm test
 
   publish-npm:
     needs: build
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
           registry-url: https://registry.npmjs.org/
-
-      - name: Cache node_modules
-        uses: actions/cache@v3
-        with:
-          # Cache key uses the contents of `package-lock.json` to identify unique cache
-          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.OS }}-node-
-          path: |
-            node_modules
-            
       - run: npm ci
       - run: npm publish
         env:
           NODE_AUTH_TOKEN: ${{secrets.npm_token}}
+
+  # Test downstream consumers of the package
+  test-github-action:
+    name: Test GitHub Action
+    needs: publish-npm
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: doc-detective/github-action@latest
+        id: dd
+        with:
+          config: ./test/artifacts/config.json
+          input: ./test/artifacts/doc-content.md
+          exit_on_fail: "true"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "doc-detective",
-  "version": "2.15.1",
+  "version": "2.16.0",
   "description": "Treat doc content as testable assertions to validate doc accuracy and product UX.",
   "bin": {
     "doc-detective": "src/index.js"
@@ -32,8 +32,8 @@
   "homepage": "https://github.com/doc-detective/doc-detective#readme",
   "dependencies": {
     "@ffmpeg-installer/ffmpeg": "^1.1.0",
-    "doc-detective-common": "^1.18.2",
-    "doc-detective-core": "^2.15.1",
+    "doc-detective-common": "^1.19.1",
+    "doc-detective-core": "^2.16.0",
     "prompt-sync": "^4.2.0",
     "yargs": "^17.7.2"
   },

package/src/index.js

@@ -39,7 +39,7 @@ async function main(argv) {
     config = require(configPath);
   }
   // Set config
-  config = setConfig(config, argv);
+  config = await setConfig(config, argv);
   command = command || config.defaultCommand;
   // If no command, prompt user to select a command
   if (command !== "runTests" && command !== "runCoverage") {

package/src/utils.js

@@ -1,6 +1,6 @@
 const yargs = require("yargs/yargs");
 const { hideBin } = require("yargs/helpers");
-const { validate } = require("doc-detective-common");
+const { validate, resolvePaths } = require("doc-detective-common");
 const path = require("path");
 const fs = require("fs");
 const { spawn } = require("child_process");
@@ -62,7 +62,7 @@ function setArgs(args) {
 }
 
 // Override config values based on args
-function setConfig(config, args) {
+async function setConfig(config, args) {
   // If no args, return config
   if (!args) return config;
 
@@ -74,6 +74,7 @@ function setConfig(config, args) {
     const validation = validate("config_v2", configContent);
     if (validation.valid) {
       config = configContent;
+      config = await resolvePaths(config, config, configPath);
     } else {
       // Output validation errors
       console.error("Invalid config file:");
@@ -85,17 +86,32 @@ function setConfig(config, args) {
   }
 
   // Override config values
-  if (args.input) config.input = args.input;
-  if (args.output) config.output = args.output;
-  if (args.recursive) config.recursive = args.recursive;
-  if (args.logLevel) config.logLevel = args.logLevel;
   if (
     (args.setup || args.cleanup || args.input || args.output) &&
     !config.runTests
   )
     config.runTests = {};
-  if (args.input) config.runTests.input = args.input;
-  if (args.output) config.runTests.output = args.output;
+  if (
+    (args.setup || args.cleanup || args.input || args.output) &&
+    !config.runCoverage
+  )
+    config.runCoverage = {};
+  if (args.input) {
+    config.input = args.input;
+    config.runCoverage.input = args.input;
+    config.runTests.input = args.input;
+  }
+  if (args.output) {
+    config.output = args.output;
+    config.runCoverage.output = args.output;
+    config.runTests.output = args.output;
+  }
+  if (args.recursive) {
+    config.recursive = args.recursive;
+    config.runCoverage.recursive = args.recursive;
+    config.runTests.recursive = args.recursive;
+  }
+  if (args.logLevel) config.logLevel = args.logLevel;
   if (args.setup) config.runTests.setup = args.setup;
   if (args.cleanup) config.runTests.cleanup = args.cleanup;
 
@@ -117,7 +133,7 @@ async function outputResults(config = {}, outputPath, results, options = {}) {
   // DEBUG
   // outputPath = "./foobar/results.json";
   // END DEBUG
-  
+
   // Define supported output extensions
   const outputExtensions = [".json"];
 

package/test/artifacts/config.json

@@ -3,9 +3,10 @@
   "input": ".",
   "output": ".",
   "recursive": true,
+  "relativePathBase": "file",
   "logLevel": "debug",
   "runTests": {
-    "input": "./test/artifacts/test.spec.json",
+    "input": "test.spec.json",
     "output": ".",
     "setup": "",
     "cleanup": "",

package/test/artifacts/httpRequest.spec.json

@@ -8,7 +8,7 @@
       "steps": [
         {
           "action": "setVariables",
-          "path": "test/artifacts/env"
+          "path": "env"
         },
         {
           "action": "httpRequest",

package/test/artifacts/test.spec.json

@@ -4,8 +4,8 @@
     {
       "id": "Do all the things! - Test",
       "description": "This test includes nearly every property across all actions.",
-      "setup": "test/artifacts/setup.spec.json",
-      "cleanup": "test/artifacts/cleanup.spec.json",
+      "setup": "setup.spec.json",
+      "cleanup": "cleanup.spec.json",
       "steps": [
         {
           "action": "setVariables",

package/test/runCoverage.test.js

@@ -1,23 +1,19 @@
 const path = require("path");
-const { spawnCommand } = require(path.resolve(__dirname,"../src/utils"));
+const { spawnCommand } = require(path.resolve(__dirname, "../src/utils"));
 const assert = require("assert").strict;
 const fs = require("fs");
-const artifactPath = path.resolve(__dirname,"./artifacts");
+const artifactPath = path.resolve(__dirname, "./artifacts");
+const outputFile = path.resolve(`${artifactPath}/coverageResults.json`);
 
 describe("Perform coverage analysis successfully", function () {
   // Set indefinite timeout
   this.timeout(0);
   it("Should have 6 covered and 0 uncovered", async () => {
-    const coverateResults = await spawnCommand(`node ./src/index.js runCoverage -c ${artifactPath}/config.json -i ${artifactPath}/doc-content.md -o ${artifactPath}`);
-    // Find output file
-    // console.log(coverateResults.stdout)
-    const outputFiles = coverateResults.stdout.split("See results at ");
-    const outputFile = outputFiles[outputFiles.length - 1].trim();
-    // If output file is not found, throw an error 
-    if (!outputFile) {
-      throw new Error(`Output file not found.\nOutput file: ${outputFile}\nCWD: ${process.cwd()}\nstdout: ${coverateResults.stdout}`);
-    }
+    await spawnCommand(
+      `node ./src/index.js runCoverage -c ${artifactPath}/config.json -i ${artifactPath}/doc-content.md -o ${outputFile}`
+    );
     const result = require(outputFile);
+    fs.unlinkSync(outputFile);
     assert.equal(result.summary.covered, 6);
     assert.equal(result.summary.uncovered, 0);
   });

package/test/runTests.test.js

@@ -1,29 +1,19 @@
 const path = require("path");
-const { spawnCommand } = require(path.resolve(__dirname,"../src/utils"));
+const { spawnCommand } = require(path.resolve(__dirname, "../src/utils"));
 const assert = require("assert").strict;
 const fs = require("fs");
-const artifactPath = path.resolve(__dirname,"./artifacts");
+const artifactPath = path.resolve(__dirname, "./artifacts");
+const outputFile = path.resolve(`${artifactPath}/testResults.json`);
 
 describe("Run tests sucessfully", function () {
   // Set indefinite timeout
   this.timeout(0);
   it("All specs pass", async () => {
-    const runTests = await spawnCommand(
-      `node ./src/index.js runTests -c ${artifactPath}/config.json -i ${artifactPath} -o ${artifactPath}`
-    );
-    // Find output file
-    console.log(runTests.stdout)
-    const outputFiles = runTests.stdout.split("See results at ");
-    const outputFile = outputFiles[outputFiles.length - 1].trim();
-    console.log(outputFile);
-    console.log(fs.existsSync(outputFile));
-    // If output file is not found, throw an error
-    if (!outputFile) {
-      throw new Error(`Output file not found.\nOutput file: ${outputFile}\nCWD: ${process.cwd()}\nstdout: ${runTests.stdout}`);
-    }
-    const result = JSON.parse(
-      fs.readFileSync(outputFile, { encoding: "utf8" })
+    await spawnCommand(
+      `node ./src/index.js runTests -c ${artifactPath}/config.json -i ${artifactPath} -o ${outputFile}`
     );
+    const result = require(outputFile);
+    fs.unlinkSync(outputFile);
     assert.equal(result.summary.specs.fail, 0);
   });
 });

package/test/utils.test.js

@@ -170,8 +170,8 @@ describe("Util tests", function () {
       },
     ];
 
-    configSets.forEach((configSet) => {
-      const configResult = setConfig({}, setArgs(configSet.args));
+    configSets.forEach(async (configSet) => {
+      const configResult = await setConfig({}, setArgs(configSet.args));
       deepObjectExpect(configResult, configSet.expected);
     });
   });

package/.github/workflows/docker-image.yml

@@ -1,19 +0,0 @@
-name: Docker Image CI
-
-on:
-  push:
-    branches: [ "main" ]
-  pull_request:
-    branches: [ "main" ]
-  workflow_dispatch:
-
-jobs:
-
-  build:
-
-    runs-on: macos-latest
-
-    steps:
-    - uses: actions/checkout@v3
-    - name: Build the Docker image
-      run: npm run docker:build:multiarch