codebaseiq 0.1.0

package/docs/schemas/project-config.schema.json

@@ -0,0 +1,318 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://unpkg.com/codebaseiq/docs/schemas/project-config.schema.json",
+  "title": "codebaseiq project configuration",
+  "description": "Repository-owned indexing, watch, architecture, documentation, and detector policy. Unknown fields are retained for forward-compatible rewrites.",
+  "type": "object",
+  "required": ["schemaVersion"],
+  "additionalProperties": true,
+  "properties": {
+    "$schema": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Editor schema hint. codebaseiq writers default this to the schema bundled in node_modules."
+    },
+    "schemaVersion": {
+      "const": 2,
+      "description": "Persisted project-config format version. Unversioned and explicit version 1 records are readable legacy input."
+    },
+    "collaborationDomainId": {
+      "type": "string",
+      "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89aAbB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$",
+      "description": "Opaque UUID v4 inherited by branches, clones, linked worktrees, and contributor forks intended to merge durable project decisions."
+    },
+    "languages": {
+      "type": "array",
+      "uniqueItems": true,
+      "items": { "$ref": "#/$defs/supportedLanguage" }
+    },
+    "indexerConcurrency": { "type": "integer", "minimum": 1 },
+    "watch": { "$ref": "#/$defs/watch" },
+    "daemon": {
+      "type": "object",
+      "additionalProperties": true,
+      "properties": {
+        "enabled": {
+          "type": "boolean",
+          "description": "Serve eligible evidence commands from the resident watch service (default: false)."
+        }
+      },
+      "description": "Resident query execution settings."
+    },
+    "indexer": {
+      "type": "object",
+      "propertyNames": { "$ref": "#/$defs/supportedLanguage" },
+      "additionalProperties": { "$ref": "#/$defs/indexerOverride" }
+    },
+    "dbPath": { "type": "string", "minLength": 1 },
+    "entryRoots": { "$ref": "#/$defs/entryRoots" },
+    "semantic": { "$ref": "#/$defs/semantic" },
+    "suppressions": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/suppression" }
+    },
+    "declaredCouplings": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/declaredCoupling" }
+    },
+    "locality": { "$ref": "#/$defs/locality" },
+    "architecture": { "$ref": "#/$defs/architecture" },
+    "coverageContracts": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/coverageContract" }
+    },
+    "docs": { "$ref": "#/$defs/docs" }
+  },
+  "$defs": {
+    "supportedLanguage": {
+      "enum": [
+        "typescript",
+        "javascript",
+        "java",
+        "scala",
+        "kotlin",
+        "rust",
+        "python",
+        "ruby",
+        "go",
+        "cpp",
+        "c",
+        "csharp",
+        "vb",
+        "dart",
+        "php",
+        "clojure"
+      ]
+    },
+    "stringArray": {
+      "type": "array",
+      "items": { "type": "string" }
+    },
+    "watch": {
+      "type": "object",
+      "additionalProperties": true,
+      "properties": {
+        "enabled": { "type": "boolean" },
+        "debounceMs": { "type": "integer", "exclusiveMinimum": 0 },
+        "cooldownMs": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Requested milliseconds between reindexes. Values below 5000 are raised to the 5000ms runtime safety floor."
+        },
+        "gitPollMs": { "type": "integer", "exclusiveMinimum": 0 },
+        "idleTimeoutMs": { "type": "integer", "minimum": 0 },
+        "autoRefresh": { "type": "boolean" },
+        "ignore": { "$ref": "#/$defs/stringArray" },
+        "resourceBudget": {
+          "type": "object",
+          "additionalProperties": true,
+          "properties": {
+            "enabled": { "type": "boolean" },
+            "windowMs": { "type": "integer", "exclusiveMinimum": 0 },
+            "maxRebuilds": { "type": "integer", "exclusiveMinimum": 0 },
+            "maxEstimatedWriteBytes": { "type": "integer", "exclusiveMinimum": 0 }
+          }
+        }
+      }
+    },
+    "indexerOverride": {
+      "type": "object",
+      "additionalProperties": true,
+      "properties": {
+        "pnpmWorkspaces": { "type": "boolean" },
+        "projectMode": { "enum": ["single", "workspace"] },
+        "projects": { "$ref": "#/$defs/stringArray" },
+        "configPath": { "type": "string", "minLength": 1 }
+      }
+    },
+    "entryRoots": {
+      "type": "object",
+      "additionalProperties": true,
+      "properties": {
+        "pathPrefixes": { "$ref": "#/$defs/stringArray" },
+        "files": { "$ref": "#/$defs/stringArray" },
+        "symbolPatterns": { "$ref": "#/$defs/stringArray" },
+        "qualifiedVars": { "$ref": "#/$defs/stringArray" }
+      }
+    },
+    "semantic": {
+      "type": "object",
+      "additionalProperties": true,
+      "properties": {
+        "typescript": {
+          "type": "object",
+          "additionalProperties": true,
+          "properties": {
+            "tsconfigs": { "$ref": "#/$defs/stringArray" }
+          }
+        },
+        "rust": {
+          "type": "object",
+          "additionalProperties": true,
+          "properties": {
+            "rustAnalyzerPath": { "type": "string", "minLength": 1 }
+          }
+        }
+      }
+    },
+    "suppression": {
+      "type": "object",
+      "required": ["reason"],
+      "additionalProperties": true,
+      "properties": {
+        "id": { "type": "string", "minLength": 1 },
+        "check": { "type": "string", "minLength": 1 },
+        "file": { "type": "string", "minLength": 1 },
+        "reason": { "type": "string", "minLength": 1 },
+        "expiresAt": { "type": "string", "format": "date-time" },
+        "createdAt": { "type": "string", "format": "date-time" },
+        "decision": {
+          "type": "object",
+          "required": ["kind", "reasonCode", "decidedBy", "policyVersion", "evidence", "invalidateOn"],
+          "additionalProperties": true,
+          "properties": {
+            "kind": { "const": "automated-adjudication" },
+            "reasonCode": {
+              "enum": [
+                "entry-surface",
+                "generated-code",
+                "compatibility-shim",
+                "reflection-or-registration",
+                "test-fixture",
+                "intentional-twin",
+                "historical-coupling-ended",
+                "detector-counterexample"
+              ]
+            },
+            "decidedBy": { "enum": ["agent", "human"] },
+            "policyVersion": { "const": 1 },
+            "observation": { "$ref": "./observation-receipt.schema.json" },
+            "evidence": {
+              "type": "array",
+              "minItems": 1,
+              "items": {
+                "type": "object",
+                "required": ["kind", "referent", "claim"],
+                "additionalProperties": true,
+                "properties": {
+                  "kind": { "enum": ["source", "config", "test", "graph"] },
+                  "referent": { "type": "string", "minLength": 1 },
+                  "claim": { "type": "string", "minLength": 1 },
+                  "contentHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" },
+                  "generation": { "type": "string", "minLength": 1 }
+                }
+              }
+            },
+            "invalidateOn": {
+              "type": "object",
+              "required": ["targetContentChange", "detectorMajorChange"],
+              "additionalProperties": true,
+              "properties": {
+                "targetContentChange": { "type": "boolean" },
+                "detectorMajorChange": { "type": "boolean" }
+              }
+            }
+          }
+        }
+      },
+      "anyOf": [{ "required": ["id"] }, { "required": ["check"] }]
+    },
+    "declaredCoupling": {
+      "type": "object",
+      "required": ["name", "files"],
+      "additionalProperties": true,
+      "properties": {
+        "name": { "type": "string", "minLength": 1 },
+        "files": {
+          "type": "array",
+          "minItems": 2,
+          "uniqueItems": true,
+          "items": { "type": "string", "minLength": 1 }
+        },
+        "reason": { "type": "string" }
+      }
+    },
+    "locality": {
+      "type": "object",
+      "additionalProperties": true,
+      "properties": {
+        "architecturalBoundarySegments": { "$ref": "#/$defs/stringArray" }
+      }
+    },
+    "architectureBoundary": {
+      "type": "object",
+      "required": ["name", "paths"],
+      "additionalProperties": true,
+      "properties": {
+        "name": { "type": "string", "minLength": 1 },
+        "paths": {
+          "type": "array",
+          "minItems": 1,
+          "items": { "type": "string", "minLength": 1 }
+        },
+        "maxFiles": { "type": "integer", "minimum": 1 },
+        "subUnits": { "enum": ["directory", "file"] }
+      }
+    },
+    "architecture": {
+      "type": "object",
+      "required": ["boundaries"],
+      "additionalProperties": true,
+      "properties": {
+        "boundaries": {
+          "type": "array",
+          "items": { "$ref": "#/$defs/architectureBoundary" }
+        },
+        "allowedDependencies": {
+          "type": "object",
+          "additionalProperties": { "$ref": "#/$defs/stringArray" }
+        },
+        "requireCompletePolicy": { "type": "boolean" },
+        "requireCompleteCoverage": { "type": "boolean" },
+        "requireAcyclic": { "type": "boolean" },
+        "requireResolvedBoundaries": { "type": "boolean" },
+        "requireMinimalPolicy": { "type": "boolean" },
+        "maxBoundaryFanOut": { "type": "integer", "minimum": 0 },
+        "maxBoundaryFiles": { "type": "integer", "minimum": 1 },
+        "testPaths": { "$ref": "#/$defs/stringArray" }
+      }
+    },
+    "coverageContract": {
+      "type": "object",
+      "required": ["name", "file", "keys", "mustEqual"],
+      "additionalProperties": true,
+      "properties": {
+        "name": { "type": "string", "minLength": 1 },
+        "file": { "type": "string", "minLength": 1 },
+        "keys": {
+          "type": "object",
+          "required": ["type"],
+          "additionalProperties": true,
+          "properties": {
+            "type": { "enum": ["object-literal-keys", "string-array", "markdown-list"] },
+            "identifier": { "type": "string", "minLength": 1 },
+            "marker": { "type": "string", "minLength": 1 }
+          }
+        },
+        "mustEqual": {
+          "type": "object",
+          "required": ["type"],
+          "additionalProperties": true,
+          "properties": {
+            "type": { "enum": ["top-level-dirs", "file-glob", "registered-commands", "builtin-skills"] },
+            "path": { "type": "string", "minLength": 1 },
+            "pattern": { "type": "string", "minLength": 1 }
+          }
+        },
+        "allowExtra": { "type": "boolean" }
+      }
+    },
+    "docs": {
+      "type": "object",
+      "additionalProperties": true,
+      "properties": {
+        "snapshotPaths": { "$ref": "#/$defs/stringArray" }
+      }
+    }
+  }
+}

