doc-detective 3.6.2 → 3.7.0-preview.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "doc-detective",
-  "version": "3.6.2",
+  "version": "3.7.0-preview.0",
   "description": "Treat doc content as testable assertions to validate doc accuracy and product UX.",
   "bin": {
     "doc-detective": "src/index.js"
@@ -8,7 +8,7 @@
   "main": "./src/index.js",
   "scripts": {
     "mocha": "mocha",
-    "test": "mocha test/*.test.js",
+    "test": "mocha --exit test/*.test.js test/builder/*.test.mjs",
     "prerunTests": "node ./src/checkDependencies.js",
     "runTests": "node ./src/index.js runTests",
     "start": "node ./src/index.js",
@@ -34,14 +34,23 @@
   "dependencies": {
     "@ffmpeg-installer/ffmpeg": "^1.1.0",
     "axios": "^1.13.2",
-    "doc-detective-common": "^3.6.0",
-    "doc-detective-core": "^3.6.2",
+    "doc-detective-common": "^3.7.0-preview.0",
+    "doc-detective-core": "^3.7.0-preview.0",
+    "doc-detective-resolver": "^3.7.0-preview.0",
+    "ink": "^6.5.1",
+    "ink-select-input": "^6.2.0",
+    "ink-spinner": "^5.0.0",
+    "js-yaml": "^4.1.1",
+    "react": "^19.2.1",
+    "yaml": "^2.8.2",
     "yargs": "^17.7.2"
   },
   "devDependencies": {
     "body-parser": "^2.2.1",
     "chai": "^6.2.1",
     "express": "^5.2.1",
-    "mocha": "^11.7.5"
+    "ink-testing-library": "^4.0.0",
+    "mocha": "^11.7.5",
+    "sinon": "^19.0.2"
   }
 }

package/samples/http.spec.yaml

@@ -1,37 +1,39 @@
 tests:
-- steps:
-  - loadVariables: env
-  - httpRequest:
-      url: http://localhost:8092/api/users
-      method: post
-      request:
-        body:
-          name: $USER
-          job: $JOB
-      response:
-        body:
-          name: John Doe
-          job: Software Engineer
-  - httpRequest:
-      url: http://localhost:8092/api/users
-      method: post
-      request:
-        body:
-          data:
-            - first_name: George
-              last_name: Bluth
-              id: 1
-      response:
-        body:
-          data:
-            - first_name: George
-              last_name: Bluth
-    variables:
-      ID: $$response.body.data[0].id
-  - httpRequest:
-      url: http://localhost:8092/api/$ID
-      method: get
-      timeout: 1000
-    savePath: response.json
-    maxVariation: 0
-    overwrite: aboveVariation
+  - steps:
+      - loadVariables: env
+      - httpRequest:
+          url: http://localhost:8092/api/users
+          method: post
+          request:
+            body:
+              name: $USER
+              job: $JOB
+          response:
+            body:
+              name: John Doe
+              job: Software Engineer
+      - httpRequest:
+          url: http://localhost:8092/api/users
+          method: post
+          request:
+            body:
+              data:
+                - first_name: George
+                  last_name: Bluth
+                  id: 1
+          response:
+            body:
+              data:
+                - first_name: George
+                  last_name: Bluth
+        variables:
+          ID: $$response.body.data[0].id
+      - httpRequest:
+          url: http://localhost:8092/api/$ID
+          method: get
+          timeout: 1000
+        savePath: response.json
+        maxVariation: 0
+        overwrite: aboveVariation
+    testId: foobar
+specId: edf6cf93-04f4-4931-ae7d-037bd75def9a

package/samples/kitten-search.spec.json

@@ -3,26 +3,36 @@
     {
       "steps": [
         {
-          "action": "goTo",
-          "url": "https://www.duckduckgo.com"
+          "goTo": {
+            "url": "https://www.duckduckgo.com"
+          }
         },
         {
-          "action": "find",
-          "selector": "#searchbox_input",
-          "click": true,
-          "typeKeys": {
-            "keys": ["American Shorthair kittens", "$ENTER$"]
-          }
+          "find": {
+            "selector": "#searchbox_input",
+            "click": true,
+            "type": {
+              "keys": ["American Shorthair kittens", "$ENTER$"]
+            }
+          },
+          "variables": {}
         },
         {
-          "action": "find",
-          "selector": "[data-testid='web-vertical']"
+          "find": {
+            "selector": "[data-testid='web-vertical']"
+          },
+          "variables": {}
         },
         {
-          "action": "saveScreenshot",
-          "path": "search-results.png"
+          "screenshot": {
+            "path": "search-results.png",
+            "maxVariation": 0
+          }
         }
-      ]
+      ],
+      "detectSteps": true,
+      "testId": "efd34931-ba4f-47be-85bb-d8cb61123b8d"
     }
