@vertaaux/cli 0.2.0

package/schemas/vertaaux.config.schema.json

@@ -0,0 +1,103 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://vertaaux.ai/schemas/config.json",
+  "title": "VertaaUX Configuration",
+  "description": "Configuration schema for VertaaUX CLI (.vertaaux.yml, .vertaaux.json)",
+  "type": "object",
+  "properties": {
+    "$schema": {
+      "type": "string",
+      "description": "JSON Schema reference for editor autocompletion"
+    },
+    "apiKey": {
+      "type": "string",
+      "description": "API key for authentication. Prefer VERTAAUX_API_KEY environment variable for security."
+    },
+    "defaultUrl": {
+      "type": "string",
+      "format": "uri",
+      "description": "Default URL to audit when none provided"
+    },
+    "mode": {
+      "type": "string",
+      "enum": ["basic", "standard", "deep"],
+      "default": "basic",
+      "description": "Audit depth: basic (fast), standard (balanced), deep (comprehensive)"
+    },
+    "output": {
+      "type": "object",
+      "description": "Output configuration",
+      "properties": {
+        "format": {
+          "type": "string",
+          "enum": ["auto", "json", "sarif", "junit", "html", "human"],
+          "default": "auto",
+          "description": "Output format. 'auto' detects based on environment."
+        },
+        "groupBy": {
+          "type": "string",
+          "enum": ["severity", "category", "route"],
+          "default": "severity",
+          "description": "How to group issues in output"
+        }
+      },
+      "additionalProperties": false
+    },
+    "threshold": {
+      "type": "number",
+      "minimum": 0,
+      "maximum": 100,
+      "description": "Minimum passing score (0-100). Exit code 3 if below."
+    },
+    "failOn": {
+      "type": "string",
+      "enum": ["error", "warning", "info"],
+      "description": "Exit code 1 if issues at or above this severity"
+    },
+    "baseline": {
+      "type": "object",
+      "description": "Baseline configuration for tracking known issues",
+      "properties": {
+        "path": {
+          "type": "string",
+          "default": ".vertaaux/baseline.json",
+          "description": "Path to baseline file"
+        },
+        "autoUpdate": {
+          "type": "boolean",
+          "default": false,
+          "description": "Automatically update baseline with fixed issues"
+        }
+      },
+      "additionalProperties": false
+    },
+    "ci": {
+      "type": "object",
+      "description": "CI-specific configuration",
+      "properties": {
+        "template": {
+          "type": "string",
+          "enum": ["github", "gitlab", "circleci", "azure", "jenkins", "none"],
+          "default": "none",
+          "description": "CI template for output formatting"
+        }
+      },
+      "additionalProperties": false
+    },
+    "timeout": {
+      "type": "number",
+      "minimum": 1000,
+      "maximum": 600000,
+      "default": 60000,
+      "description": "Audit timeout in milliseconds"
+    },
+    "interval": {
+      "type": "number",
+      "minimum": 1000,
+      "maximum": 60000,
+      "default": 5000,
+      "description": "Poll interval in milliseconds when waiting for audit"
+    }
+  },
+  "additionalProperties": false
+}