doc-detective-common 3.1.0-dev.1 → 3.1.0-dev.2

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

@@ -97,9 +97,9 @@
       "description": "Whether or not to detect steps in input files based on defined markup.",
       "default": true
     },
-    "allowUnsafeTests": {
+    "allowUnsafeSteps": {
       "type": "boolean",
-      "description": "Whether or not to run potentially unsafe tests, such as those that execute shell commands or run code."
+      "description": "Whether or not to run potentially unsafe steps, such as those that might modify files or system state."
     },
     "logLevel": {
       "description": "Amount of detail to output when performing an operation.",

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

@@ -49,7 +49,7 @@
       },
       "unsafe": {
         "type": "boolean",
-        "description": "Whether or not the test or step is may be unsafe. Unsafe tests and steps may perform actions that could modify the system or environment in unexpected ways. Tests that contain unsafe steps are only performed within Docker containers or if unsafe tests are enabled with the `allowUnsafeTests` config property or the `--unsafe` flag.",
+        "description": "Whether or not the step may be unsafe. Unsafe steps may perform actions that could modify the system or environment in unexpected ways. Unsafe steps are only performed within Docker containers or if unsafe steps are enabled with the `allowUnsafeSteps` config property or the `--allow-unsafe` flag.",
         "default": false
       },
       "outputs": {

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

@@ -16,11 +16,6 @@
       "type": "string",
       "description": "Path to the content that the test is associated with."
     },
-    "unsafe": {
-      "type": "boolean",
-      "description": "Whether or not the test or step is may be unsafe. Unsafe tests and steps may perform actions that could modify the system or environment in unexpected ways. Tests that contain unsafe steps are only performed within Docker containers or if unsafe tests are enabled with the `allowUnsafeTests` config property or the `--unsafe` flag.",
-      "default": false
-    },
     "detectSteps": {
       "type": "boolean",
       "description": "Whether or not to detect steps in input files based on markup regex.",
@@ -74,11 +69,6 @@
           "openApi": {
             "$ref": "#/components/schemas/openApi"
           },
-          "unsafe": {
-            "type": "boolean",
-            "description": "Whether or not the test or step is may be unsafe. Unsafe tests and steps may perform actions that could modify the system or environment in unexpected ways. Tests that contain unsafe steps are only performed within Docker containers or if unsafe tests are enabled with the `allowUnsafeTests` config property or the `--unsafe` flag.",
-            "default": false
-          },
           "steps": {
             "description": "Steps to perform as part of the test. Performed in the sequence defined. If one or more actions fail, the test fails. By default, if a step fails, the test stops and the remaining steps are not executed.",
             "type": "array",
@@ -157,7 +147,6 @@
       "description": "This test includes every property across all actions.",
       "before": "setup.json",
       "after": "cleanup.json",
-      "unsafe": true,
       "runOn": [
         {
           "platforms": ["linux"],

package/src/validate.js

@@ -353,14 +353,7 @@ function transformToSchemaKey({
       object: transformedObject,
     });
     if (!result.valid) {
-      throw new Error(`Invalid object: ${result.errors
-        .map(
-          (error) =>
-            `${error.instancePath} ${error.message} (${JSON.stringify(
-              error.params
-            )})`
-        )
-        .join(", ")}`);
+      throw new Error(`Invalid object: ${result.errors}`);
     }
     return result.object;
   } else if (targetSchema === "config_v3") {
@@ -453,14 +446,7 @@ function transformToSchemaKey({
       object: transformedObject,
     });
     if (!result.valid) {
-      throw new Error(`Invalid object: ${result.errors
-        .map(
-          (error) =>
-            `${error.instancePath} ${error.message} (${JSON.stringify(
-              error.params
-            )})`
-        )
-        .join(", ")}`);
+      throw new Error(`Invalid object: ${result.errors}`);
     }
     return result.object;
   } else if (targetSchema === "context_v3") {
@@ -488,14 +474,7 @@ function transformToSchemaKey({
       object: transformedObject,
     });
     if (!result.valid) {
-      throw new Error(`Invalid object: ${result.errors
-        .map(
-          (error) =>
-            `${error.instancePath} ${error.message} (${JSON.stringify(
-              error.params
-            )})`
-        )
-        .join(", ")}`);
+      throw new Error(`Invalid object: ${result.errors}`);
     }
     return result.object;
   } else if (targetSchema === "openApi_v3") {
@@ -511,14 +490,7 @@ function transformToSchemaKey({
       object: transformedObject,
     });
     if (!result.valid) {
-      throw new Error(`Invalid object: ${result.errors
-        .map(
-          (error) =>
-            `${error.instancePath} ${error.message} (${JSON.stringify(
-              error.params
-            )})`
-        )
-        .join(", ")}`);
+      throw new Error(`Invalid object: ${result.errors}`);
     }
     return transformedObject;
   } else if (targetSchema === "spec_v3") {
@@ -557,14 +529,7 @@ function transformToSchemaKey({
       object: transformedObject,
     });
     if (!result.valid) {
-      throw new Error(`Invalid object: ${result.errors
-        .map(
-          (error) =>
-            `${error.instancePath} ${error.message} (${JSON.stringify(
-              error.params
-            )})`
-        )
-        .join(", ")}`);
+      throw new Error(`Invalid object: ${result.errors}`);
     }
     return result.object;
   } else if (targetSchema === "test_v3") {
@@ -606,14 +571,7 @@ function transformToSchemaKey({
       object: transformedObject,
     });
     if (!result.valid) {
-      throw new Error(`Invalid object: ${result.errors
-        .map(
-          (error) =>
-            `${error.instancePath} ${error.message} (${JSON.stringify(
-              error.params
-            )})`
-        )
-        .join(", ")}`);
+      throw new Error(`Invalid object: ${result.errors}`);
     }
     return result.object;
   }