@mgiles/perk 1.0.1 → 2.0.0

package/shared/schemas/outputs/doctor-report.schema.json

@@ -0,0 +1,236 @@
+{
+  "$defs": {
+    "ArtifactHealthOut": {
+      "additionalProperties": false,
+      "description": "The serialization boundary of one :class:`ArtifactHealth` row (field order load-bearing).",
+      "properties": {
+        "key": {
+          "title": "Key",
+          "type": "string"
+        },
+        "path": {
+          "title": "Path",
+          "type": "string"
+        },
+        "kind": {
+          "title": "Kind",
+          "type": "string"
+        },
+        "status": {
+          "enum": [
+            "up-to-date",
+            "not-installed",
+            "locally-modified",
+            "changed-upstream",
+            "state-missing"
+          ],
+          "title": "Status",
+          "type": "string"
+        },
+        "recorded_version": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "title": "Recorded Version"
+        },
+        "recorded_hash": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "title": "Recorded Hash"
+        },
+        "desired_hash": {
+          "title": "Desired Hash",
+          "type": "string"
+        },
+        "observed_hash": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "title": "Observed Hash"
+        }
+      },
+      "required": [
+        "key",
+        "path",
+        "kind",
+        "status",
+        "recorded_version",
+        "recorded_hash",
+        "desired_hash",
+        "observed_hash"
+      ],
+      "title": "ArtifactHealthOut",
+      "type": "object"
+    },
+    "CheckOut": {
+      "additionalProperties": false,
+      "description": "The serialization boundary of one :class:`Check` (field order load-bearing).",
+      "properties": {
+        "name": {
+          "title": "Name",
+          "type": "string"
+        },
+        "group": {
+          "title": "Group",
+          "type": "string"
+        },
+        "status": {
+          "enum": [
+            "ok",
+            "warn",
+            "info",
+            "fail"
+          ],
+          "title": "Status",
+          "type": "string"
+        },
+        "message": {
+          "title": "Message",
+          "type": "string"
+        },
+        "detail": {
+          "title": "Detail",
+          "type": "string"
+        },
+        "remediation": {
+          "title": "Remediation",
+          "type": "string"
+        }
+      },
+      "required": [
+        "name",
+        "group",
+        "status",
+        "message",
+        "detail",
+        "remediation"
+      ],
+      "title": "CheckOut",
+      "type": "object"
+    },
+    "SummaryOut": {
+      "additionalProperties": false,
+      "description": "The computed status tally (field order load-bearing).",
+      "properties": {
+        "passed": {
+          "title": "Passed",
+          "type": "integer"
+        },
+        "warnings": {
+          "title": "Warnings",
+          "type": "integer"
+        },
+        "failed": {
+          "title": "Failed",
+          "type": "integer"
+        }
+      },
+      "required": [
+        "passed",
+        "warnings",
+        "failed"
+      ],
+      "title": "SummaryOut",
+      "type": "object"
+    }
+  },
+  "additionalProperties": false,
+  "description": "The ``--json`` serialization boundary of :class:`DoctorReport` (field order load-bearing).",
+  "properties": {
+    "success": {
+      "title": "Success",
+      "type": "boolean"
+    },
+    "healthy": {
+      "title": "Healthy",
+      "type": "boolean"
+    },
+    "self_repo": {
+      "title": "Self Repo",
+      "type": "boolean"
+    },
+    "error_type": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "title": "Error Type"
+    },
+    "message": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "title": "Message"
+    },
+    "checks": {
+      "items": {
+        "$ref": "#/$defs/CheckOut"
+      },
+      "title": "Checks",
+      "type": "array"
+    },
+    "summary": {
+      "$ref": "#/$defs/SummaryOut"
+    },
+    "fixed": {
+      "items": {
+        "type": "string"
+      },
+      "title": "Fixed",
+      "type": "array"
+    },
+    "fix_errors": {
+      "items": {
+        "type": "string"
+      },
+      "title": "Fix Errors",
+      "type": "array"
+    },
+    "artifact_health": {
+      "items": {
+        "$ref": "#/$defs/ArtifactHealthOut"
+      },
+      "title": "Artifact Health",
+      "type": "array"
+    }
+  },
+  "required": [
+    "success",
+    "healthy",
+    "self_repo",
+    "error_type",
+    "message",
+    "checks",
+    "summary",
+    "fixed",
+    "fix_errors",
+    "artifact_health"
+  ],
+  "title": "DoctorReportOut",
+  "type": "object"
+}

package/shared/schemas/outputs/init-report.schema.json