-  ]
+  ],
+  "specId": "02db96fc-7912-4eb6-ad79-9c96c2f1f8db"
 }

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

@@ -70,11 +70,11 @@ function main() {
     console.log(`Version mismatch detected. Setting version to: ${newVersion}`);
   } else {
     // Project version is already equal or greater than core version, just bump patch
+    newVersion = `${projMajor}.${projMinor}.${projPatch + 1}`;
     console.log(
       "Project version is current or ahead. Bumping patch version to:",
       newVersion
     );
-    newVersion = `${projMajor}.${projMinor}.${projPatch + 1}`;
   }
   
   // Validate the new version before setting it

package/src/cli/App.mjs

@@ -0,0 +1,39 @@
+import React from 'react';
+const { createElement: h } = React;
+import { Box, Text } from 'ink';
+import Spinner from 'ink-spinner';
+import TestRunner from './TestRunner.mjs';
+import ResultsSummary from './ResultsSummary.mjs';
+
+const App = ({ config, state }) => {
+  return h(Box, { flexDirection: 'column', paddingY: 1 },
+    h(Box, { marginBottom: 1 },
+      h(Text, { bold: true, color: 'cyan' }, 'Doc Detective')
+    ),
+
+    state.phase === 'initializing' && h(Box, null,
+      h(Text, { color: 'gray' },
+        h(Spinner, { type: 'dots' }), ' Initializing...'
+      )
+    ),
+
+    state.phase === 'running' && h(TestRunner, {
+      config,
+      progress: state.progress,
+      currentSpec: state.currentSpec,
+      currentTest: state.currentTest,
+    }),
+
+    state.phase === 'completed' && state.results && h(ResultsSummary, {
+      results: state.results,
+      config,
+    }),
+
+    state.phase === 'error' && h(Box, { flexDirection: 'column' },
+      h(Text, { color: 'red', bold: true }, '✖ Error'),
+      h(Text, { color: 'red' }, state.error?.message || String(state.error))
+    )
+  );
+};
+
+export default App;

package/src/cli/ResultsSummary.mjs

