Make reason we failed to fix more informative

pixee · Apr 3, 2024 · 27e8036 · 27e8036
1 parent 1b6e4e4
commit 27e8036
Showing 1 changed file with 28 additions and 3 deletions.
diff --git a/codetf.schema.json b/codetf.schema.json
@@ -237,9 +237,34 @@
             "description": "Whether the finding was fixed by the codemod"
           },
           "reason": {
-            "type": "string",
-            "description": "Reason the finding was not fixed"
-          }
+            "type": "array",
+            "items": {
+              "failure": {
+                "type": "object",
+                "properties": {
+                  "description": {
+                    "type": "string"
+                    "description": "A human-readable description of the reason the fix failed at this location",
+                  },
+                  "path": {
+                    "type": "string",
+                    "description": "Path of the file where the fix failed to apply",
+                  },
+                  "line": {
+                    "type": "integer",
+                    "description": "(Optional) line number where the fix failed to apply",
+                  },
+                  "snippet": {
+                    "type": "string"
+                    "description": "(Optional) snippet of code that we failed to fix",
+                  }
+                },
+                "required": ["description", "path"],
+                "additionalProperties": true
+              }
+            },
+            "minItems": 1
+          },
         },
         "additionalProperties": true,
         "required": ["id", "fixed"],