doc-detective 3.1.0-dev.1 → 3.1.0-dev.3

package/.github/workflows/update-core.yaml

@@ -46,57 +46,31 @@ jobs:
           echo "Failed to install doc-detective-core@${{ steps.version.outputs.version }} or doc-detective-common@${{ steps.common_version.outputs.common_version }}"
           exit 1
         }
-          npm audit fix
     
     - name: Test the installation
       run: |
         npm test
     
-    - name: Commit changes
-      id: commit
+    - name: Stage changes
+      id: stage
       run: |
         git add package.json package-lock.json
         if git diff --staged --quiet; then
           echo "No changes to commit"
           echo "has_changes=false" >> $GITHUB_OUTPUT
         else
-          git commit -m "chore: bump doc-detective-core version to ${{ steps.version.outputs.version }}"
-          git push
           echo "has_changes=true" >> $GITHUB_OUTPUT
         fi
 
     - name: Bump or sync version
       id: patch
-      if: steps.commit.outputs.has_changes == 'true'
+      if: steps.stage.outputs.has_changes == 'true'
       run: |
-        git checkout -- .
-        git clean -fd
-        # Get current project version
-        PROJ_VERSION=$(node -p "require('./package.json').version")
-        # Get doc-detective-core version (strip ^ or ~)
-        CORE_VERSION=$(node -p "(require('./package.json').dependencies['doc-detective-core'] || require('./package.json').devDependencies['doc-detective-core'] || '').replace(/^[^\\d]*/, '')")
-        # Parse versions
-        PROJ_MAJOR=$(echo $PROJ_VERSION | cut -d. -f1)
-        PROJ_MINOR=$(echo $PROJ_VERSION | cut -d. -f2)
-        core_MAJOR=$(echo $CORE_VERSION | cut -d. -f1)
-        core_MINOR=$(echo $CORE_VERSION | cut -d. -f2)
-        if [ "$PROJ_MAJOR" != "$core_MAJOR" ] || [ "$PROJ_MINOR" != "$core_MINOR" ]; then
-          # Major or minor mismatch: set version to match doc-detective-core major.minor.0
-          NEW_VERSION="$core_MAJOR.$core_MINOR.0"
-          npm version --no-git-tag-version "$NEW_VERSION"
-        else
-          # Only patch changed: bump patch
-          npm version patch --no-git-tag-version
-        fi
-        git add package.json package-lock.json
-        git commit -m "bump version to match doc-detective-core"
-        git push
-        git tag "v$(node -p \"require('./package.json').version\")"
-        git push --tags
-        echo "version=$(node -p \"require('./package.json').version\")" >> $GITHUB_OUTPUT
+        node scripts/bump-sync-version-core.js
+        version=$(node -p 'require("./package.json").version') && echo "version=$version" >> $GITHUB_OUTPUT
 
-    - name: Create release
-      if: steps.commit.outputs.has_changes == 'true'
+    - name: Install GitHub CLI
+      if: steps.stage.outputs.has_changes == 'true'
       # Install GitHub CLI for fetching PRs and release notes
       run: |
         sudo apt-get update && sudo apt-get install -y gh jq
@@ -120,9 +94,11 @@ jobs:
           echo "$PRS" >> $GITHUB_OUTPUT
           echo "EOF" >> $GITHUB_OUTPUT
         fi
+      env:
+        GITHUB_TOKEN: ${{ secrets.DD_DEP_UPDATE_TOKEN }}
 
     - name: Fetch doc-detective-core release notes
-      id: core_release
+      id: CORE_release
       run: |
         CORE_VERSION=${{ steps.version.outputs.version }}
         # Remove ^ or ~ if present
@@ -132,9 +108,11 @@ jobs:
         echo "release_notes<<EOF" >> $GITHUB_OUTPUT
         echo "$RELEASE_INFO" >> $GITHUB_OUTPUT
         echo "EOF" >> $GITHUB_OUTPUT
