io.github.andypgray/sliderule

Run the architecture spec against the bound solution and return the JSON check report (schemaVersion 3): rules[] keyed by id, plus summary counts. Violations are data — a red rule is a finding, not an error. Narrow with grain (overview, skeleton or index) or rules (fewer rules); an over-budget report coarsens its own grain, as far as index, rather than being cut — and index lists every rule ID, which is what rules globs match. subjectTypes/subjectGeneratedTypes appear together on a rule whose subject contained generator output, pass or fail: how many types it swept and how many nobody wrote. Both absent means none were. Narrowing the rule with .Authored() removes them. If declared project files are missing, projects fail to load, or their NuGet packages did not resolve, the report still returns, stamped modelIncomplete: true and missingProjects/failedProjects/restoreFailedProjects — a verdict reached against a partial model; report that, never plain green. Under a .slnf solution filter, uncheckedProjects names the declared projects the run never checked — a clean report then covers a subset; say so. unsupportedProjects names the projects outside the model (not C#, Web Sites, unbuilt), each with its reason — no rule can be violated in one, so a clean report over a polyglot solution is not a clean solution either. multiTargetedProjects names the projects that compiled for several frameworks, each with the first framework its shared types' members and hierarchy follow (a type that framework does not declare follows the next that does); their references come from every framework, so a clean report over such a project covers one framework's members and hierarchy per type and every framework's references. staleSpec names a spec source that differs from the spec project's last build: the verdict is of the rules that build holds, so rebuild the spec project and check again.

Return the architecture scope card(s) covering a file or directory — a quarantined scope's dragons + sanctioned surface, a cautioned scope's dragons, or a layer's local rules — or a pointer line when none apply. If projects fail to load or to restore, the answer opens with a caveat naming them: cards from unloaded projects cannot be placed, and a rule about a package the restore never fetched was never measured, so treat a no-coverage answer as unproven there. A .slnf solution filter gets the same caveat for the declared projects it left unchecked: treat a no-coverage answer as unproven under them as well. A spec source that differs from the spec project's last build is named in a line above the answer: the cards are of the rules that build holds, so rebuild the spec project and ask again.

Return one rule's because, fix, citation, exemplar, posture payload, and linked prose as text. Given a type or a path instead of a rule ID, return which layers, rules and scopes claim each type, the rules that name it as an operand, the step that admitted it to each, and the rules whose selection reached it and then left it out: call it when a rule fires on a type you did not expect it to govern. Pass exactly one of ruleId, type and path. If projects fail to load or to restore, a type or path answer opens with a caveat naming them. A spec source that differs from the spec project's last build is named in a line above any answer: the answer is of the rules that build holds, so rebuild the spec project and ask again.

Return the JSON codebase survey (schemaVersion 1): projects[] with namespace inventories, projectEdges[] (source/target, declared vs observed dependencies), and externalEdges[] grouped by namespace root. Every project the workspace loaded is here, which is wider than the solution: solutionMember false marks a passenger a ProjectReference dragged in, and an absent key means membership was unreadable. undeclaredProjectReferences (absent when empty) names the projects a project compiles against that no declared projectReferences entry reaches: its declared list is short, so trust its edges. projectEdges[] carry only references the code declares: where several projects declare one type, a project referencing its own copy is not an edge to the declarer the type was attributed to, nor is a reference one copy makes an edge from the others, and multiplyDeclaredTypes[] names those types with every declaring project and the one whose facts won — arch.Project() on any declarer selects them, with shape and member rules answering from the winner's facts (the key is absent when the solution has none). shadowedTypes[] is the other coverage key: a full name a project declares that a referenced assembly also supplies means two types, so a rule naming it reaches both while arch.Project() over the declaring project reaches only the declaration. generated qualifies the types count on a project and on each namespace (absent when zero): how many of them a generator emitted, which is what arch.Project() would sweep and .Authored() would drop. A namespace whose two counts are equal is wholly generator output — never make it a layer glob. targetFrameworks rides every project's row and names what it declares, normalized (a project predating the SDK reads net48); factsFollow rides only a multi-targeted one and names the first framework its shared types' members and hierarchy came from (a type it does not declare takes them from the next that does); their references come from every framework.…

Return the JSON migration burndown (schemaVersion 2): per-rule grandfathered/stale counts and promotion suggestions. If declared project files are missing, projects fail to load, or their NuGet packages did not resolve, the burndown still returns, stamped modelIncomplete: true and missingProjects/failedProjects/restoreFailedProjects — counts from a partial model; report that rather than quoting them as whole. Under a .slnf solution filter, uncheckedProjects names the declared projects the run never checked; they contribute no violations, so every count reads low. unsupportedProjects names the projects outside the model (not C#, Web Sites, unbuilt): no argument counts them, so their zero is not burndown. orphans lists baseline sections no rule in the spec names, such as a renamed rule's old section, and baseline files that could not be read. staleSpec names a spec source that differs from the spec project's last build, so the counts are of the rules that build holds; rebuild it and ask again.