doc-detective 2.13.0-dev.0 → 2.13.0

package/.doc-detective.json

@@ -25,30 +25,30 @@
       "markup": [
         {
           "name": "Hyperlink",
-          "regex": ["(?<=(?<!!)\\[[\\w\\s]+\\]\\().*?(?=\\))"],
+          "regex": ["(?<!!)\\[.+?\\]\\((.+?)\\)"],
           "actions": ["checkLink"]
         },
         {
           "name": "Navigation link",
-          "regex": ["(?<=([Oo]pen|[Cc]lick) (?<!!)\\[[\\w\\s]+\\]\\().*?(?=\\))"],
+          "regex": [
+            "(?:[Cc]hose|[Oo]pen|[Cc]lick|[Nn]avigate to|[Gg]o to)(?<!!)\\[.+?\\]\\((.+?)\\)"
+          ],
           "actions": ["goTo"]
         },
         {
           "name": "Onscreen text",
-          "regex": ["(?<=\\*\\*)[\\w\\s]+?(?=\\*\\*)"],
+          "regex": ["\\*\\*(.+?)\\*\\*"],
           "actions": ["find"]
         },
         {
           "name": "Image",
-          "regex": ["(?<=\\!\\[.*?\\]\\().*?(?=\\))"],
+          "regex": ["!\\[.+?\\]\\((.+?)\\)"],
           "actions": [
             {
-              "name": "saveScreenshot",
-              "params": {
-                "directory": "samples",
-                "maxVariation": 5,
-                "overwrite": "byVariation"
-              }
+              "action": "saveScreenshot",
+              "directory": "samples",
+              "maxVariation": 5,
+              "overwrite": "byVariation"
             }
           ]
         }

package/doc-detective.svg

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Generator: Adobe Illustrator 24.3.0, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
+<svg version="1.1" id="_x31_" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+	 width="1200px" height="1200px" viewBox="0 0 1200 1200" enable-background="new 0 0 1200 1200" xml:space="preserve">
+<g>
+	<path fill="#4B9A47" d="M1128.306,1200H71.694C32.099,1200,0,1167.901,0,1128.306V71.694C0,32.099,32.099,0,71.694,0h1056.612
+		C1167.901,0,1200,32.099,1200,71.694v1056.612C1200,1167.901,1167.901,1200,1128.306,1200z"/>
+	<g>
+		<path fill="#FFFFFF" d="M251.414,202.411v792.621c0,30.013,24.331,54.344,54.344,54.344h612.917
+			c16.716,0,30.268-13.551,30.268-30.268V420.58L677.939,149.577l-376.472,2.454C273.771,152.211,251.414,174.714,251.414,202.411z"
+			/>
+		<path d="M918.676,1078.376H305.758c-45.956,0-83.344-37.388-83.344-83.344V202.411c0-43.487,35.378-79.097,78.865-79.38
+			l388.594-2.533l288.069,288.07v610.541C977.942,1051.788,951.355,1078.376,918.676,1078.376z M666.006,178.655l-364.349,2.375
+			c-11.713,0.076-21.243,9.668-21.243,21.381v792.621c0,13.975,11.37,25.344,25.344,25.344h612.917c0.698,0,1.267-0.568,1.267-1.268
+			V432.592L666.006,178.655z"/>
+	</g>
+	<rect x="449.529" y="595.822" width="302.675" height="60.076"/>
+	<rect x="449.529" y="759.771" width="181.605" height="60.076"/>
+	<path d="M864.547,919.645l-33.693,0.599l-22.668-28.276c47.751-52.006,73.916-119.016,73.916-190.056
+		c0-75.146-29.264-145.795-82.4-198.932c-53.137-53.137-123.785-82.4-198.932-82.4s-145.795,29.264-198.932,82.4
+		c-53.137,53.136-82.4,123.785-82.4,198.932s29.264,145.795,82.4,198.932c53.136,53.137,123.785,82.4,198.932,82.4
+		c72.38,0,140.58-27.159,192.986-76.64l22.685,24.676l0.425,32.343c0,2.932,1.17,5.743,3.249,7.81l214.126,212.771l49.529-52.28
+		L872.417,922.828C870.324,920.757,867.49,919.611,864.547,919.645z M600.77,920.244c-120.389,0-218.332-97.943-218.332-218.332
+		S480.382,483.58,600.77,483.58s218.332,97.943,218.332,218.332S721.159,920.244,600.77,920.244z"/>
+</g>
+</svg>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "doc-detective",
-  "version": "2.13.0-dev.0",
+  "version": "2.13.0",
   "description": "Treat doc content as testable assertions to validate doc accuracy and product UX.",
   "bin": {
     "doc-detective": "src/index.js"
@@ -31,8 +31,8 @@
   },
   "homepage": "https://github.com/doc-detective/doc-detective#readme",
   "dependencies": {
-    "doc-detective-common": "^1.17.0-dev.1",
-    "doc-detective-core": "^2.13.0-dev.0",
+    "doc-detective-common": "^1.17.0",
+    "doc-detective-core": "^2.13.0",
     "prompt-sync": "^4.2.0",
     "yargs": "^17.7.2"
   },

package/samples/.doc-detective.json

@@ -1,12 +1,13 @@
 {
   "envVariables": "./variables.env",
+  "defaultCommand": "runTests",
   "input": ".",
   "output": ".",
   "recursive": true,
   "logLevel": "info",
   "runTests": {
     "detectSteps": true,
-    "input": "./doc-content.md",
+    "input": "./doc-content-inline-tests.md",
     "output": ".",
     "setup": "",
     "cleanup": "",
@@ -16,14 +17,12 @@
     "contexts": [
       {
         "app": {
-          "name": "firefox",
+          "name": "chrome",
           "options": {
-            "width": 1200,
-            "height": 800,
             "headless": false
           }
         },
-        "platforms": ["linux", "mac", "windows"]
+        "platforms": ["windows", "mac", "linux"]
       }
     ]
   },
@@ -33,12 +32,6 @@
     "output": ".",
     "markup": []
   },
-  "suggestTests": {
-    "recursive": true,
-    "input": ".",
-    "output": ".",
-    "markup": []
-  },
   "fileTypes": [
     {
       "name": "Markdown",
@@ -52,30 +45,29 @@
       "markup": [
         {
           "name": "Hyperlink",
-          "regex": ["(?<=(?<!!)\\[[\\w\\s]+\\]\\().*?(?=\\))"],
+          "regex": ["(?<!!)\\[.+?\\]\\((.+?)\\)"],
           "actions": ["checkLink"]
         },
         {
           "name": "Navigation link",
-          "regex": ["(?<=([Oo]pen|[Cc]lick) (?<!!)\\[[\\w\\s]+\\]\\().*?(?=\\))"],
+          "regex": [
+            "(?:[Cc]hose|[Oo]pen|[Cc]lick|[Nn]avigate to|[Gg]o to)\\s+(?<!!)\\[.+?\\]\\((.+?)\\)"
+          ],
           "actions": ["goTo"]
         },
         {
           "name": "Onscreen text",
-          "regex": ["(?<=\\*\\*)[\\w\\s]+?(?=\\*\\*)"],
+          "regex": ["\\*\\*(.+?)\\*\\*"],
           "actions": ["find"]
         },
         {
           "name": "Image",
-          "regex": ["(?<=\\!\\[.*?\\]\\().*?(?=\\))"],
+          "regex": ["!\\[.+?\\]\\((.+?)\\)"],
           "actions": [
             {
-              "name": "saveScreenshot",
-              "params": {
-                "directory": ".",
-                "maxVariation": 5,
-                "overwrite": "byVariation"
-              }
+              "action": "saveScreenshot",
+              "maxVariation": 5,
+              "overwrite": "byVariation"
             }
           ]
         }

package/samples/{doc-content.md → doc-content-detect.md}

@@ -3,7 +3,9 @@
 [Doc Detective documentation](https://doc-detective.com) is split into a few key sections:
 
 - The landing page discusses what Doc Detective is, what it does, and who might find it useful.
+
 - [Get started](https://doc-detective.com/get-started.html) covers how to quickly get up and running with Doc Detective.
+
 - The [references](https://doc-detective.com/reference/) detail the various JSON objects that Doc Detective expects for [configs](https://doc-detective.com/reference/schemas/config.html), [test specifications](https://doc-detective.com/reference/schemas/specification.html), [tests](https://doc-detective.com/reference/schemas/test), actions, and more. Open [typeKeys](https://doc-detective.com/reference/schemas/typeKeys.html)--or any other schema--and you'll find three sections: **Description**, **Fields**, and **Examples**.
 
 ![Search results.](reference.png)

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

@@ -1,12 +1,12 @@
 # Doc Detective documentation overview
 
-[comment]: # (test start {"id":"search-kittens", "detectSteps":false})
+[comment]: # (test start {"id":"doc-detective-docs", "detectSteps": false})
 
 [Doc Detective documentation](http://doc-detective.com) is split into a few key sections:
 
 [comment]: # (step {"action":"checkLink", "url":"https://doc-detective.com"})
 
-The landing page discusses what Doc Detective is, what it does, and who might find it useful.
+- The landing page discusses what Doc Detective is, what it does, and who might find it useful.
 
 - [Get started](https://doc-detective.com/get-started.html) covers how to quickly get up and running with Doc Detective.
 
@@ -25,5 +25,5 @@ The landing page discusses what Doc Detective is, what it does, and who might fi
 
 ![Search results.](reference.png)
 
-[comment]: # (step {"action":"saveScreenshot", "path":"reference.png", "directory":"samples", "maxVariation":5, "overwrite":"byVariation"})
+[comment]: # (step {"action":"saveScreenshot", "path":"reference.png", "maxVariation":5, "overwrite":"byVariation"})
 [comment]: # (test end)

package/samples/docker-hello.spec.json

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

package/samples/http.spec.json

@@ -0,0 +1,26 @@
+{
+  "tests": [
+    {
+      "steps": [
+        {
+          "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]
+        }
+      ]
+    }
+  ]
+}

package/samples/kitten-search-inline.md

@@ -0,0 +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)

package/samples/kitten-search.spec.json

@@ -0,0 +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"
+        }
+      ]
+    }
+  ]
+}

package/src/utils.js

@@ -115,10 +115,12 @@ function setConfig(config, args) {
 
 async function outputResults(config, path, results) {
   let data = JSON.stringify(results, null, 2);
-  fs.writeFile(path, data, (err) => {
-    if (err) throw err;
-  });
-  console.log(`See results at ${path}`);
+  try {
+    fs.writeFileSync(path, data);
+    console.log(`See results at ${path}`);
+  } catch (err) {
+    console.error(`Error writing results to ${path}: ${err}`);
+  }
 }
 
 // Perform a native command in the current working directory.

package/test/utils.test.js

@@ -178,6 +178,8 @@ describe("Util tests", function () {
     const inputResultsPath = path.resolve("./test/test-results.json");
     const inputResultsJSON = require(inputResultsPath);
     const outputResultsPath = path.resolve("./test/output-test-results.json");
+    // Check that input file exists
+    expect(fs.existsSync(inputResultsPath)).to.equal(true);
     // Output results
     await outputResults(null, outputResultsPath, inputResultsJSON);
     // Check that output file exists