doc-detective-common 3.0.4-dev.2 → 3.0.5

package/src/schemas/src_schemas/checkLink_v3.schema.json

@@ -12,27 +12,37 @@
   "components": {
     "schemas": {
       "string": {
+        "title": "Check link (detailed)",
         "description": "Check if an HTTP or HTTPS URL returns an acceptable status code from a GET request.",
         "type": "string",
         "pattern": "(^(http://|https://|\\/).*|\\$[A-Za-z0-9_]+$)",
-        "transform": ["trim"]
+        "transform": [
+          "trim"
+        ]
       },
       "object": {
+        "title": "Check link (detailed)",
         "description": "Check if an HTTP or HTTPS URL returns an acceptable status code from a GET request.",
         "type": "object",
         "additionalProperties": false,
-        "required": ["url"],
+        "required": [
+          "url"
+        ],
         "properties": {
           "url": {
             "type": "string",
             "description": "URL to check. Can be a full URL or a path. If a path is provided, `origin` must be specified.",
             "pattern": "(^(http://|https://|/).*|\\$[A-Za-z0-9_]+)",
-            "transform": ["trim"]
+            "transform": [
+              "trim"
+            ]
           },
           "origin": {
             "type": "string",
             "description": "Protocol and domain to navigate to. Prepended to `url`.",
-            "transform": ["trim"]
+            "transform": [
+              "trim"
+            ]
           },
           "statusCodes": {
             "description": "Accepted status codes. If the specified URL returns a code other than what is specified here, the action fails.",
@@ -51,7 +61,13 @@
                 }
               }
             ],
-            "default": [200, 301, 302, 307, 308]
+            "default": [
+              200,
+              301,
+              302,
+              307,
+              308
+            ]
           }
         }
       }
@@ -67,7 +83,9 @@
     {
       "url": "/search",
       "origin": "www.google.com",
-      "statusCodes": [200]
+      "statusCodes": [
+        200
+      ]
     }
   ]
-}
+}

package/src/schemas/src_schemas/click_v3.schema.json

@@ -16,24 +16,32 @@
   "components": {
     "schemas": {
       "string": {
-        "title": "Find element (simple)",
+        "title": "Click element (simple)",
         "type": "string",
         "description": "Display text or selector of the element to find."
       },
       "button": {
         "description": "Kind of click to perform.",
         "type": "string",
-        "enum": ["left", "right", "middle"]
+        "enum": [
+          "left",
+          "right",
+          "middle"
+        ]
       },
       "object": {
         "title": "Click element (detailed)",
         "type": "object",
         "anyOf": [
           {
-            "required": ["selector"]
+            "required": [
+              "selector"
+            ]
           },
           {
-            "required": ["elementText"]
+            "required": [
+              "elementText"
+            ]
           }
         ],
         "properties": {
@@ -65,4 +73,4 @@
       "button": "middle"
     }
   ]
-}
+}

package/src/schemas/src_schemas/config_v3.schema.json

