Skip to content

docs: align gdp-ts policy schema examples #87

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
BartWaardenburg merged 1 commit into from
Oct 5, 2026
Merged

docs: align gdp-ts policy schema examples #87

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions cli/audit.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -353,7 +353,7 @@ Audit scope: 12 changed files vs main (d4a2f91..HEAD)
```json title="$ fallow audit --format json"
{
"kind": "audit",
"schema_version": 11,
"schema_version": 12,
"version": "3.31.0",
"command": "audit",
"verdict": "fail",
Expand Down Expand Up @@ -381,7 +381,7 @@ Audit scope: 12 changed files vs main (d4a2f91..HEAD)
"duplication_demoted": 0
},
"dead_code": {
"schema_version": 9,
"schema_version": 10,
"total_issues": 2,
"unused_exports": [
{ "path": "src/components/Button.tsx", "export_name": "OldButton", "introduced": true, "actions": [...] }
Expand Down Expand Up @@ -554,7 +554,7 @@ The decision surface is the ranked set of `coupling-boundary`, `public-api-contr

### JSON envelope

`fallow review --format json` returns `decisions`, `focus`, `deltas`, `impact_closure`, `partition`, and `graph_facts`. When the project has a CODEOWNERS file, it also returns `ownership`. The brief `schema_version` is 11 since the `ownership` section. A consumer can read it to detect the section.
`fallow review --format json` returns `decisions`, `focus`, `deltas`, `impact_closure`, `partition`, and `graph_facts`. When the project has a CODEOWNERS file, it also returns `ownership`. The brief `schema_version` is 12. Consumers can use it to detect contract changes.

`deltas` also has the dependency keys that the decision surface reads: `dependency_added` (`<manifest>::<name>`) and `dependency_major_bumped` (`<manifest>::<name>@<from>-><to>`). The envelope names what changed even when the cap collapses the decision. Both keys are always present, as empty arrays when nothing changed.

Expand Down
2 changes: 1 addition & 1 deletion cli/dead-code.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@ In `--format json`, re-export cycles have their own field, with the shape of eac
```json title="$ fallow dead-code --format json (excerpt)"
{
"kind": "dead-code",
"schema_version": 9,
"schema_version": 10,
"re_export_cycles": [
{
"files": ["src/api/index.ts", "src/api/internal/index.ts"],
Expand Down
2 changes: 1 addition & 1 deletion explanations/dead-code.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1069,7 +1069,7 @@ When you pass `--explain`, or run through MCP, the JSON output includes a `_meta

```json
{
"schema_version": 9,
"schema_version": 10,
"_meta": {
"docs": "https://fallow.tools/docs/cli/dead-code/",
"rules": {
Expand Down
14 changes: 7 additions & 7 deletions public-content-manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"visibility": "public-only"
},
"content": {
"sha256": "46913310d60a6d81018d51ef04c38770d17b19b82c8160aac6c36d8bb5bf47b6",
"sha256": "8e95c54d440d2281ae6fd8ecabd36a66e163818f824b7385b859448d20fdcd09",
"files": [
{
"path": "adoption.mdx",
Expand Down Expand Up @@ -86,8 +86,8 @@
},
{
"path": "cli/audit.mdx",
"bytes": 46801,
"sha256": "688ef1da7ae7444a27825e48f2db396deeeae607ddc890669a392e66ca2e1e70"
"bytes": 46775,
"sha256": "b67b3b86efe445f94f800c68c68493ea548d6e9026e7a3de800ad54fd462c76e"
},
{
"path": "cli/config.mdx",
Expand All @@ -101,8 +101,8 @@
},
{
"path": "cli/dead-code.mdx",
"bytes": 33394,
"sha256": "babe550f36419c70cece19fd6d1061327a4f9bd31fba0f19b584a771b6b0548f"
"bytes": 33395,
"sha256": "f90b43b9c506d9911dd05fe6a3bf9fb24451f1eaa505e117389a491cf1ce4e21"
},
{
"path": "cli/decision-surface.mdx",
Expand Down Expand Up @@ -291,8 +291,8 @@
},
{
"path": "explanations/dead-code.mdx",
"bytes": 92938,
"sha256": "127902f64461e6aade063d744dec7e7f119ee9f6b51dc3a4642e668d438e23b4"
"bytes": 92939,
"sha256": "59a88315d81e3195613a30e2944b65e4823e783583ef8846efdfe5daab60c91c"
},
{
"path": "explanations/duplication.mdx",
Expand Down