@@ -0,0 +1,162 @@
+import React from 'react';
+const { createElement: h } = React;
+import { Box, Text } from 'ink';
+
+const ResultsSummary = ({ results, config }) => {
+  if (!results || !results.summary) {
+    return h(Box, null,
+      h(Text, { color: 'yellow' }, 'No results available.')
+    );
+  }
+
+  const { specs, tests, contexts, steps } = results.summary;
+
+  // Calculate totals
+  const totalSpecs = specs ? specs.pass + specs.fail + specs.warning + specs.skipped : 0;
+  const totalTests = tests ? tests.pass + tests.fail + tests.warning + tests.skipped : 0;
+  const totalContexts = contexts ? contexts.pass + contexts.fail + contexts.warning + contexts.skipped : 0;
+  const totalSteps = steps ? steps.pass + steps.fail + steps.warning + steps.skipped : 0;
+
+  // Check for failures
+  const hasFailures =
+    (specs && specs.fail > 0) ||
+    (tests && tests.fail > 0) ||
+    (contexts && contexts.fail > 0) ||
+    (steps && steps.fail > 0);
+
+  // Check if all skipped
+  const allSpecsSkipped =
+    specs && specs.pass === 0 && specs.fail === 0 && specs.skipped > 0;
+
+  const failedItems = hasFailures && results.specs ? getFailedItems(results) : [];
+
+  return h(Box, { flexDirection: 'column' },
+    // Header
+    h(Box, { marginBottom: 1 },
+      h(Text, { bold: true, underline: true }, 'Test Results Summary')
+    ),
+
+    // Specs summary
+    specs && h(Box, { flexDirection: 'column', marginBottom: 1 },
+      h(Text, { bold: true }, 'Specs'),
+      h(Box, { marginLeft: 2 },
+        h(Text, null, `Total: ${totalSpecs} `),
+        specs.pass > 0 && h(Text, { color: 'green' }, `✓ ${specs.pass} passed `),
+        specs.fail > 0 && h(Text, { color: 'red' }, `✖ ${specs.fail} failed `),
+        specs.warning > 0 && h(Text, { color: 'yellow' }, `⚠ ${specs.warning} warnings `),
+        specs.skipped > 0 && h(Text, { color: 'gray' }, `⊘ ${specs.skipped} skipped`)
+      )
+    ),
+
+    // Tests summary
+    tests && h(Box, { flexDirection: 'column', marginBottom: 1 },
+      h(Text, { bold: true }, 'Tests'),
+      h(Box, { marginLeft: 2 },
+        h(Text, null, `Total: ${totalTests} `),
+        tests.pass > 0 && h(Text, { color: 'green' }, `✓ ${tests.pass} passed `),
+        tests.fail > 0 && h(Text, { color: 'red' }, `✖ ${tests.fail} failed `),
+        tests.warning > 0 && h(Text, { color: 'yellow' }, `⚠ ${tests.warning} warnings `),
+        tests.skipped > 0 && h(Text, { color: 'gray' }, `⊘ ${tests.skipped} skipped`)
+      )
+    ),
+
+    // Contexts summary
+    contexts && h(Box, { flexDirection: 'column', marginBottom: 1 },
+      h(Text, { bold: true }, 'Contexts'),
+      h(Box, { marginLeft: 2 },
+        h(Text, null, `Total: ${totalContexts} `),
+        contexts.pass > 0 && h(Text, { color: 'green' }, `✓ ${contexts.pass} passed `),
+        contexts.fail > 0 && h(Text, { color: 'red' }, `✖ ${contexts.fail} failed `),
+        contexts.warning > 0 && h(Text, { color: 'yellow' }, `⚠ ${contexts.warning} warnings `),
+        contexts.skipped > 0 && h(Text, { color: 'gray' }, `⊘ ${contexts.skipped} skipped`)
+      )
+    ),
+
+    // Steps summary
+    steps && h(Box, { flexDirection: 'column', marginBottom: 1 },
+      h(Text, { bold: true }, 'Steps'),
+      h(Box, { marginLeft: 2 },
+        h(Text, null, `Total: ${totalSteps} `),
+        steps.pass > 0 && h(Text, { color: 'green' }, `✓ ${steps.pass} passed `),
+        steps.fail > 0 && h(Text, { color: 'red' }, `✖ ${steps.fail} failed `),
+        steps.warning > 0 && h(Text, { color: 'yellow' }, `⚠ ${steps.warning} warnings `),
+        steps.skipped > 0 && h(Text, { color: 'gray' }, `⊘ ${steps.skipped} skipped`)
+      )
+    ),
+
+    // Overall status
+    h(Box, { marginTop: 1 },
+      allSpecsSkipped
+        ? h(Text, { color: 'yellow' }, '⚠ All items were skipped')
+        : hasFailures
+          ? h(Text, { color: 'red', bold: true }, '✖ Tests failed')
+          : h(Text, { color: 'green', bold: true }, '✓ All tests passed!')
+    ),
+
+    // Failed items detail
+    hasFailures && results.specs && h(Box, { flexDirection: 'column', marginTop: 1 },
+      h(Text, { bold: true, color: 'red' }, 'Failed Items:'),
+      ...failedItems.map((item, index) =>
+        h(Box, { key: index, marginLeft: 2 },
+          h(Text, { color: 'red' }, `• ${item}`)
+        )
+      )
+    )
+  );
+};
+
+// Helper function to extract failed items
+function getFailedItems(results) {
+  const failures = [];
+
+  if (!results.specs) return failures;
+
+  results.specs.forEach((spec, specIndex) => {
+    if (spec.result === 'FAIL') {
+      failures.push(`Spec: ${spec.specId || `Spec ${specIndex + 1}`}`);
+    }
+
+    if (spec.tests && spec.tests.length > 0) {
+      spec.tests.forEach((test, testIndex) => {
+        if (test.result === 'FAIL') {
+          failures.push(
+            `Test: ${test.testId || `Test ${testIndex + 1}`} (from ${
+              spec.specId || `Spec ${specIndex + 1}`
+            })`
+          );
+        }
+
+        if (test.contexts && test.contexts.length > 0) {
+          test.contexts.forEach((context, contextIndex) => {
+            if (
+              context.result === 'FAIL' ||
+              (context.result && context.result.status === 'FAIL')
+            ) {
+              failures.push(
+                `Context: ${context.platform || 'unknown'}/${
+                  context.browser ? context.browser.name : 'unknown'
+                } (from ${test.testId || `Test ${testIndex + 1}`})`
+              );
+            }
+
+            if (context.steps && context.steps.length > 0) {
+              context.steps.forEach((step, stepIndex) => {
+                if (step.result === 'FAIL') {
+                  failures.push(
+                    `Step: ${step.stepId || `Step ${stepIndex + 1}`} - ${
+                      step.resultDescription || 'Unknown error'
+                    }`
+                  );
+                }
+              });
+            }
+          });
+        }
+      });
+    }
+  });
+
+  return failures;
+}
+
+export default ResultsSummary;

