doc-detective 2.11.4-dev.1 → 2.11.4-dev.2

package/samples/.doc-detective.json

@@ -1,90 +1,82 @@
-{
-  "envVariables": "./variables.env",
-  "input": ".",
-  "output": ".",
-  "recursive": true,
-  "logLevel": "info",
-  "runTests": {
-    "detectSteps": true,
-    "input": "./doc-content.md",
-    "output": ".",
-    "setup": "",
-    "cleanup": "",
-    "recursive": true,
-    "mediaDirectory": ".",
-    "downloadDirectory": ".",
-    "contexts": [
-      {
-        "app": {
-          "name": "firefox",
-          "options": {
-            "width": 1200,
-            "height": 800,
-            "headless": false
-          }
-        },
-        "platforms": ["linux", "mac", "windows"]
-      }
-    ]
-  },
-  "runCoverage": {
-    "recursive": true,
-    "input": ".",
-    "output": ".",
-    "markup": []
-  },
-  "suggestTests": {
-    "recursive": true,
-    "input": ".",
-    "output": ".",
-    "markup": []
-  },
-  "fileTypes": [
-    {
-      "name": "Markdown",
-      "extensions": [".md"],
-      "testStartStatementOpen": "[comment]: # (test start",
-      "testStartStatementClose": ")",
-      "testIgnoreStatement": "[comment]: # (test ignore)",
-      "testEndStatement": "[comment]: # (test end)",
-      "stepStatementOpen": "[comment]: # (step",
-      "stepStatementClose": ")",
-      "markup": [
-        {
-          "name": "Hyperlink",
-          "regex": ["(?<=(?<!!)\\[[\\w\\s]+\\]\\().*?(?=\\))"],
-          "actions": ["checkLink"]
-        },
-        {
-          "name": "Navigation link",
-          "regex": ["(?<=([Oo]pen|[Cc]lick) (?<!!)\\[[\\w\\s]+\\]\\().*?(?=\\))"],
-          "actions": ["goTo"]
-        },
-        {
-          "name": "Onscreen text",
-          "regex": ["(?<=\\*\\*)[\\w\\s]+?(?=\\*\\*)"],
-          "actions": ["find"]
-        },
-        {
-          "name": "Image",
-          "regex": ["(?<=\\!\\[.*?\\]\\().*?(?=\\))"],
-          "actions": [
-            {
-              "name": "saveScreenshot",
-              "params": {
-                "directory": ".",
-                "maxVariation": 5,
-                "overwrite": "byVariation"
-              }
-            }
-          ]
-        }
-      ]
-    }
-  ],
-  "integrations": {},
-  "telemetry": {
-    "send": true,
-    "userId": "Doc Detective Samples"
-  }
-}
+{
+  "envVariables": "./variables.env",
+  "defaultCommand": "runTests",
+  "input": ".",
+  "output": ".",
+  "recursive": true,
+  "logLevel": "info",
+  "runTests": {
+    "detectSteps": true,
+    "input": "./doc-content-inline-tests.md",
+    "output": ".",
+    "setup": "",
+    "cleanup": "",
+    "recursive": true,
+    "mediaDirectory": ".",
+    "downloadDirectory": ".",
+    "contexts": [
+      {
+        "app": {
+          "name": "chrome",
+          "options": {
+            "headless": false
+          }
+        },
+        "platforms": ["windows", "mac", "linux"]
+      }
+    ]
+  },
+  "runCoverage": {
+    "recursive": true,
+    "input": ".",
+    "output": ".",
+    "markup": []
+  },
+  "fileTypes": [
+    {
+      "name": "Markdown",
+      "extensions": [".md"],
+      "testStartStatementOpen": "[comment]: # (test start",
+      "testStartStatementClose": ")",
+      "testIgnoreStatement": "[comment]: # (test ignore)",
+      "testEndStatement": "[comment]: # (test end)",
+      "stepStatementOpen": "[comment]: # (step",
+      "stepStatementClose": ")",
+      "markup": [
+        {
+          "name": "Hyperlink",
+          "regex": ["(?<!!)\\[.+?\\]\\((.+?)\\)"],
+          "actions": ["checkLink"]
+        },
+        {
+          "name": "Navigation link",
+          "regex": [
+            "(?:[Cc]hose|[Oo]pen|[Cc]lick|[Nn]avigate to|[Gg]o to)\\s+(?<!!)\\[.+?\\]\\((.+?)\\)"
+          ],
+          "actions": ["goTo"]
+        },
+        {
+          "name": "Onscreen text",
+          "regex": ["\\*\\*(.+?)\\*\\*"],
+          "actions": ["find"]
+        },
+        {
+          "name": "Image",
+          "regex": ["!\\[.+?\\]\\((.+?)\\)"],
+          "actions": [
+            {
+              "action": "saveScreenshot",
+              "maxVariation": 5,
+              "overwrite": "byVariation"
+            }
+          ]
+        }
+      ]
+    }
+  ],
+  "integrations": {},
+  "telemetry": {
+    "send": true,
+    "userId": "Doc Detective Samples"
+  }
+}

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