@@ -0,0 +1,419 @@
+{
+  "$defs": {
+    "AuthOut": {
+      "additionalProperties": false,
+      "description": "The serialization boundary of the picked :class:`AuthStatus` subset (order load-bearing).",
+      "properties": {
+        "ok": {
+          "title": "Ok",
+          "type": "boolean"
+        },
+        "user": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "title": "User"
+        },
+        "scopes": {
+          "items": {
+            "type": "string"
+          },
+          "title": "Scopes",
+          "type": "array"
+        },
+        "error": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "title": "Error"
+        }
+      },
+      "required": [
+        "ok",
+        "user",
+        "scopes",
+        "error"
+      ],
+      "title": "AuthOut",
+      "type": "object"
+    },
+    "EnvCheckOut": {
+      "additionalProperties": false,
+      "description": "The serialization boundary of one :class:`EnvCheck`. Field order is load-bearing.",
+      "properties": {
+        "name": {
+          "title": "Name",
+          "type": "string"
+        },
+        "ok": {
+          "title": "Ok",
+          "type": "boolean"
+        },
+        "detail": {
+          "title": "Detail",
+          "type": "string"
+        },
+        "remediation": {
+          "title": "Remediation",
+          "type": "string"
+        }
+      },
+      "required": [
+        "name",
+        "ok",
+        "detail",
+        "remediation"
+      ],
+      "title": "EnvCheckOut",
+      "type": "object"
+    },
+    "GitHubReportOut": {
+      "additionalProperties": false,
+      "description": "The serialization boundary of :class:`GitHubReport`. Field order is load-bearing.",
+      "properties": {
+        "auth": {
+          "$ref": "#/$defs/AuthOut"
+        },
+        "repo": {
+          "$ref": "#/$defs/RepoOut"
+        }
+      },
+      "required": [
+        "auth",
+        "repo"
+      ],
+      "title": "GitHubReportOut",
+      "type": "object"
+    },
+    "LinearProjectOut": {
+      "additionalProperties": false,
+      "description": "Serialization boundary of :class:`linear.LinearProjectReadiness` (order load-bearing).",
+      "properties": {
+        "projects_ok": {
+          "title": "Projects Ok",
+          "type": "boolean"
+        },
+        "projects_error": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "title": "Projects Error"
+        },
+        "missing_state_types": {
+          "items": {
+            "type": "string"
+          },
+          "title": "Missing State Types",
+          "type": "array"
+        },
+        "states_error": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "title": "States Error"
+        }
+      },
+      "required": [
+        "projects_ok",
+        "projects_error",
+        "missing_state_types",
+        "states_error"
+      ],
+      "title": "LinearProjectOut",
+      "type": "object"
+    },
+    "LinearReadinessOut": {
+      "additionalProperties": false,
+      "description": "The serialization boundary of :class:`linear.LinearReadiness`. Order is load-bearing.",
+      "properties": {
+        "auth_ok": {
+          "title": "Auth Ok",
+          "type": "boolean"
+        },
+        "user": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "title": "User"
+        },
+        "team_ok": {
+          "title": "Team Ok",
+          "type": "boolean"
+        },
+        "missing_labels": {
+          "items": {
+            "type": "string"
+          },
+          "title": "Missing Labels",
+          "type": "array"
+        },
+        "created_labels": {
+          "items": {
+            "type": "string"
+          },
+          "title": "Created Labels",
+          "type": "array"
+        },
+        "error": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "title": "Error"
+        }
+      },
+      "required": [
+        "auth_ok",
+        "user",
+        "team_ok",
+        "missing_labels",
+        "created_labels",
+        "error"
+      ],
+      "title": "LinearReadinessOut",
+      "type": "object"
+    },
+    "LinearReportOut": {
+      "additionalProperties": false,
+      "description": "The serialization boundary of the nullable :class:`LinearReport`. Order is load-bearing.",
+      "properties": {
+        "ok": {
+          "title": "Ok",
+          "type": "boolean"
+        },
+        "team": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "title": "Team"
+        },
+        "error": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "title": "Error"
+        },
+        "readiness": {
+          "anyOf": [
+            {
+              "$ref": "#/$defs/LinearReadinessOut"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "project": {
+          "anyOf": [
+            {
+              "$ref": "#/$defs/LinearProjectOut"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        }
+      },
+      "required": [
+        "ok",
+        "team",
+        "error",
+        "readiness",
+        "project"
+      ],
+      "title": "LinearReportOut",
+      "type": "object"
+    },
+    "RepoOut": {
+      "additionalProperties": false,
+      "description": "The serialization boundary of the picked :class:`RepoAccess` subset (order load-bearing).",
+      "properties": {
+        "ok": {
+          "title": "Ok",
+          "type": "boolean"
+        },
+        "repo": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "title": "Repo"
+        },
+        "can_push": {
+          "title": "Can Push",
+          "type": "boolean"
+        },
+        "error": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "title": "Error"
+        }
+      },
+      "required": [
+        "ok",
+        "repo",
+        "can_push",
+        "error"
+      ],
+      "title": "RepoOut",
+      "type": "object"
+    }
+  },
+  "additionalProperties": false,
+  "description": "The ``--json`` serialization boundary of :class:`InitReport`. Field order is load-bearing.",
+  "properties": {
+    "success": {
+      "title": "Success",
+      "type": "boolean"
+    },
+    "mode": {
+      "title": "Mode",
+      "type": "string"
+    },
+    "error_type": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "title": "Error Type"
+    },
+    "message": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "title": "Message"
+    },
+    "env": {
+      "items": {
+        "$ref": "#/$defs/EnvCheckOut"
+      },
+      "title": "Env",
+      "type": "array"
+    },
+    "github": {
+      "anyOf": [
+        {
+          "$ref": "#/$defs/GitHubReportOut"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "linear": {
+      "anyOf": [
+        {
+          "$ref": "#/$defs/LinearReportOut"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "capabilities": {
+      "items": {
+        "type": "string"
+      },
+      "title": "Capabilities",
+      "type": "array"
+    },
+    "changes": {
+      "items": {
+        "type": "string"
+      },
+      "title": "Changes",
+      "type": "array"
+    },
+    "warnings": {
+      "items": {
+        "type": "string"
+      },
+      "title": "Warnings",
+      "type": "array"
+    },
+    "handoff": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "title": "Handoff"
+    }
+  },
+  "required": [
+    "success",
+    "mode",
+    "error_type",
+    "message",
+    "env",
+    "github",
+    "linear",
+    "capabilities",
+    "changes",
+    "warnings",
+    "handoff"
+  ],
+  "title": "InitReportOut",
+  "type": "object"
+}