package/docs/schemas/suppression-record.schema.json

@@ -0,0 +1,79 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://unpkg.com/codebaseiq/docs/schemas/suppression-record.schema.json",
+  "title": "codebaseiq suppression record v2",
+  "description": "A repository-owned policy decision stored as one file under .codebaseiq/suppressions/.",
+  "type": "object",
+  "required": ["kind", "schemaVersion", "suppressionIdentity", "writer", "reason", "createdAt", "decision"],
+  "properties": {
+    "kind": { "const": "codebaseiq-suppression" },
+    "schemaVersion": { "const": 2 },
+    "suppressionIdentity": { "type": "string", "minLength": 1 },
+    "writer": {
+      "type": "object",
+      "required": ["tool", "version"],
+      "properties": {
+        "tool": { "const": "codebaseiq" },
+        "version": { "type": "string", "minLength": 1 }
+      },
+      "additionalProperties": true
+    },
+    "id": { "type": "string", "minLength": 1 },
+    "check": { "type": "string", "minLength": 1 },
+    "file": { "type": "string", "minLength": 1 },
+    "reason": { "type": "string", "minLength": 1 },
+    "decision": {
+      "type": "object",
+      "required": ["kind", "reasonCode", "decidedBy", "policyVersion", "evidence", "invalidateOn"],
+      "properties": {
+        "kind": { "const": "automated-adjudication" },
+        "reasonCode": {
+          "enum": [
+            "entry-surface",
+            "generated-code",
+            "compatibility-shim",
+            "reflection-or-registration",
+            "test-fixture",
+            "intentional-twin",
+            "historical-coupling-ended",
+            "detector-counterexample"
+          ]
+        },
+        "decidedBy": { "enum": ["agent", "human"] },
+        "policyVersion": { "const": 1 },
+        "observation": { "$ref": "./observation-receipt.schema.json" },
+        "evidence": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "type": "object",
+            "required": ["kind", "referent", "claim"],
+            "properties": {
+              "kind": { "enum": ["source", "config", "test", "graph"] },
+              "referent": { "type": "string", "minLength": 1 },
+              "claim": { "type": "string", "minLength": 1 },
+              "contentHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" },
+              "generation": { "type": "string", "minLength": 1 }
+            },
+            "additionalProperties": true
+          }
+        },
+        "invalidateOn": {
+          "type": "object",
+          "required": ["targetContentChange", "detectorMajorChange"],
+          "properties": {
+            "targetContentChange": { "type": "boolean" },
+            "detectorMajorChange": { "type": "boolean" }
+          },
+          "additionalProperties": true
+        }
+      },
+      "additionalProperties": true
+    },
+    "expiresAt": { "type": "string", "format": "date-time" },
+    "createdAt": { "type": "string", "format": "date-time" },
+    "updatedAt": { "type": "string", "format": "date-time" }
+  },
+  "anyOf": [{ "required": ["id"] }, { "required": ["check"] }],
+  "additionalProperties": true
+}

