doc-detective-common 3.6.1 → 4.0.0-beta.0

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

@@ -1,166 +1,166 @@
-{
-  "title": "runShell",
-  "type": "object",
-  "description": "Perform a native shell command.",
-  "properties": {
-    "id": {
-      "type": "string",
-      "description": "ID of the step."
-    },
-    "description": {
-      "type": "string",
-      "description": "Description of the step."
-    },
-    "action": {
-      "type": "string",
-      "const": "runShell",
-      "description": "The action to perform."
-    },
-    "command": {
-      "type": "string",
-      "description": "Command to perform in the machine's default shell."
-    },
-    "args": {
-      "type": "array",
-      "description": "Arguments for the command.",
-      "items": {
-        "oneOf": [
-          {
-            "type": "string"
-          }
-        ]
-      },
-      "default": []
-    },
-    "workingDirectory": {
-      "type": "string",
-      "description": "Working directory for the command.",
-      "default": "."
-    },
-    "exitCodes": {
-      "type": "array",
-      "description": "Expected exit codes of the command. If the command's actual exit code isn't in this list, the step fails.",
-      "items": {
-        "oneOf": [
-          {
-            "type": "integer"
-          }
-        ]
-      },
-      "default": [0]
-    },
-    "output": {
-      "type": "string",
-      "description": "Content expected in the command's output. If the expected content can't be found in the command's output (either stdout or stderr), the step fails. Supports strings and regular expressions. To use a regular expression, the string must start and end with a forward slash, like in `/^hello-world.*/`."
-    },
-    "savePath": {
-      "type": "string",
-      "description": "File path to save the command's output, relative to `saveDirectory`."
-    },
-    "saveDirectory": {
-      "type": "string",
-      "description": "Directory to save the command's output. If the directory doesn't exist, creates the directory. If not specified, the directory is your media directory."
-    },
-    "maxVariation": {
-      "type": "integer",
-      "description": "Allowed variation in percentage of text different between the current output and previously saved output. If the difference between the current output and the previous output is greater than `maxVariation`, the step fails. If output doesn't exist at `savePath`, this value is ignored.",
-      "default": 0,
-      "minimum": 0,
-      "maximum": 100
-    },
-    "overwrite": {
-      "type": "string",
-      "description": "If `true`, overwrites the existing output at `savePath` if it exists.\nIf `byVariation`, overwrites the existing output at `savePath` if the difference between the new output and the existing output is greater than `maxVariation`.",
-      "enum": [
-        "true",
-        "false",
-        "byVariation"
-      ],
-      "default": "false"
-    },
-    "timeout": {
-      "type": "integer",
-      "description": "Max time in milliseconds the command is allowed to run. If the command runs longer than this, the step fails.",
-      "default": 60000
-    },
-    "setVariables": {
-      "type": "array",
-      "description": "Extract environment variables from the command's output.",
-      "items": {
-        "oneOf": [
-          {
-            "description": "",
-            "type": "object",
-            "properties": {
-              "name": {
-                "description": "Name of the environment variable to set.",
-                "type": "string"
-              },
-              "regex": {
-                "description": "Regex to extract the environment variable from the command's output.",
-                "type": "string"
-              }
-            },
-            "required": ["name", "regex"]
-          }
-        ]
-      },
-      "default": []
-    }
-  },
-  "dynamicDefaults": {
-    "id": "uuid"
-  },
-  "additionalProperties": false,
-  "required": ["action", "command"],
-  "examples": [
-    {
-      "action": "runShell",
-      "command": "echo",
-      "args": ["$USER"]
-    },
-    {
-      "action": "runShell",
-      "command": "echo",
-      "args": ["hello-world"],
-      "id": "ddec5e20-2e81-4f38-867c-92c8d9516755",
-      "description": "This is a test!"
-    },
-    {
-      "action": "runShell",
-      "command": "docker run hello-world",
-      "timeout": 20000,
-      "exitCodes": [0],
-      "output": "Hello from Docker!"
-    },
-    {
-      "action": "runShell",
-      "command": "false",
-      "exitCodes": [1]
-    },
-    {
-      "action": "runShell",
-      "command": "echo",
-      "args": ["setup"],
-      "exitCodes": [0],
-      "output": "/.*?/",
-      "setVariables": [
-        {
-          "name": "TEST",
-          "regex": ".*"
-        }
-      ]
-    },
-    {
-      "action": "runShell",
-      "command": "docker run hello-world",
-      "workingDirectory": ".",
-      "exitCodes": [0],
-      "output": "Hello from Docker!",
-      "savePath": "docker-output.txt",
-      "saveDirectory": "output",
-      "maxVariation": 10,
-      "overwrite": "byVariation"
-    }
-  ]
-}
+{
+  "title": "runShell",
+  "type": "object",
+  "description": "Perform a native shell command.",
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "ID of the step."
+    },
+    "description": {
+      "type": "string",
+      "description": "Description of the step."
+    },
+    "action": {
+      "type": "string",
+      "const": "runShell",
+      "description": "The action to perform."
+    },
+    "command": {
+      "type": "string",
+      "description": "Command to perform in the machine's default shell."
+    },
+    "args": {
+      "type": "array",
+      "description": "Arguments for the command.",
+      "items": {
+        "oneOf": [
+          {
+            "type": "string"
+          }
+        ]
+      },
+      "default": []
+    },
+    "workingDirectory": {
+      "type": "string",
+      "description": "Working directory for the command.",
+      "default": "."
+    },
+    "exitCodes": {
+      "type": "array",
+      "description": "Expected exit codes of the command. If the command's actual exit code isn't in this list, the step fails.",
+      "items": {
+        "oneOf": [
+          {
+            "type": "integer"
+          }
+        ]
+      },
+      "default": [0]
+    },
+    "output": {
+      "type": "string",
+      "description": "Content expected in the command's output. If the expected content can't be found in the command's output (either stdout or stderr), the step fails. Supports strings and regular expressions. To use a regular expression, the string must start and end with a forward slash, like in `/^hello-world.*/`."
+    },
+    "savePath": {
+      "type": "string",
+      "description": "File path to save the command's output, relative to `saveDirectory`."
+    },
+    "saveDirectory": {
+      "type": "string",
+      "description": "Directory to save the command's output. If the directory doesn't exist, creates the directory. If not specified, the directory is your media directory."
+    },
+    "maxVariation": {
+      "type": "integer",
+      "description": "Allowed variation in percentage of text different between the current output and previously saved output. If the difference between the current output and the previous output is greater than `maxVariation`, the step fails. If output doesn't exist at `savePath`, this value is ignored.",
+      "default": 0,
+      "minimum": 0,
+      "maximum": 100
+    },
+    "overwrite": {
+      "type": "string",
+      "description": "If `true`, overwrites the existing output at `savePath` if it exists.\nIf `byVariation`, overwrites the existing output at `savePath` if the difference between the new output and the existing output is greater than `maxVariation`.",
+      "enum": [
+        "true",
+        "false",
+        "byVariation"
+      ],
+      "default": "false"
+    },
+    "timeout": {
+      "type": "integer",
+      "description": "Max time in milliseconds the command is allowed to run. If the command runs longer than this, the step fails.",
+      "default": 60000
+    },
+    "setVariables": {
+      "type": "array",
+      "description": "Extract environment variables from the command's output.",
+      "items": {
+        "oneOf": [
+          {
+            "description": "",
+            "type": "object",
+            "properties": {
+              "name": {
+                "description": "Name of the environment variable to set.",
+                "type": "string"
+              },
+              "regex": {
+                "description": "Regex to extract the environment variable from the command's output.",
+                "type": "string"
+              }
+            },
+            "required": ["name", "regex"]
+          }
+        ]
+      },
+      "default": []
+    }
+  },
+  "dynamicDefaults": {
+    "id": "uuid"
+  },
+  "additionalProperties": false,
+  "required": ["action", "command"],
+  "examples": [
+    {
+      "action": "runShell",
+      "command": "echo",
+      "args": ["$USER"]
+    },
+    {
+      "action": "runShell",
+      "command": "echo",
+      "args": ["hello-world"],
+      "id": "ddec5e20-2e81-4f38-867c-92c8d9516755",
+      "description": "This is a test!"
+    },
+    {
+      "action": "runShell",
+      "command": "docker run hello-world",
+      "timeout": 20000,
+      "exitCodes": [0],
+      "output": "Hello from Docker!"
+    },
+    {
+      "action": "runShell",
+      "command": "false",
+      "exitCodes": [1]
+    },
+    {
+      "action": "runShell",
+      "command": "echo",
+      "args": ["setup"],
+      "exitCodes": [0],
+      "output": "/.*?/",
+      "setVariables": [
+        {
+          "name": "TEST",
+          "regex": ".*"
+        }
+      ]
+    },
+    {
+      "action": "runShell",
+      "command": "docker run hello-world",
+      "workingDirectory": ".",
+      "exitCodes": [0],
+      "output": "Hello from Docker!",
+      "savePath": "docker-output.txt",
+      "saveDirectory": "output",
+      "maxVariation": 10,
+      "overwrite": "byVariation"
+    }
+  ]
+}

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