@@ -39,7 +39,10 @@
     "relativePathBase": {
       "description": "Whether paths should be interpreted as relative to the current working directory (`cwd`) or to the file in which they're specified (`file`).",
       "type": "string",
-      "enum": ["cwd", "file"],
+      "enum": [
+        "cwd",
+        "file"
+      ],
       "default": "file"
     },
     "loadVariables": {
@@ -93,7 +96,13 @@
     "logLevel": {
       "description": "Amount of detail to output when performing an operation.",
       "type": "string",
-      "enum": ["silent", "error", "warning", "info", "debug"],
+      "enum": [
+        "silent",
+        "error",
+        "warning",
+        "info",
+        "debug"
+      ],
       "default": "info"
     },
     "runOn": {
@@ -101,7 +110,11 @@
     },
     "fileTypes": {
       "description": "Configuration for file types and their markup detection.",
-      "default": ["markdown", "asciidoc", "html"],
+      "default": [
+        "markdown",
+        "asciidoc",
+        "html"
+      ],
       "anyOf": [
         {
           "type": "array",
@@ -110,15 +123,21 @@
             "anyOf": [
               {
                 "$comment": "Simple mode: Reference predefined templates by name.",
-                "title": "Predefined",
+                "title": "File type (predefined)",
                 "type": "string",
-                "enum": ["markdown", "asciidoc", "html"]
+                "enum": [
+                  "markdown",
+                  "asciidoc",
+                  "html"
+                ]
               },
               {
                 "$comment": "Custom mode: Extend predefined templates or write whole new ones.",
-                "title": "Custom",
+                "title": "File type (custom)",
                 "type": "object",
-                "required": ["extensions"],
+                "required": [
+                  "extensions"
+                ],
                 "properties": {
                   "name": {
                     "description": "Name of the file type.",
@@ -128,7 +147,11 @@
                     "$comment": "In development",
                     "description": "Base template to extend.",
                     "type": "string",
-                    "enum": ["markdown", "asciidoc", "html"]
+                    "enum": [
+                      "markdown",
+                      "asciidoc",
+                      "html"
+                    ]
                   },
                   "extensions": {
                     "description": "File extensions to use with type.",
@@ -145,15 +168,19 @@
                     "description": "Markup definitions for the file type.",
                     "type": "array",
                     "minItems": 1,
-                    "items": { "$ref": "#/components/schemas/markupDefinition" }
+                    "items": {
+                      "$ref": "#/components/schemas/markupDefinition"
+                    }
                   }
                 }
               },
               {
-                "title": "Executable",
+                "title": "File type (executable)",
                 "$comment": "Executable mode: Convert executable inputs directly into tests.",
                 "type": "object",
-                "required": ["extensions"],
+                "required": [
+                  "extensions"
+                ],
                 "properties": {
                   "extensions": {
                     "description": "File extensions to use with type.",
@@ -186,7 +213,8 @@
         "openApi": {
           "$ref": "test_v3.schema.json#/properties/openApi"
         }
-      }
+      },
+      "title": "Integrations options"
     },
     "telemetry": {
       "description": "Options around sending telemetry for Doc Detective usage.",
@@ -203,10 +231,13 @@
           "type": "string"
         }
       },
-      "required": ["send"],
+      "required": [
+        "send"
+      ],
       "default": {
         "send": true
-      }
+      },
+      "title": "Telemetry options"
     },
     "environment": {
       "$ref": "#/components/schemas/environment"
@@ -217,9 +248,11 @@
       "environment": {
         "type": "object",
         "description": "Environment information for the system running Doc Detective.",
-        "readmeOnly": true,
+        "readOnly": true,
         "additionalProperties": false,
-        "required": ["platform"],
+        "required": [
+          "platform"
+        ],
         "properties": {
           "workingDirectory": {
             "description": "The current working directory of the process running Doc Detective.",
@@ -244,7 +277,8 @@
               "x64"
             ]
           }
-        }
+        },
+        "title": "Environment details"
       },
       "markupDefinition": {
         "type": "object",
@@ -279,13 +313,16 @@
                     {
                       "$ref": "#/components/schemas/markupActionString"
                     },
-                    { "$ref": "step_v3.schema.json#" }
+                    {
+                      "$ref": "step_v3.schema.json#"
+                    }
                   ]
                 }
               }
             ]
           }
-        }
+        },
+        "title": "Markup definition"
       },
       "markupActionString": {
         "type": "string",
@@ -349,7 +386,8 @@
               }
             ]
           }
-        }
+        },
+        "title": "Inline statement definition"
       },
       "stringOrArray": {
         "anyOf": [
@@ -374,13 +412,19 @@
       "output": ".",
       "recursive": true,
       "loadVariables": ".env",
-      "fileTypes": ["markdown"]
+      "fileTypes": [
+        "markdown"
+      ]
     },
     {
       "fileTypes": [
         {
           "extends": "markdown",
-          "extensions": ["md", "markdown", "mdx"],
+          "extensions": [
+            "md",
+            "markdown",
+            "mdx"
+          ],
           "inlineStatements": {
             "testStart": "<!--\\s*testStart\\s*(.*?)\\s*-->",
             "testEnd": "<!-- testEnd -->",
@@ -438,4 +482,4 @@
       }
     }
   ]
-}
+}

package/src/schemas/src_schemas/context_v3.schema.json

@@ -39,8 +39,12 @@
           "type": "array",
           "items": {
             "anyOf": [
-              { "$ref": "#/components/schemas/browserName" },
-              { "$ref": "#/components/schemas/browser" }
+              {
+                "$ref": "#/components/schemas/browserName"
+              },
+              {
+                "$ref": "#/components/schemas/browser"
+              }
             ]
           }
         }