@@ -1,9 +1,11 @@
-# Doc Detective documentation overview
-
-[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**.
-
+# Doc Detective documentation overview
+
+[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,29 +1,29 @@
-# Doc Detective documentation overview
-
-[comment]: # (test start {"id":"search-kittens", "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.
-
-- [Get started](https://doc-detective.com/get-started.html) covers how to quickly get up and running with Doc Detective.
-
-  [comment]: # (step {"action":"checkLink", "url":"https://doc-detective.com/get-started.html"})
-
-- 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**.
-
-  [comment]: # (step {"action":"checkLink", "url":"https://doc-detective.com/reference/"})
-  [comment]: # (step {"action":"checkLink", "url":"https://doc-detective.com/reference/schemas/config.html"})
-  [comment]: # (step {"action":"checkLink", "url":"https://doc-detective.com/reference/schemas/specification.html"})
-  [comment]: # (step {"action":"checkLink", "url":"https://doc-detective.com/reference/schemas/test.html"})
-  [comment]: # (step {"action":"goTo", "url":"https://doc-detective.com/reference/schemas/typeKeys.html"})
-  [comment]: # (step {"action":"find", "selector":"h2#description", "matchText":"Description"})
-  [comment]: # (step {"action":"find", "selector":"h2#fields", "matchText":"Fields"})
-  [comment]: # (step {"action":"find", "selector":"h2#examples", "matchText":"Examples"})
-
-![Search results.](reference.png)
-
-[comment]: # (step {"action":"saveScreenshot", "path":"reference.png", "directory":"samples", "maxVariation":5, "overwrite":"byVariation"})
+# Doc Detective documentation overview
+
+[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.
+
+- [Get started](https://doc-detective.com/get-started.html) covers how to quickly get up and running with Doc Detective.
+
+  [comment]: # (step {"action":"checkLink", "url":"https://doc-detective.com/get-started.html"})
+
+- 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**.
+
+  [comment]: # (step {"action":"checkLink", "url":"https://doc-detective.com/reference/"})
+  [comment]: # (step {"action":"checkLink", "url":"https://doc-detective.com/reference/schemas/config.html"})
+  [comment]: # (step {"action":"checkLink", "url":"https://doc-detective.com/reference/schemas/specification.html"})
+  [comment]: # (step {"action":"checkLink", "url":"https://doc-detective.com/reference/schemas/test.html"})
+  [comment]: # (step {"action":"goTo", "url":"https://doc-detective.com/reference/schemas/typeKeys.html"})
+  [comment]: # (step {"action":"find", "selector":"h2#description", "matchText":"Description"})
+  [comment]: # (step {"action":"find", "selector":"h2#fields", "matchText":"Fields"})
+  [comment]: # (step {"action":"find", "selector":"h2#examples", "matchText":"Examples"})
+
+![Search results.](reference.png)
+
+[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/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