package/src/cli/TestRunner.mjs

@@ -0,0 +1,41 @@
+import React from 'react';
+const { createElement: h } = React;
+import { Box, Text } from 'ink';
+import Spinner from 'ink-spinner';
+
+const TestRunner = ({ config, progress, currentSpec, currentTest }) => {
+  return h(Box, { flexDirection: 'column' },
+    h(Box, { marginBottom: 1 },
+      h(Text, { color: 'yellow' },
+        h(Spinner, { type: 'dots' }), ' Running tests...'
+      )
+    ),
+
+    // Progress bars
+    progress.specs.total > 0 && h(Box, { marginBottom: 0 },
+      h(Text, { color: 'gray' },
+        `Specs: ${progress.specs.current}/${progress.specs.total}`
+      )
+    ),
+
+    progress.tests.total > 0 && h(Box, { marginBottom: 0 },
+      h(Text, { color: 'gray' },
+        `Tests: ${progress.tests.current}/${progress.tests.total}`
+      )
+    ),
+
+    progress.steps.total > 0 && h(Box, { marginBottom: 1 },
+      h(Text, { color: 'gray' },
+        `Steps: ${progress.steps.current}/${progress.steps.total}`
+      )
+    ),
+
+    // Current execution context
+    currentSpec && h(Box, { flexDirection: 'column', marginTop: 1 },
+      h(Text, { color: 'cyan' }, `Current: ${currentSpec}`),
+      currentTest && h(Text, { color: 'gray', dimColor: true }, `→ ${currentTest}`)
+    )
+  );
+};
+
+export default TestRunner;