@@ -1,155 +1,155 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "runShell",
-  "description": "Perform a native shell command.",
-  "anyOf": [
-    {
-      "$ref": "#/components/schemas/string"
-    },
-    {
-      "$ref": "#/components/schemas/object"
-    }
-  ],
-  "components": {
-    "schemas": {
-      "string": {
-        "title": "Run shell command (simple)",
-        "description": "Command to perform in the machine's default shell.",
-        "type": "string",
-        "transform": [
-          "trim"
-        ]
-      },
-      "object": {
-        "type": "object",
-        "required": [
-          "command"
-        ],
-        "additionalProperties": false,
-        "properties": {
-          "command": {
-            "type": "string",
-            "description": "Command to perform in the machine's default shell."
-          },
-          "args": {
-            "type": "array",
-            "description": "Arguments for the command.",
-            "items": {
-              "anyOf": [
-                {
-                  "type": "string"
-                }
-              ]
-            },
-            "default": []
-          },
-          "workingDirectory": {
-            "type": "string",
-            "description": "Working directory for the command.",
-            "default": "."
-          },
-          "exitCodes": {
-            "type": "array",
-            "description": "Expected exit codes of the command. If the command's actual exit code isn't in this list, the step fails.",
-            "items": {
-              "anyOf": [
-                {
-                  "type": "integer"
-                }
-              ]
-            },
-            "default": [
-              0
-            ]
-          },
-          "stdio": {
-            "type": "string",
-            "description": "Content expected in the command's stdout or stderr. If the expected content can't be found in the command's stdout or stderr, the step fails. Supports strings and regular expressions. To use a regular expression, the string must start and end with a forward slash, like in `/^hello-world.*/`."
-          },
-          "path": {
-            "type": "string",
-            "description": "File path to save the command's output, relative to `directory`."
-          },
-          "directory": {
-            "type": "string",
-            "description": "Directory to save the command's output. If the directory doesn't exist, creates the directory. If not specified, the directory is your media directory."
-          },
-          "maxVariation": {
-            "type": "number",
-            "description": "Allowed variation in percentage of text different between the current output and previously saved output. If the difference between the current output and the previous output is greater than `maxVariation`, the step fails. If output doesn't exist at `path`, this value is ignored.",
-            "default": 0,
-            "minimum": 0,
-            "maximum": 1
-          },
-          "overwrite": {
-            "type": "string",
-            "description": "If `true`, overwrites the existing output at `path` if it exists.\nIf `aboveVariation`, overwrites the existing output at `path` if the difference between the new output and the existing output is greater than `maxVariation`.",
-            "enum": [
-              "true",
-              "false",
-              "aboveVariation"
-            ],
-            "default": "aboveVariation"
-          },
-          "timeout": {
-            "type": "integer",
-            "description": "Max time in milliseconds the command is allowed to run. If the command runs longer than this, the step fails.",
-            "default": 60000
-          }
-        },
-        "title": "Run shell command (detailed)"
-      }
-    }
-  },
-  "examples": [
-    "docker run hello-world",
-    {
-      "command": "echo",
-      "args": [
-        "$USER"
-      ]
-    },
-    {
-      "command": "echo",
-      "args": [
-        "hello-world"
-      ]
-    },
-    {
-      "command": "docker run hello-world",
-      "timeout": 20000,
-      "exitCodes": [
-        0
-      ],
-      "stdio": "Hello from Docker!"
-    },
-    {
-      "command": "false",
-      "exitCodes": [
-        1
-      ]
-    },
-    {
-      "command": "echo",
-      "args": [
-        "setup"
-      ],
-      "exitCodes": [
-        0
-      ],
-      "stdio": "/.*?/"
-    },
-    {
-      "command": "docker run hello-world",
-      "workingDirectory": ".",
-      "exitCodes": [
-        0
-      ],
-      "stdio": "Hello from Docker!",
-      "path": "docker-output.txt",
-      "directory": "output",
-      "maxVariation": 0.1,
-      "overwrite": "aboveVariation"
-    }
-  ]
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "runShell",
+  "description": "Perform a native shell command.",
+  "anyOf": [
+    {
+      "$ref": "#/components/schemas/string"
+    },
+    {
+      "$ref": "#/components/schemas/object"
+    }
+  ],
+  "components": {
+    "schemas": {
+      "string": {
+        "title": "Run shell command (simple)",
+        "description": "Command to perform in the machine's default shell.",
+        "type": "string",
+        "transform": [
+          "trim"
+        ]
+      },
+      "object": {
+        "type": "object",
+        "required": [
+          "command"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "command": {
+            "type": "string",
+            "description": "Command to perform in the machine's default shell."
+          },
+          "args": {
+            "type": "array",
+            "description": "Arguments for the command.",
+            "items": {
+              "anyOf": [
+                {
+                  "type": "string"
+                }
+              ]
+            },
+            "default": []
+          },
+          "workingDirectory": {
+            "type": "string",
+            "description": "Working directory for the command.",
+            "default": "."
+          },
+          "exitCodes": {
+            "type": "array",
+            "description": "Expected exit codes of the command. If the command's actual exit code isn't in this list, the step fails.",
+            "items": {
+              "anyOf": [
+                {
+                  "type": "integer"
+                }
+              ]
+            },
+            "default": [
+              0
+            ]
+          },
+          "stdio": {
+            "type": "string",
+            "description": "Content expected in the command's stdout or stderr. If the expected content can't be found in the command's stdout or stderr, the step fails. Supports strings and regular expressions. To use a regular expression, the string must start and end with a forward slash, like in `/^hello-world.*/`."
+          },
+          "path": {
+            "type": "string",
+            "description": "File path to save the command's output, relative to `directory`."
+          },
+          "directory": {
+            "type": "string",
+            "description": "Directory to save the command's output. If the directory doesn't exist, creates the directory. If not specified, the directory is your media directory."
+          },
+          "maxVariation": {
+            "type": "number",
+            "description": "Allowed variation in percentage of text different between the current output and previously saved output. If the difference between the current output and the previous output is greater than `maxVariation`, the step fails. If output doesn't exist at `path`, this value is ignored.",
+            "default": 0,
+            "minimum": 0,
+            "maximum": 1
+          },
+          "overwrite": {
+            "type": "string",
+            "description": "If `true`, overwrites the existing output at `path` if it exists.\nIf `aboveVariation`, overwrites the existing output at `path` if the difference between the new output and the existing output is greater than `maxVariation`.",
+            "enum": [
+              "true",
+              "false",
+              "aboveVariation"
+            ],
+            "default": "aboveVariation"
+          },
+          "timeout": {
+            "type": "integer",
+            "description": "Max time in milliseconds the command is allowed to run. If the command runs longer than this, the step fails.",
+            "default": 60000
+          }
+        },
+        "title": "Run shell command (detailed)"
+      }
+    }
+  },
+  "examples": [
+    "docker run hello-world",
+    {
+      "command": "echo",
+      "args": [
+        "$USER"
+      ]
+    },
+    {
+      "command": "echo",
+      "args": [
+        "hello-world"
+      ]
+    },
+    {
+      "command": "docker run hello-world",
+      "timeout": 20000,
+      "exitCodes": [
+        0
+      ],
+      "stdio": "Hello from Docker!"
+    },
+    {
+      "command": "false",
+      "exitCodes": [
+        1
+      ]
+    },
+    {
+      "command": "echo",
+      "args": [
+        "setup"
+      ],
+      "exitCodes": [
+        0
+      ],
+      "stdio": "/.*?/"
+    },
+    {
+      "command": "docker run hello-world",
+      "workingDirectory": ".",
+      "exitCodes": [
+        0
+      ],
+      "stdio": "Hello from Docker!",
+      "path": "docker-output.txt",
+      "directory": "output",
+      "maxVariation": 0.1,
+      "overwrite": "aboveVariation"
+    }
+  ]
 }