@@ -51,18 +55,29 @@
     "schemas": {
       "platform": {
         "type": "string",
-        "enum": ["linux", "mac", "windows"]
+        "enum": [
+          "linux",
+          "mac",
+          "windows"
+        ]
       },
       "browserName": {
         "type": "string",
         "description": "Name of the browser.",
-        "enum": ["chrome", "firefox", "safari", "webkit"],
+        "enum": [
+          "chrome",
+          "firefox",
+          "safari",
+          "webkit"
+        ],
         "$comment": "`safari` is just a shortcut for `webkit`. Included for visibility and to reduce questions."
       },
       "browser": {
         "type": "object",
         "description": "Browser configuration.",
-        "required": ["name"],
+        "required": [
+          "name"
+        ],
         "additionalProperties": false,
         "properties": {
           "name": {
@@ -86,7 +101,8 @@
                 "type": "integer",
                 "description": "Height of the browser window in pixels."
               }
-            }
+            },
+            "title": "Browser Window"
           },
           "viewport": {
             "type": "object",
@@ -101,9 +117,11 @@
                 "type": "integer",
                 "description": "Height of the viewport in pixels."
               }
-            }
+            },
+            "title": "Browser Viewport"
           }
-        }
+        },
+        "title": "Browser"
       }
     }
   },
@@ -113,8 +131,16 @@
       "browsers": "chrome"
     },
     {
-      "platforms": ["windows", "mac", "linux"],
-      "browsers": ["chrome", "firefox", "webkit"]
+      "platforms": [
+        "windows",
+        "mac",
+        "linux"
+      ],
+      "browsers": [
+        "chrome",
+        "firefox",
+        "webkit"
+      ]
     },
     {
       "browsers": {
@@ -134,14 +160,21 @@
       ]
     },
     {
-      "platforms": ["mac", "linux"],
+      "platforms": [
+        "mac",
+        "linux"
+      ],
       "browsers": {
         "name": "chrome",
         "headless": true
       }
     },
     {
-      "platforms": ["windows", "mac", "linux"],
+      "platforms": [
+        "windows",
+        "mac",
+        "linux"
+      ],
       "browsers": [
         {
           "name": "chrome",
@@ -185,4 +218,4 @@
       ]
     }
   ]
-}
+}

package/src/schemas/src_schemas/find_v3.schema.json

@@ -22,10 +22,14 @@
         "type": "object",
         "anyOf": [
           {
-            "required": ["selector"]
+            "required": [
+              "selector"
+            ]
           },
           {
-            "required": ["elementText"]
+            "required": [
+              "elementText"
+            ]
           }
         ],
         "additionalProperties": false,
@@ -60,7 +64,8 @@
                   "button": {
                     "$ref": "click_v3.schema.json#/components/schemas/button"
                   }
-                }
+                },
+                "title": "Find element and click"
               }
             ]
           },
@@ -73,7 +78,11 @@
               {
                 "not": {
                   "type": "object",
-                  "required": ["selector", "elementText"]
+                  "required": [
+                    "selector",
+                    "elementText"
+                  ],
+                  "title": "Find element and type"
                 }
               }
             ]
@@ -108,9 +117,11 @@
       "moveTo": true,
       "click": true,
       "type": {
-        "keys": ["shorthair cat"],
+        "keys": [
+          "shorthair cat"
+        ],
         "inputDelay": 100
       }
     }
   ]
-}
+}

package/src/schemas/src_schemas/goTo_v3.schema.json

@@ -12,29 +12,39 @@
   "components": {
     "schemas": {
       "string": {
+        "title": "Go to URL (simple)",
         "description": "Navigate to an HTTP or HTTPS URL. Can be a full URL or a path. If a path is provided, navigates relative to the current URL, if any.",
         "type": "string",
-        "pattern": "(^(http://|https://|\/).*|\\$[A-Za-z0-9_]+)",
-        "transform": ["trim"]
+        "pattern": "(^(http://|https://|/).*|\\$[A-Za-z0-9_]+)",
+        "transform": [
+          "trim"
+        ]
       },
       "object": {
         "description": "Navigate to an HTTP or HTTPS URL.",
         "type": "object",
         "additionalProperties": false,
-        "required": ["url"],
+        "required": [
+          "url"
+        ],
         "properties": {
           "url": {
             "type": "string",
             "description": "URL to navigate to. Can be a full URL or a path. If a path is provided and `origin` is specified, prepends `origin` to `url`. If a path is provided but `origin` isn't specified, attempts to navigate relative to the current URL, if any.",
             "pattern": "(^(http://|https://|/).*|\\$[A-Za-z0-9_]+)",
-            "transform": ["trim"]
+            "transform": [
+              "trim"
+            ]
           },
           "origin": {
             "type": "string",
             "description": "Protocol and domain to navigate to. Prepended to `url`.",
-            "transform": ["trim"]
+            "transform": [
+              "trim"
+            ]
           }
-        }
+        },
+        "title": "Go to URL (detailed)"
       }
     }
   },
@@ -49,4 +59,4 @@
       "origin": "www.google.com"
     }
   ]
-}
+}