+      env:
+        GITHUB_TOKEN: ${{ secrets.DD_DEP_UPDATE_TOKEN }}
 
     - name: Create release with detailed notes
-      if: steps.commit.outputs.has_changes == 'true'
+      if: steps.stage.outputs.has_changes == 'true'
       uses: softprops/action-gh-release@v2
       with:
         body: |
@@ -142,7 +120,7 @@ jobs:
 
           - Updated doc-detective-core to v${{ steps.patch.outputs.version }}:
 
-            ${{ steps.core_release.outputs.release_notes }}
+            ${{ steps.CORE_release.outputs.release_notes }}
 
           ${{ steps.merged_prs.outputs.prs }}
         tag_name: "v${{ steps.patch.outputs.version }}"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "doc-detective",
-  "version": "3.1.0-dev.1",
+  "version": "3.1.0-dev.3",
   "description": "Treat doc content as testable assertions to validate doc accuracy and product UX.",
   "bin": {
     "doc-detective": "src/index.js"
@@ -33,12 +33,12 @@
   "homepage": "https://github.com/doc-detective/doc-detective#readme",
   "dependencies": {
     "@ffmpeg-installer/ffmpeg": "^1.1.0",
-    "doc-detective-common": "^3.1.0-dev.1",
-    "doc-detective-core": "^3.0.0-dev.4",
+    "doc-detective-common": "^3.1.0",
+    "doc-detective-core": "^3.1.0",
     "yargs": "^17.7.2"
   },
   "devDependencies": {
     "chai": "^5.2.0",
-    "mocha": "^11.6.0"
+    "mocha": "^11.7.0"
   }
 }

package/scripts/bump-sync-version-core.js

@@ -0,0 +1,110 @@
+#!/usr/bin/env node
+
+const { execSync } = require("child_process");
+const fs = require("fs");
+const path = require("path");
+const semver = require("semver");
+
+function execCommand(command, options = {}) {
+  try {
+    return execSync(command, {
+      encoding: "utf8",
+      stdio: "inherit",
+      ...options,
+    });
+  } catch (error) {
+    console.error(`Error executing command: ${command}`);
+    process.exit(1);
+  }
+}
+
+function main() {
+  // Clean git state
+    execCommand("git checkout -- .");
+    execCommand("git clean -fd");
+
+  // Get current project version
+  const packageJsonPath = path.join(process.cwd(), "package.json");
+
+  if (!fs.existsSync(packageJsonPath)) {
+    console.error("Error: package.json not found");
+    process.exit(1);
+  }
+
+  const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, "utf8"));
+  const projVersion = semver.minVersion(packageJson.version);
+
+  // Get doc-detective-core version
+  const coreVersion = semver.minVersion(
+    packageJson.dependencies?.["doc-detective-core"] ||
+      packageJson.devDependencies?.["doc-detective-core"] ||
+      ""
+  );
+
+  if (!coreVersion) {
+    console.error("Error: doc-detective-core dependency not found");
+    process.exit(1);
+  }
+
+  if (!semver.valid(projVersion)) {
+    console.error(`Error: Invalid project version format: ${projVersion}`);
+    process.exit(1);
+  }
+
+  // Extract major and minor versions using semver
+  const projMajor = semver.major(projVersion);
+  const projMinor = semver.minor(projVersion);
+  const coreMajor = semver.major(coreVersion);
+  const coreMinor = semver.minor(coreVersion);
+
+  console.log(`Project version: ${projMajor}.${projMinor}.x`);
+  console.log(`core version: ${coreMajor}.${coreMinor}.x`);
+
+  let newVersion;
+
+  if (projMajor !== coreMajor || projMinor !== coreMinor) {
+    // Major or minor mismatch: set version to match doc-detective-core major.minor.0
+    newVersion = `${coreMajor}.${coreMinor}.0`;
+
+    // Validate the new version before setting it
+    if (!semver.valid(newVersion)) {
+      console.error(`Error: Generated invalid version: ${newVersion}`);
+      process.exit(1);
+    }
+
+    console.log(`Version mismatch detected. Setting version to: ${newVersion}`);
+    execCommand(`npm version --no-git-tag-version ${newVersion}`);
+  } else {
+    // Project version is already equal or greater than core version, just bump patch
+    console.log("Project version is current or ahead. Bumping patch version.");
+    execCommand("npm version patch --no-git-tag-version");
+    // Get the new version after bumping
+    const updatedPackageJson = JSON.parse(
+      fs.readFileSync(packageJsonPath, "utf8")
+    );
+    newVersion = updatedPackageJson.version;
+  }
+
+  // Commit changes
+  execCommand("git add package.json package-lock.json");
+  execCommand(
+    'git commit -m "update doc-detective-core [skip ci]"'
+  );
+
+  // Create tag
+  execCommand(`git tag "v${newVersion}"`);
+
+  // Push changes and tags
+  execCommand("git push");
+  execCommand("git push --tags");
+
+  // Output version (equivalent to echo in bash script)
+  console.log(`version=${newVersion}`);
+}
+
+// Run the script
+if (require.main === module) {
+  main();
+}
+
+module.exports = { main };

