Add CodeTF failure state to result

pixee · May 23, 2024 · baa28ca · baa28ca
1 parent 6657b2b
commit baa28ca
Showing 1 changed file with 28 additions and 0 deletions.
diff --git a/codetf.schema.json b/codetf.schema.json
@@ -87,6 +87,34 @@
           "description": "Vendor-specific properties to help storytelling",
           "additionalProperties": true
         },
+        "failureState": {
+          "type": "object",
+          "properties": {
+            "failed": {
+              "type": "boolean",
+              "description": "Whether the codemod entirely failed to run"
+            },
+            "reason": {
+              "type": "string",
+              "description": "A short description of why the codemod failed"
+            },
+            "exception": {
+              "type": "string",
+              "description": "More detailed information about the exception that caused the failure"
+            }
+          },
+          "if": {
+            "properties": {
+              "failed": { "const": true }
+            }
+          },
+          "then": {
+            "required": ["failed", "reason"]
+          },
+          "else": {
+            "required": ["failed"]
+          }
+        },
         "failedFiles": {
           "type": "array",
           "description": "A set of file paths for files that the tool failed to parse or transform",