package/docs/schemas/windows-sidecar-provenance.schema.json

@@ -0,0 +1,137 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/PlunderStruck/codebaseiq/blob/main/docs/schemas/windows-sidecar-provenance.schema.json",
+  "title": "codebaseiq Windows sidecar provenance",
+  "type": "object",
+  "required": ["kind", "schemaVersion", "package", "source", "toolchain", "build", "binaries"],
+  "properties": {
+    "kind": {
+      "const": "codebaseiq-windows-sidecar-provenance"
+    },
+    "schemaVersion": {
+      "const": 1
+    },
+    "package": {
+      "type": "object",
+      "required": ["name", "version"],
+      "properties": {
+        "name": {
+          "const": "codebaseiq-windows"
+        },
+        "version": {
+          "type": "string",
+          "minLength": 1
+        }
+      },
+      "additionalProperties": true
+    },
+    "source": {
+      "type": "object",
+      "required": ["repository", "tag", "commit"],
+      "properties": {
+        "repository": {
+          "type": "string",
+          "minLength": 1
+        },
+        "tag": {
+          "type": "string",
+          "minLength": 1
+        },
+        "commit": {
+          "type": "string",
+          "pattern": "^[a-f0-9]{40}$"
+        }
+      },
+      "additionalProperties": true
+    },
+    "toolchain": {
+      "type": "object",
+      "required": ["goVersion"],
+      "properties": {
+        "goVersion": {
+          "type": "string",
+          "pattern": "^go[0-9]+\\.[0-9]+"
+        }
+      },
+      "additionalProperties": true
+    },
+    "build": {
+      "type": "object",
+      "required": ["command", "package", "flags", "environment"],
+      "properties": {
+        "command": {
+          "const": "go build"
+        },
+        "package": {
+          "const": "./cmd/scip"
+        },
+        "flags": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "environment": {
+          "type": "object",
+          "required": ["CGO_ENABLED", "GOOS"],
+          "properties": {
+            "CGO_ENABLED": {
+              "const": "0"
+            },
+            "GOOS": {
+              "const": "windows"
+            }
+          },
+          "additionalProperties": true
+        }
+      },
+      "additionalProperties": true
+    },
+    "binaries": {
+      "type": "array",
+      "minItems": 2,
+      "maxItems": 2,
+      "items": {
+        "type": "object",
+        "required": ["filename", "target", "size", "sha256", "peMachine", "peMachineCode"],
+        "properties": {
+          "filename": {
+            "enum": ["scip-win32-x64.exe", "scip-win32-arm64.exe"]
+          },
+          "target": {
+            "type": "object",
+            "required": ["goos", "goarch", "packageArch"],
+            "properties": {
+              "goos": {
+                "const": "windows"
+              },
+              "goarch": {
+                "enum": ["amd64", "arm64"]
+              },
+              "packageArch": {
+                "enum": ["x64", "arm64"]
+              }
+            },
+            "additionalProperties": true
+          },
+          "size": {
+            "type": "integer",
+            "minimum": 1
+          },
+          "sha256": {
+            "type": "string",
+            "pattern": "^[a-f0-9]{64}$"
+          },
+          "peMachine": {
+            "enum": ["AMD64", "ARM64"]
+          },
+          "peMachineCode": {
+            "enum": ["0x8664", "0xaa64"]
+          }
+        },
+        "additionalProperties": true
+      }
+    }
+  },
+  "additionalProperties": true
+}