package/src/index.js

@@ -35,7 +35,7 @@ async function main(argv) {
     : null;
 
   // Set config
-  config = await setConfig({ configPath: configPath, args: argv });
+  const config = await setConfig({ configPath: configPath, args: argv });
 
   // Run tests
   const output = config.output;

package/src/utils.js

@@ -116,8 +116,8 @@ async function setConfig({ configPath, args }) {
   if (args.logLevel) {
     config.logLevel = args.logLevel;
   }
-  if (args.allowUnsafe) {
-    config.allowUnsafeTests = true;
+  if (typeof args.allowUnsafe === "boolean") {
+    config.allowUnsafeSteps = args.allowUnsafe;
   }
   // Resolve paths
   config = await resolvePaths({
@@ -230,6 +230,10 @@ const reporters = {
         (contexts && contexts.fail > 0) ||
         (steps && steps.fail > 0);
 
+      // Any skipped overall?
+      const allSpecsSkipped =
+        specs && specs.pass === 0 && specs.fail === 0 && specs.skipped > 0;
+
       console.log(
         `\n${colors.bold}===== Doc Detective Results Summary =====${colors.reset}`
       );
@@ -238,7 +242,11 @@ const reporters = {
       if (specs) {
         console.log(`\n${colors.bold}Specs:${colors.reset}`);
         console.log(`Total: ${totalSpecs}`);
-        console.log(`${colors.green}Passed: ${specs.pass}${colors.reset}`);
+        if (specs.pass > 0) {
+          console.log(`${colors.green}Passed: ${specs.pass}${colors.reset}`);
+        } else {
+          console.log(`Passed: ${specs.pass}`);
+        }
         console.log(
           `${specs.fail > 0 ? colors.red : colors.green}Failed: ${specs.fail}${
             colors.reset
@@ -248,14 +256,19 @@ const reporters = {
           console.log(
             `${colors.yellow}Warnings: ${specs.warning}${colors.reset}`
           );
-        if (specs.skipped > 0) console.log(`Skipped: ${specs.skipped}`);
+        if (specs.skipped > 0)
+          console.log(`${colors.yellow}Skipped: ${specs.skipped}${colors.reset}`);
       }
 
       // Print tests summary if available
       if (tests) {
         console.log(`\n${colors.bold}Tests:${colors.reset}`);
         console.log(`Total: ${totalTests}`);
-        console.log(`${colors.green}Passed: ${tests.pass}${colors.reset}`);
+        if (tests.pass > 0) {
+          console.log(`${colors.green}Passed: ${tests.pass}${colors.reset}`);
+        } else {
+          console.log(`Passed: ${tests.pass}`);
+        }
         console.log(
           `${tests.fail > 0 ? colors.red : colors.green}Failed: ${tests.fail}${
             colors.reset
@@ -265,14 +278,19 @@ const reporters = {
           console.log(
             `${colors.yellow}Warnings: ${tests.warning}${colors.reset}`
           );
-        if (tests.skipped > 0) console.log(`Skipped: ${tests.skipped}`);
+        if (tests.skipped > 0)
+          console.log(`${colors.yellow}Skipped: ${tests.skipped}${colors.reset}`);
       }
 
       // Print contexts summary if available
       if (contexts) {
         console.log(`\n${colors.bold}Contexts:${colors.reset}`);
         console.log(`Total: ${totalContexts}`);
-        console.log(`${colors.green}Passed: ${contexts.pass}${colors.reset}`);
+        if (contexts.pass > 0) {
+          console.log(`${colors.green}Passed: ${contexts.pass}${colors.reset}`);
+        } else {
+          console.log(`Passed: ${contexts.pass}`);
+        }
         console.log(
           `${contexts.fail > 0 ? colors.red : colors.green}Failed: ${
             contexts.fail
@@ -282,14 +300,19 @@ const reporters = {
           console.log(
             `${colors.yellow}Warnings: ${contexts.warning}${colors.reset}`
           );
-        if (contexts.skipped > 0) console.log(`Skipped: ${contexts.skipped}`);
+        if (contexts.skipped > 0)
+          console.log(`${colors.yellow}Skipped: ${contexts.skipped}${colors.reset}`);
       }
 
       // Print steps summary if available
       if (steps) {
         console.log(`\n${colors.bold}Steps:${colors.reset}`);
         console.log(`Total: ${totalSteps}`);
-        console.log(`${colors.green}Passed: ${steps.pass}${colors.reset}`);
+        if (steps.pass > 0) {
+          console.log(`${colors.green}Passed: ${steps.pass}${colors.reset}`);
+        } else {
+          console.log(`Passed: ${steps.pass}`);
+        }
         console.log(
           `${steps.fail > 0 ? colors.red : colors.green}Failed: ${steps.fail}${
             colors.reset
@@ -299,7 +322,13 @@ const reporters = {
           console.log(
             `${colors.yellow}Warnings: ${steps.warning}${colors.reset}`
           );
-        if (steps.skipped > 0) console.log(`Skipped: ${steps.skipped}`);
+        if (steps.skipped > 0)
+          console.log(`${colors.yellow}Skipped: ${steps.skipped}${colors.reset}`);
+      }
+
+      // If all specs were skipped, call it out
+      if (allSpecsSkipped) {
+        console.log(`\n${colors.yellow}⚠️  All items were skipped. No specs passed or failed. ⚠️${colors.reset}`);
       }
 
       // If we have specs with failures, display them
@@ -314,7 +343,13 @@ const reporters = {
         const failedContexts = [];
         const failedSteps = [];
 
-        // Process specs array to collect failures
+        // Collect skipped
+        const skippedSpecs = [];
+        const skippedTests = [];
+        const skippedContexts = [];
+        const skippedSteps = [];
+
+        // Process specs array to collect failures and skipped
         results.specs.forEach((spec, specIndex) => {
           // Check if spec has failed
           if (spec.result === "FAIL") {
@@ -323,6 +358,13 @@ const reporters = {
               id: spec.specId || `Spec ${specIndex + 1}`,
             });
           }
+          // Check if spec was skipped
+          if (spec.result === "SKIPPED") {
+            skippedSpecs.push({
+              index: specIndex,
+              id: spec.specId || `Spec ${specIndex + 1}`,
+            });
+          }
 
           // Process tests in this spec
           if (spec.tests && spec.tests.length > 0) {
@@ -336,6 +378,15 @@ const reporters = {
                   id: test.testId || `Test ${testIndex + 1}`,
                 });
               }
+              // Check if test was skipped
+              if (test.result === "SKIPPED") {
+                skippedTests.push({
+                  specIndex,
+                  testIndex,
+                  specId: spec.specId || `Spec ${specIndex + 1}`,
+                  id: test.testId || `Test ${testIndex + 1}`,
+                });
+              }
 
               // Process contexts in this test
               if (test.contexts && test.contexts.length > 0) {
@@ -357,6 +408,23 @@ const reporters = {
                         : "unknown",
                     });
                   }
+                  // Check if context was skipped
+                  if (
+                    context.result === "SKIPPED" ||
+                    (context.result && context.result.status === "SKIPPED")
+                  ) {
+                    skippedContexts.push({
+                      specIndex,
+                      testIndex,
+                      contextIndex,
+                      specId: spec.specId || `Spec ${specIndex + 1}`,
+                      testId: test.testId || `Test ${testIndex + 1}`,
+                      platform: context.platform || "unknown",
+                      browser: context.browser
+                        ? context.browser.name
+                        : "unknown",
+                    });
+                  }
 
                   // Process steps in this context
                   if (context.steps && context.steps.length > 0) {
@@ -378,6 +446,22 @@ const reporters = {
                           error: step.resultDescription || "Unknown error",
                         });
                       }
+                      // Check if step was skipped
+                      if (step.result === "SKIPPED") {
+                        skippedSteps.push({
+                          specIndex,
+                          testIndex,
+                          contextIndex,
+                          stepIndex,
+                          specId: spec.specId || `Spec ${specIndex + 1}`,
+                          testId: test.testId || `Test ${testIndex + 1}`,
+                          platform: context.platform || "unknown",
+                          browser: context.browser
+                            ? context.browser.name
+                            : "unknown",
+                          stepId: step.stepId || `Step ${stepIndex + 1}`,
+                        });
+                      }
                     });
                   }
                 });
@@ -427,7 +511,33 @@ const reporters = {
             console.log(`   Error: ${item.error}`);
           });
         }
-      } else if (!hasFailures) {
+
+        // Display skipped items in yellow
+        if (skippedSpecs.length > 0) {
+          console.log(`\n${colors.yellow}Skipped Specs:${colors.reset}`);
+          skippedSpecs.forEach((item, i) => {
+            console.log(`${colors.yellow}${i + 1}. ${item.id}${colors.reset}`);
+          });
+        }
+        if (skippedTests.length > 0) {
+          console.log(`\n${colors.yellow}Skipped Tests:${colors.reset}`);
+          skippedTests.forEach((item, i) => {
+            console.log(`${colors.yellow}${i + 1}. ${item.id} (from ${item.specId})${colors.reset}`);
+          });
+        }
+        if (skippedContexts.length > 0) {
+          console.log(`\n${colors.yellow}Skipped Contexts:${colors.reset}`);
+          skippedContexts.forEach((item, i) => {
+            console.log(`${colors.yellow}${i + 1}. ${item.platform}/${item.browser} (from ${item.testId})${colors.reset}`);
+          });
+        }
+        if (skippedSteps.length > 0) {
+          console.log(`\n${colors.yellow}Skipped Steps:${colors.reset}`);
+          skippedSteps.forEach((item, i) => {
+            console.log(`${colors.yellow}${i + 1}. ${item.platform}/${item.browser} - ${item.stepId}${colors.reset}`);
+          });
+        }
+      } else if (!hasFailures && !allSpecsSkipped) {
         // Celebration when all tests pass
         console.log(`\n${colors.green}🎉 All items passed! 🎉${colors.reset}`);
       }

package/test/utils.test.js

@@ -169,7 +169,7 @@ describe("Util tests", function () {
         ],
         expected: {
           input: [path.resolve(process.cwd(), "input.spec.json")],
-          allowUnsafeTests: true,
+          allowUnsafeSteps: true,
         },
       }
     ];