doc-detective 2.15.1-docker.0 → 2.16.0-dev.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-docker.0",
+  "version": "2.16.0-dev.0",
   "description": "Treat doc content as testable assertions to validate doc accuracy and product UX.",
   "bin": {
     "doc-detective": "src/index.js"
@@ -11,8 +11,6 @@
     "test": "mocha test/*.test.js",
     "runTests": "node ./src/index.js runTests",
     "runCoverage": "node ./src/index.js runCoverage",
-    "docker:build":"docker build --load -t hawkeyexl/doc-detective:dev .",
-    "docker:push": "docker push hawkeyexl/doc-detective:dev",
     "dev": "node ./dev"
   },
   "repository": {
@@ -34,13 +32,13 @@
   "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-docker.0",
+    "doc-detective-common": "^1.19.1-dev.0",
+    "doc-detective-core": "^2.16.0-dev.0",
     "prompt-sync": "^4.2.0",
     "yargs": "^17.7.2"
   },
   "devDependencies": {
     "chai": "^5.1.1",
-    "mocha": "^10.6.0"
+    "mocha": "^10.7.0"
   }
 }

package/samples/.doc-detective.json

@@ -19,7 +19,7 @@
         "app": {
           "name": "chrome",
           "options": {
-            "headless": true
+            "headless": false
           }
         },
         "platforms": ["windows", "mac", "linux"]

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:");

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/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/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/.dockerignore

@@ -1,7 +0,0 @@
-node_modules/
-browser_snapshots/
-.github/
-dev/
-test/
-samples/
-.doc-detective.json

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

package/Dockerfile

@@ -1,66 +0,0 @@
-FROM ubuntu:20.04 AS system
-LABEL authors="Doc Detective"
-
-# built-in packages
-ENV DEBIAN_FRONTEND=noninteractive
-RUN apt update \
-    && apt install -y --no-install-recommends software-properties-common curl \
-    # apache2-utils \
-    && apt update \
-    && apt install -y --no-install-recommends --allow-unauthenticated \
-        # supervisor nginx sudo net-tools zenity xz-utils \
-        # dbus-x11 x11-utils alsa-utils \
-        # mesa-utils libgl1-mesa-dri \
-    && apt autoclean -y \
-    && apt autoremove -y \
-    && rm -rf /var/lib/apt/lists/*
-# install debs error if combine together
-# RUN apt update \
-#     && apt install -y --no-install-recommends --allow-unauthenticated \
-#         xvfb x11vnc \
-#         vim-tiny firefox ttf-ubuntu-font-family ttf-wqy-zenhei  \
-#     && apt autoclean -y \
-#     && apt autoremove -y \
-#     && rm -rf /var/lib/apt/lists/*
-
-RUN apt update \
-    && apt install -y gpg-agent \
-    && curl -LO https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb \
-    && (dpkg -i ./google-chrome-stable_current_amd64.deb || apt-get install -fy) \
-    && curl -sSL https://dl.google.com/linux/linux_signing_key.pub | apt-key add \
-    && rm google-chrome-stable_current_amd64.deb \
-    && rm -rf /var/lib/apt/lists/*
-
-# RUN apt update \
-#     && apt install -y --no-install-recommends --allow-unauthenticated \
-#         lxde gtk2-engines-murrine gnome-themes-standard gtk2-engines-pixbuf gtk2-engines-murrine arc-theme \
-#     && apt autoclean -y \
-#     && apt autoremove -y \
-#     && rm -rf /var/lib/apt/lists/*
-# # FFMPEG
-# RUN apt update \
-#     && apt install -y --no-install-recommends --allow-unauthenticated \
-#         ffmpeg \
-#     && rm -rf /var/lib/apt/lists/* \
-#     && mkdir /usr/local/ffmpeg \
-#     && ln -s /usr/bin/ffmpeg /usr/local/ffmpeg/ffmpeg
-# Node.js
-RUN curl -sL https://deb.nodesource.com/setup_20.x | bash - \
-    && apt-get install -y nodejs
-
-# Install Doc Detective from NPM
-RUN npm install -g doc-detective@dev
-
-# # Set environment container to trigger container-based behaviors
-# # TODO: Update scripts to override certain config options to static container values (for example, -i and -o should always map to the same directories).
-ENV CONTAINER=true
-
-# # Create app directory
-WORKDIR /app
-
-# # Add entrypoint command base
-ENTRYPOINT [ "npx", "doc-detective" ]
-
-# # Set default command
-# CMD [ "/bin/bash" ]
-CMD [ "" ]