doc-detective 3.4.1 → 3.5.0-dev.0

package/samples/doc-content-inline-tests.md

@@ -1,23 +1,23 @@
-# Doc Detective documentation overview
-
-<!-- test
-testId: doc-detective-docs
-detectSteps: false
--->
-
-[Doc Detective documentation](https://doc-detective.com) is split into a few key sections:
-
-<!-- step checkLink: "https://doc-detective.com" -->
-
-- The landing page discusses what Doc Detective is, what it does, and who might find it useful.
-- [Get started](https://doc-detective.com/docs/get-started/intro) covers how to quickly get up and running with Doc Detective.
-
-  <!-- step checkLink: "https://doc-detective.com/docs/get-started/intro" -->
-
-Some pages also have unique headings. If you open [type](https://doc-detective.com/docs/get-started/actions/type) it has **Special keys**.
-
-<!-- step goTo: "https://doc-detective.com/docs/get-started/actions/type" -->
-<!-- step find: Special keys -->
-
-![Search results.](reference.png){ .screenshot }
-<!-- step screenshot: reference.png -->
+# Doc Detective documentation overview
+
+<!-- test
+testId: doc-detective-docs
+detectSteps: false
+-->
+
+[Doc Detective documentation](https://doc-detective.com) is split into a few key sections:
+
+<!-- step checkLink: "https://doc-detective.com" -->
+
+- The landing page discusses what Doc Detective is, what it does, and who might find it useful.
+- [Get started](https://doc-detective.com/docs/get-started/intro) covers how to quickly get up and running with Doc Detective.
+
+  <!-- step checkLink: "https://doc-detective.com/docs/get-started/intro" -->
+
+Some pages also have unique headings. If you open [type](https://doc-detective.com/docs/get-started/actions/type) it has **Special keys**.
+
+<!-- step goTo: "https://doc-detective.com/docs/get-started/actions/type" -->
+<!-- step find: Special keys -->
+
+![Search results.](reference.png){ .screenshot }
+<!-- step screenshot: reference.png -->

package/samples/docker-hello.spec.json

@@ -1,15 +1,15 @@
-{
-  "tests": [
-    {
-      "steps": [
-        {
-          "description": "Run a Docker container and check the output.",
-          "runShell": {
-            "command": "docker run hello-world",
-            "stdio": "Hello from Docker!"
-          }
-        }
-      ]
-    }
-  ]
-}
+{
+  "tests": [
+    {
+      "steps": [
+        {
+          "description": "Run a Docker container and check the output.",
+          "runShell": {
+            "command": "docker run hello-world",
+            "stdio": "Hello from Docker!"
+          }
+        }
+      ]
+    }
+  ]
+}

package/samples/env

@@ -1,3 +1,3 @@
-USER="John Doe"
-JOB="Software Engineer"
+USER="John Doe"
+JOB="Software Engineer"
 SECRET="YOUR_SECRET_KEY"

package/samples/http.spec.yaml

@@ -1,37 +1,37 @@
-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
+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

package/samples/kitten-search-detect.md

@@ -1,8 +1,8 @@
-To search for American Shorthair kittens,
-
-1. Go to [DuckDuckGo](https://www.duckduckgo.com).
-2. In the search bar, enter "American Shorthair kittens", then press Enter.
-
-<!-- step wait: 10000 -->
-
+To search for American Shorthair kittens,
+
+1. Go to [DuckDuckGo](https://www.duckduckgo.com).
+2. In the search bar, enter "American Shorthair kittens", then press Enter.
+
+<!-- step wait: 10000 -->
+
 !["Search results for kittens"](search-results.png){ .screenshot }

package/samples/kitten-search-inline.md

@@ -1,15 +1,15 @@
-To search for American Shorthair kittens,
-
-1. Go to [DuckDuckGo](https://www.duckduckgo.com).
-
-   [comment]: # (step { "action": "goTo", "url": "https://www.duckduckgo.com"})
-   [comment]: # (step { "action": "startRecording", "path": "search-results.gif"})
-
-2. In the search bar, enter "American Shorthair kittens", then press Enter.
-
-   [comment]: # (step { "action": "find", "selector": "#searchbox_input", "click": true })
-   [comment]: # (step { "action": "typeKeys", "keys": ["American Shorthair kittens", "$ENTER$"] })
-   [comment]: # (step { "action": "find", "selector": "[data-testid='web-vertical']" })
-   [comment]: # (step { "action": "stopRecording" })
-
-![](search-results.gif)
+To search for American Shorthair kittens,
+
+1. Go to [DuckDuckGo](https://www.duckduckgo.com).
+
+   [comment]: # (step { "action": "goTo", "url": "https://www.duckduckgo.com"})
+   [comment]: # (step { "action": "startRecording", "path": "search-results.gif"})
+
+2. In the search bar, enter "American Shorthair kittens", then press Enter.
+
+   [comment]: # (step { "action": "find", "selector": "#searchbox_input", "click": true })
+   [comment]: # (step { "action": "typeKeys", "keys": ["American Shorthair kittens", "$ENTER$"] })
+   [comment]: # (step { "action": "find", "selector": "[data-testid='web-vertical']" })
+   [comment]: # (step { "action": "stopRecording" })
+
+![](search-results.gif)

package/samples/kitten-search.spec.json

@@ -1,28 +1,28 @@
-{
-  "tests": [
-    {
-      "steps": [
-        {
-          "action": "goTo",
-          "url": "https://www.duckduckgo.com"
-        },
-        {
-          "action": "find",
-          "selector": "#searchbox_input",
-          "click": true,
-          "typeKeys": {
-            "keys": ["American Shorthair kittens", "$ENTER$"]
-          }
-        },
-        {
-          "action": "find",
-          "selector": "[data-testid='web-vertical']"
-        },
-        {
-          "action": "saveScreenshot",
-          "path": "search-results.png"
-        }
-      ]
-    }
-  ]
-}
+{
+  "tests": [
+    {
+      "steps": [
+        {
+          "action": "goTo",
+          "url": "https://www.duckduckgo.com"
+        },
+        {
+          "action": "find",
+          "selector": "#searchbox_input",
+          "click": true,
+          "typeKeys": {
+            "keys": ["American Shorthair kittens", "$ENTER$"]
+          }
+        },
+        {
+          "action": "find",
+          "selector": "[data-testid='web-vertical']"
+        },
+        {
+          "action": "saveScreenshot",
+          "path": "search-results.png"
+        }
+      ]
+    }
+  ]
+}

package/samples/local-gui.md

@@ -1,6 +1,6 @@
-# Sample Local GUI
-
-1. Open [the GUI](http://localhost:8092).
-2. Find **Selection Elements**, and click **Option 1**.
-
+# Sample Local GUI
+
+1. Open [the GUI](http://localhost:8092).
+2. Find **Selection Elements**, and click **Option 1**.
+
 !["Believe me now?"](proof.png){ .screenshot }

package/samples/tests.spec.json

@@ -1,70 +1,70 @@
-{
-  "id": "Do all the things! - Spec",
-  "contexts": [
-    {
-      "app": {
-        "name": "firefox"
-      },
-      "platforms": ["windows", "mac", "linux"]
-    }
-  ],
-  "tests": [
-    {
-      "id": "Do all the things! - Test",
-      "description": "This test includes nearly every property across all actions.",
-      "steps": [
-        {
-          "action": "setVariables",
-          "path": ".env"
-        },
-        {
-          "action": "runShell",
-          "command": "echo",
-          "args": ["$USER"]
-        },
-        {
-          "action": "checkLink",
-          "url": "https://www.duckduckgo.com"
-        },
-        {
-          "action": "httpRequest",
-          "url": "https://reqres.in/api/users",
-          "method": "post",
-          "requestData": {
-            "name": "morpheus",
-            "job": "leader"
-          },
-          "responseData": {
-            "name": "morpheus",
-            "job": "leader"
-          },
-          "statusCodes": [200, 201]
-        },
-        {
-          "action": "goTo",
-          "url": "https://www.google.com"
-        },
-        {
-          "action": "find",
-          "selector": "[title=Search]",
-          "timeout": 10000,
-          "moveTo": true,
-          "click": true,
-          "typeKeys": {
-            "keys": ["shorthair cat", "$ENTER$"]
-          }
-        },
-        {
-          "action": "wait"
-        },
-        {
-          "action": "saveScreenshot",
-          "path": "screenshot.png",
-          "directory": "samples",
-          "maxVariation": 5,
-          "overwrite": "byVariation"
-        }
-      ]
-    }
-  ]
-}
+{
+  "id": "Do all the things! - Spec",
+  "contexts": [
+    {
+      "app": {
+        "name": "firefox"
+      },
+      "platforms": ["windows", "mac", "linux"]
+    }
+  ],
+  "tests": [
+    {
+      "id": "Do all the things! - Test",
+      "description": "This test includes nearly every property across all actions.",
+      "steps": [
+        {
+          "action": "setVariables",
+          "path": ".env"
+        },
+        {
+          "action": "runShell",
+          "command": "echo",
+          "args": ["$USER"]
+        },
+        {
+          "action": "checkLink",
+          "url": "https://www.duckduckgo.com"
+        },
+        {
+          "action": "httpRequest",
+          "url": "https://reqres.in/api/users",
+          "method": "post",
+          "requestData": {
+            "name": "morpheus",
+            "job": "leader"
+          },
+          "responseData": {
+            "name": "morpheus",
+            "job": "leader"
+          },
+          "statusCodes": [200, 201]
+        },
+        {
+          "action": "goTo",
+          "url": "https://www.google.com"
+        },
+        {
+          "action": "find",
+          "selector": "[title=Search]",
+          "timeout": 10000,
+          "moveTo": true,
+          "click": true,
+          "typeKeys": {
+            "keys": ["shorthair cat", "$ENTER$"]
+          }
+        },
+        {
+          "action": "wait"
+        },
+        {
+          "action": "saveScreenshot",
+          "path": "screenshot.png",
+          "directory": "samples",
+          "maxVariation": 5,
+          "overwrite": "byVariation"
+        }
+      ]
+    }
+  ]
+}

package/samples/variables.env

@@ -1,5 +1,5 @@
-USERNAME=foo
-PASSWORD=bar
-SHORTHAIR_CAT_SEARCH=american shorthair cats
-URL=www.google.com
+USERNAME=foo
+PASSWORD=bar
+SHORTHAIR_CAT_SEARCH=american shorthair cats
+URL=www.google.com
 TEXT=I'm Feeling Lucky

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

@@ -1,108 +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 projPatch = semver.patch(projVersion);
-  const coreMajor = semver.major(coreVersion);
-  const coreMinor = semver.minor(coreVersion);
-  const corePatch = semver.patch(coreVersion);
-
-  console.log(`Project version: ${projMajor}.${projMinor}.${projPatch}`);
-  console.log(`core version: ${coreMajor}.${coreMinor}.${corePatch}`);
-
-  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`;
-    console.log(`Version mismatch detected. Setting version to: ${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 to:",
-      newVersion
-    );
-    newVersion = `${projMajor}.${projMinor}.${projPatch + 1}`;
-  }
-  
-  // Validate the new version before setting it
-  if (!semver.valid(newVersion)) {
-    console.error(`Error: Generated invalid version: ${newVersion}`);
-    process.exit(1);
-  }
-
-  execCommand(`npm version --no-git-tag-version ${newVersion}`);
-
-  // 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 };
+#!/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 };