@rvdbreemen/adr-kit-opencode 0.52.0 → 0.52.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude-plugin/plugin.json +29 -29
- package/README.md +861 -850
- package/bin/adr +0 -0
- package/bin/adr-audit +0 -0
- package/bin/adr-context +0 -0
- package/bin/adr-discover +0 -0
- package/bin/adr-doctor +0 -0
- package/bin/adr-generate-scripts +0 -0
- package/bin/adr-grill-signal +0 -0
- package/bin/adr-guardian +0 -0
- package/bin/adr-index +0 -0
- package/bin/adr-judge +0 -0
- package/bin/adr-judge-precommit +0 -0
- package/bin/adr-lint +0 -0
- package/bin/adr-mcp +0 -0
- package/bin/adr-migrate +0 -0
- package/bin/adr-quality +0 -0
- package/bin/adr-readiness +0 -0
- package/bin/adr-readiness-ci +0 -0
- package/bin/adr-related +0 -0
- package/bin/adr-renumber +254 -254
- package/bin/adr-retire +0 -0
- package/bin/adr-settings +0 -0
- package/bin/adr-status +0 -0
- package/bin/adr-suggest +0 -0
- package/bin/adr-watch +0 -0
- package/bin/bump-version +0 -0
- package/clients/workflows.json +229 -229
- package/hooks/__init__.py +1 -1
- package/hooks/adapters/__init__.py +13 -13
- package/hooks/adapters/claude.py +27 -27
- package/hooks/adapters/codex.py +26 -26
- package/hooks/adapters/copilot.py +11 -11
- package/hooks/adr-hook.py +128 -128
- package/hooks/adr_hook_core.py +843 -843
- package/hooks/adr_pr_guard.py +367 -367
- package/instructions/ADR-guide.md +48 -48
- package/instructions/adr.coding.md +82 -82
- package/instructions/adr.review.md +182 -182
- package/opencode/plugin.ts +1 -4
- package/package.json +5 -2
- package/schemas/adr-context-probes.schema.json +56 -56
- package/schemas/adr-enforcement.schema.json +57 -57
- package/schemas/adr-frontmatter.schema.json +144 -144
- package/schemas/adr-index.schema.json +276 -276
- package/schemas/adr-kit-config.schema.json +371 -371
- package/schemas/adr-readiness.schema.json +41 -41
- package/schemas/client-capabilities.schema.json +503 -503
- package/schemas/client-certification.schema.json +101 -101
- package/schemas/doctor-output.schema.json +92 -92
- package/skills/adr/SKILL.md +780 -780
- package/skills/audit/SKILL.md +103 -103
- package/skills/context/SKILL.md +77 -77
- package/skills/grill/SKILL.md +84 -84
- package/skills/grill/agents/openai.yaml +4 -4
- package/skills/guardian/SKILL.md +316 -316
- package/skills/init/SKILL.md +499 -499
- package/skills/install-hooks/SKILL.md +154 -154
- package/skills/judge/SKILL.md +168 -168
- package/skills/lint/SKILL.md +321 -321
- package/skills/migrate/SKILL.md +313 -313
- package/skills/related/SKILL.md +62 -62
- package/skills/retire/SKILL.md +41 -41
- package/skills/review/SKILL.md +167 -167
- package/skills/settings/SKILL.md +73 -73
- package/skills/setup/SKILL.md +128 -128
- package/skills/supersede/SKILL.md +136 -136
- package/skills/upgrade/SKILL.md +273 -273
- package/templates/adr-kit-guide.md +354 -354
- package/templates/adr-template.canonical.md +115 -115
- package/templates/adr-template.madr.md +131 -131
- package/templates/adr-template.md +131 -131
- package/templates/adr-template.nygard.md +111 -111
- package/templates/cc-settings/guardian-hook-entry.json +9 -9
- package/templates/githooks/pre-commit +1 -1
- package/templates/github-workflows/adr-audit.yml +58 -58
- package/templates/github-workflows/adr-guardian-audit.yml +133 -133
- package/templates/github-workflows/adr-index-check.yml +30 -30
- package/templates/github-workflows/adr-judge.yml +31 -31
- package/templates/github-workflows/adr-readiness.yml +18 -18
- package/templates/validate_adr_template.py +38 -38
- package/templates/validate_adr_template.sh +74 -74
package/package.json
CHANGED
|
@@ -1,11 +1,14 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rvdbreemen/adr-kit-opencode",
|
|
3
|
-
"version": "0.52.
|
|
3
|
+
"version": "0.52.2",
|
|
4
4
|
"description": "Native OpenCode plugin for ADR Kit, backed by the shared deterministic Python engines.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./opencode/plugin.ts",
|
|
7
7
|
"license": "MIT",
|
|
8
|
-
"repository":
|
|
8
|
+
"repository": {
|
|
9
|
+
"type": "git",
|
|
10
|
+
"url": "git+https://github.com/rvdbreemen/adr-kit.git"
|
|
11
|
+
},
|
|
9
12
|
"homepage": "https://github.com/rvdbreemen/adr-kit",
|
|
10
13
|
"keywords": [
|
|
11
14
|
"opencode",
|
|
@@ -1,56 +1,56 @@
|
|
|
1
|
-
{
|
|
2
|
-
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
-
"$id": "https://adr-kit.dev/schemas/adr-context-probes.schema.json",
|
|
4
|
-
"title": "ADR Kit selective-context retrieval probes",
|
|
5
|
-
"type": "object",
|
|
6
|
-
"additionalProperties": false,
|
|
7
|
-
"required": ["schema_version", "probes"],
|
|
8
|
-
"properties": {
|
|
9
|
-
"$schema": {"type": "string"},
|
|
10
|
-
"schema_version": {"const": 1},
|
|
11
|
-
"probes": {
|
|
12
|
-
"type": "array",
|
|
13
|
-
"maxItems": 100,
|
|
14
|
-
"items": {"$ref": "#/$defs/probe"}
|
|
15
|
-
}
|
|
16
|
-
},
|
|
17
|
-
"$defs": {
|
|
18
|
-
"strings": {
|
|
19
|
-
"type": "array",
|
|
20
|
-
"maxItems": 32,
|
|
21
|
-
"uniqueItems": true,
|
|
22
|
-
"items": {"type": "string", "minLength": 1, "maxLength": 240}
|
|
23
|
-
},
|
|
24
|
-
"adrIds": {
|
|
25
|
-
"type": "array",
|
|
26
|
-
"maxItems": 20,
|
|
27
|
-
"uniqueItems": true,
|
|
28
|
-
"items": {"type": "string", "pattern": "^ADR-[0-9]{3,4}$"}
|
|
29
|
-
},
|
|
30
|
-
"probe": {
|
|
31
|
-
"type": "object",
|
|
32
|
-
"additionalProperties": false,
|
|
33
|
-
"required": ["id", "query", "expect"],
|
|
34
|
-
"properties": {
|
|
35
|
-
"id": {
|
|
36
|
-
"type": "string",
|
|
37
|
-
"pattern": "^[a-z][a-z0-9-]{0,79}$"
|
|
38
|
-
},
|
|
39
|
-
"query": {"type": "string", "minLength": 1, "maxLength": 1000},
|
|
40
|
-
"paths": {"$ref": "#/$defs/strings"},
|
|
41
|
-
"components": {"$ref": "#/$defs/strings"},
|
|
42
|
-
"symbols": {"$ref": "#/$defs/strings"},
|
|
43
|
-
"topics": {"$ref": "#/$defs/strings"},
|
|
44
|
-
"limit": {"type": "integer", "minimum": 1, "maximum": 20, "default": 3},
|
|
45
|
-
"expect": {
|
|
46
|
-
"type": "object",
|
|
47
|
-
"additionalProperties": false,
|
|
48
|
-
"properties": {
|
|
49
|
-
"include": {"$ref": "#/$defs/adrIds"},
|
|
50
|
-
"exclude": {"$ref": "#/$defs/adrIds"}
|
|
51
|
-
}
|
|
52
|
-
}
|
|
53
|
-
}
|
|
54
|
-
}
|
|
55
|
-
}
|
|
56
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$id": "https://adr-kit.dev/schemas/adr-context-probes.schema.json",
|
|
4
|
+
"title": "ADR Kit selective-context retrieval probes",
|
|
5
|
+
"type": "object",
|
|
6
|
+
"additionalProperties": false,
|
|
7
|
+
"required": ["schema_version", "probes"],
|
|
8
|
+
"properties": {
|
|
9
|
+
"$schema": {"type": "string"},
|
|
10
|
+
"schema_version": {"const": 1},
|
|
11
|
+
"probes": {
|
|
12
|
+
"type": "array",
|
|
13
|
+
"maxItems": 100,
|
|
14
|
+
"items": {"$ref": "#/$defs/probe"}
|
|
15
|
+
}
|
|
16
|
+
},
|
|
17
|
+
"$defs": {
|
|
18
|
+
"strings": {
|
|
19
|
+
"type": "array",
|
|
20
|
+
"maxItems": 32,
|
|
21
|
+
"uniqueItems": true,
|
|
22
|
+
"items": {"type": "string", "minLength": 1, "maxLength": 240}
|
|
23
|
+
},
|
|
24
|
+
"adrIds": {
|
|
25
|
+
"type": "array",
|
|
26
|
+
"maxItems": 20,
|
|
27
|
+
"uniqueItems": true,
|
|
28
|
+
"items": {"type": "string", "pattern": "^ADR-[0-9]{3,4}$"}
|
|
29
|
+
},
|
|
30
|
+
"probe": {
|
|
31
|
+
"type": "object",
|
|
32
|
+
"additionalProperties": false,
|
|
33
|
+
"required": ["id", "query", "expect"],
|
|
34
|
+
"properties": {
|
|
35
|
+
"id": {
|
|
36
|
+
"type": "string",
|
|
37
|
+
"pattern": "^[a-z][a-z0-9-]{0,79}$"
|
|
38
|
+
},
|
|
39
|
+
"query": {"type": "string", "minLength": 1, "maxLength": 1000},
|
|
40
|
+
"paths": {"$ref": "#/$defs/strings"},
|
|
41
|
+
"components": {"$ref": "#/$defs/strings"},
|
|
42
|
+
"symbols": {"$ref": "#/$defs/strings"},
|
|
43
|
+
"topics": {"$ref": "#/$defs/strings"},
|
|
44
|
+
"limit": {"type": "integer", "minimum": 1, "maximum": 20, "default": 3},
|
|
45
|
+
"expect": {
|
|
46
|
+
"type": "object",
|
|
47
|
+
"additionalProperties": false,
|
|
48
|
+
"properties": {
|
|
49
|
+
"include": {"$ref": "#/$defs/adrIds"},
|
|
50
|
+
"exclude": {"$ref": "#/$defs/adrIds"}
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
}
|
|
@@ -1,57 +1,57 @@
|
|
|
1
|
-
{
|
|
2
|
-
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
-
"title": "ADR Enforcement Block Schema (v0.14.0+)",
|
|
4
|
-
"type": "object",
|
|
5
|
-
"properties": {
|
|
6
|
-
"forbid_pattern": {
|
|
7
|
-
"type": "array",
|
|
8
|
-
"items": {
|
|
9
|
-
"type": "object",
|
|
10
|
-
"properties": {
|
|
11
|
-
"pattern": { "type": "string", "minLength": 1 },
|
|
12
|
-
"path_glob": { "type": "string" },
|
|
13
|
-
"message": { "type": "string" }
|
|
14
|
-
},
|
|
15
|
-
"required": ["pattern"],
|
|
16
|
-
"additionalProperties": false
|
|
17
|
-
}
|
|
18
|
-
},
|
|
19
|
-
"forbid_import": {
|
|
20
|
-
"type": "array",
|
|
21
|
-
"items": {
|
|
22
|
-
"type": "object",
|
|
23
|
-
"properties": {
|
|
24
|
-
"pattern": { "type": "string", "minLength": 1 },
|
|
25
|
-
"path_glob": { "type": "string" },
|
|
26
|
-
"message": { "type": "string" }
|
|
27
|
-
},
|
|
28
|
-
"required": ["pattern"],
|
|
29
|
-
"additionalProperties": false
|
|
30
|
-
}
|
|
31
|
-
},
|
|
32
|
-
"require_pattern": {
|
|
33
|
-
"type": "array",
|
|
34
|
-
"items": {
|
|
35
|
-
"type": "object",
|
|
36
|
-
"properties": {
|
|
37
|
-
"pattern": { "type": "string", "minLength": 1 },
|
|
38
|
-
"path_glob": { "type": "string" },
|
|
39
|
-
"message": { "type": "string" }
|
|
40
|
-
},
|
|
41
|
-
"required": ["pattern"],
|
|
42
|
-
"additionalProperties": false
|
|
43
|
-
}
|
|
44
|
-
},
|
|
45
|
-
"llm_judge": {
|
|
46
|
-
"type": "boolean",
|
|
47
|
-
"default": true,
|
|
48
|
-
"description": "Whether the LLM pass evaluates the staged diff against this ADR's Decision text. DEFAULT TRUE as of TASK-74: an Enforcement block that omits the key opts in, and only an explicit false opts out. The previous opt-in default failed silently -- a pass that was on by default with an empty population judged nothing while looking active. Cost is bounded by scope, not by this flag: an ADR is only judged when the diff touches a file matching its rules' path_glob set. An Enforcement block that declares no rules, or a rule without a path_glob, has no boundary to narrow with and is therefore judged on EVERY commit; prefer marking such a decision as having no code surface."
|
|
49
|
-
},
|
|
50
|
-
"llm_judge_reason": {
|
|
51
|
-
"type": "string",
|
|
52
|
-
"minLength": 1,
|
|
53
|
-
"description": "Why the LLM pass is off for this ADR. Only meaningful together with llm_judge:false. Since the default flipped to true, a bare false is ambiguous -- it may be a deliberate opt-out or a leftover from when false was the default. A reason makes the opt-out durable: the upgrade re-proposes a bare false and leaves a reasoned one alone. Typical value: 'no code surface -- this decision governs the release process, not code'."
|
|
54
|
-
}
|
|
55
|
-
},
|
|
56
|
-
"additionalProperties": false
|
|
57
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
+
"title": "ADR Enforcement Block Schema (v0.14.0+)",
|
|
4
|
+
"type": "object",
|
|
5
|
+
"properties": {
|
|
6
|
+
"forbid_pattern": {
|
|
7
|
+
"type": "array",
|
|
8
|
+
"items": {
|
|
9
|
+
"type": "object",
|
|
10
|
+
"properties": {
|
|
11
|
+
"pattern": { "type": "string", "minLength": 1 },
|
|
12
|
+
"path_glob": { "type": "string" },
|
|
13
|
+
"message": { "type": "string" }
|
|
14
|
+
},
|
|
15
|
+
"required": ["pattern"],
|
|
16
|
+
"additionalProperties": false
|
|
17
|
+
}
|
|
18
|
+
},
|
|
19
|
+
"forbid_import": {
|
|
20
|
+
"type": "array",
|
|
21
|
+
"items": {
|
|
22
|
+
"type": "object",
|
|
23
|
+
"properties": {
|
|
24
|
+
"pattern": { "type": "string", "minLength": 1 },
|
|
25
|
+
"path_glob": { "type": "string" },
|
|
26
|
+
"message": { "type": "string" }
|
|
27
|
+
},
|
|
28
|
+
"required": ["pattern"],
|
|
29
|
+
"additionalProperties": false
|
|
30
|
+
}
|
|
31
|
+
},
|
|
32
|
+
"require_pattern": {
|
|
33
|
+
"type": "array",
|
|
34
|
+
"items": {
|
|
35
|
+
"type": "object",
|
|
36
|
+
"properties": {
|
|
37
|
+
"pattern": { "type": "string", "minLength": 1 },
|
|
38
|
+
"path_glob": { "type": "string" },
|
|
39
|
+
"message": { "type": "string" }
|
|
40
|
+
},
|
|
41
|
+
"required": ["pattern"],
|
|
42
|
+
"additionalProperties": false
|
|
43
|
+
}
|
|
44
|
+
},
|
|
45
|
+
"llm_judge": {
|
|
46
|
+
"type": "boolean",
|
|
47
|
+
"default": true,
|
|
48
|
+
"description": "Whether the LLM pass evaluates the staged diff against this ADR's Decision text. DEFAULT TRUE as of TASK-74: an Enforcement block that omits the key opts in, and only an explicit false opts out. The previous opt-in default failed silently -- a pass that was on by default with an empty population judged nothing while looking active. Cost is bounded by scope, not by this flag: an ADR is only judged when the diff touches a file matching its rules' path_glob set. An Enforcement block that declares no rules, or a rule without a path_glob, has no boundary to narrow with and is therefore judged on EVERY commit; prefer marking such a decision as having no code surface."
|
|
49
|
+
},
|
|
50
|
+
"llm_judge_reason": {
|
|
51
|
+
"type": "string",
|
|
52
|
+
"minLength": 1,
|
|
53
|
+
"description": "Why the LLM pass is off for this ADR. Only meaningful together with llm_judge:false. Since the default flipped to true, a bare false is ambiguous -- it may be a deliberate opt-out or a leftover from when false was the default. A reason makes the opt-out durable: the upgrade re-proposes a bare false and leaves a reasoned one alone. Typical value: 'no code surface -- this decision governs the release process, not code'."
|
|
54
|
+
}
|
|
55
|
+
},
|
|
56
|
+
"additionalProperties": false
|
|
57
|
+
}
|
|
@@ -1,144 +1,144 @@
|
|
|
1
|
-
{
|
|
2
|
-
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
-
"$id": "https://rvdbreemen.github.io/adr-kit/schemas/adr-frontmatter.schema.json",
|
|
4
|
-
"title": "adr-kit canonical ADR frontmatter",
|
|
5
|
-
"type": "object",
|
|
6
|
-
"additionalProperties": true,
|
|
7
|
-
"required": [
|
|
8
|
-
"id",
|
|
9
|
-
"title",
|
|
10
|
-
"status",
|
|
11
|
-
"date",
|
|
12
|
-
"binding",
|
|
13
|
-
"gate",
|
|
14
|
-
"documents_shipped",
|
|
15
|
-
"verified_in",
|
|
16
|
-
"supersedes",
|
|
17
|
-
"superseded_by"
|
|
18
|
-
],
|
|
19
|
-
"properties": {
|
|
20
|
-
"id": {
|
|
21
|
-
"type": "string",
|
|
22
|
-
"pattern": "^ADR-[0-9]{3,4}$",
|
|
23
|
-
"description": "Canonical ADR identifier."
|
|
24
|
-
},
|
|
25
|
-
"title": {
|
|
26
|
-
"type": "string",
|
|
27
|
-
"minLength": 1,
|
|
28
|
-
"description": "Human title without the ADR id prefix."
|
|
29
|
-
},
|
|
30
|
-
"status": {
|
|
31
|
-
"type": "string",
|
|
32
|
-
"enum": [
|
|
33
|
-
"Proposed",
|
|
34
|
-
"Accepted",
|
|
35
|
-
"Deprecated",
|
|
36
|
-
"Superseded",
|
|
37
|
-
"Amended",
|
|
38
|
-
"Rejected"
|
|
39
|
-
],
|
|
40
|
-
"description": "Current lifecycle status."
|
|
41
|
-
},
|
|
42
|
-
"date": {
|
|
43
|
-
"type": [
|
|
44
|
-
"string",
|
|
45
|
-
"null"
|
|
46
|
-
],
|
|
47
|
-
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
|
|
48
|
-
"description": "Date from the status line when known."
|
|
49
|
-
},
|
|
50
|
-
"binding": {
|
|
51
|
-
"type": "boolean",
|
|
52
|
-
"description": "True when the ADR constrains future implementation."
|
|
53
|
-
},
|
|
54
|
-
"gate": {
|
|
55
|
-
"type": [
|
|
56
|
-
"string",
|
|
57
|
-
"null"
|
|
58
|
-
],
|
|
59
|
-
"minLength": 1,
|
|
60
|
-
"description": "Named consuming-repo verification gate, if any."
|
|
61
|
-
},
|
|
62
|
-
"documents_shipped": {
|
|
63
|
-
"type": "boolean",
|
|
64
|
-
"description": "True when this ADR documents behavior already shipped before authoring."
|
|
65
|
-
},
|
|
66
|
-
"verified_in": {
|
|
67
|
-
"type": "array",
|
|
68
|
-
"items": {
|
|
69
|
-
"type": "string",
|
|
70
|
-
"minLength": 1
|
|
71
|
-
},
|
|
72
|
-
"description": "Local evidence pointers such as file paths, symbols, tests, or commits."
|
|
73
|
-
},
|
|
74
|
-
"supersedes": {
|
|
75
|
-
"type": "array",
|
|
76
|
-
"items": {
|
|
77
|
-
"type": "string",
|
|
78
|
-
"pattern": "^ADR-[0-9]{3,4}$"
|
|
79
|
-
},
|
|
80
|
-
"description": "ADR ids this ADR supersedes."
|
|
81
|
-
},
|
|
82
|
-
"superseded_by": {
|
|
83
|
-
"type": [
|
|
84
|
-
"string",
|
|
85
|
-
"null"
|
|
86
|
-
],
|
|
87
|
-
"pattern": "^ADR-[0-9]{3,4}$",
|
|
88
|
-
"description": "Successor ADR id when this ADR is superseded."
|
|
89
|
-
},
|
|
90
|
-
"related": {
|
|
91
|
-
"type": "array",
|
|
92
|
-
"items": {
|
|
93
|
-
"type": "string",
|
|
94
|
-
"pattern": "^ADR-[0-9]{3,4}$"
|
|
95
|
-
},
|
|
96
|
-
"description": "ADR ids this ADR is related to, written on both sides by `bin/adr relate`. Symmetric: if A lists B, B lists A."
|
|
97
|
-
},
|
|
98
|
-
"format": {
|
|
99
|
-
"type": "string",
|
|
100
|
-
"enum": [
|
|
101
|
-
"madr",
|
|
102
|
-
"nygard",
|
|
103
|
-
"canonical"
|
|
104
|
-
],
|
|
105
|
-
"description": "Optional ADR body profile discriminator. Legacy records may omit it and are detected from headings."
|
|
106
|
-
},
|
|
107
|
-
"topics": {
|
|
108
|
-
"$ref": "#/$defs/retrievalStrings",
|
|
109
|
-
"description": "Optional deterministic topic terms for selective ADR retrieval."
|
|
110
|
-
},
|
|
111
|
-
"aliases": {
|
|
112
|
-
"$ref": "#/$defs/retrievalStrings",
|
|
113
|
-
"description": "Optional alternative names and phrases for selective ADR retrieval."
|
|
114
|
-
},
|
|
115
|
-
"components": {
|
|
116
|
-
"$ref": "#/$defs/retrievalStrings",
|
|
117
|
-
"description": "Optional architectural components named by this decision."
|
|
118
|
-
},
|
|
119
|
-
"symbols": {
|
|
120
|
-
"$ref": "#/$defs/retrievalStrings",
|
|
121
|
-
"description": "Optional code symbols named by this decision."
|
|
122
|
-
},
|
|
123
|
-
"context_scope": {
|
|
124
|
-
"type": "string",
|
|
125
|
-
"enum": [
|
|
126
|
-
"global",
|
|
127
|
-
"selective"
|
|
128
|
-
],
|
|
129
|
-
"description": "Whether the ADR is baseline context or requires positive selective evidence."
|
|
130
|
-
}
|
|
131
|
-
},
|
|
132
|
-
"$defs": {
|
|
133
|
-
"retrievalStrings": {
|
|
134
|
-
"type": "array",
|
|
135
|
-
"maxItems": 32,
|
|
136
|
-
"uniqueItems": true,
|
|
137
|
-
"items": {
|
|
138
|
-
"type": "string",
|
|
139
|
-
"minLength": 1,
|
|
140
|
-
"maxLength": 120
|
|
141
|
-
}
|
|
142
|
-
}
|
|
143
|
-
}
|
|
144
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$id": "https://rvdbreemen.github.io/adr-kit/schemas/adr-frontmatter.schema.json",
|
|
4
|
+
"title": "adr-kit canonical ADR frontmatter",
|
|
5
|
+
"type": "object",
|
|
6
|
+
"additionalProperties": true,
|
|
7
|
+
"required": [
|
|
8
|
+
"id",
|
|
9
|
+
"title",
|
|
10
|
+
"status",
|
|
11
|
+
"date",
|
|
12
|
+
"binding",
|
|
13
|
+
"gate",
|
|
14
|
+
"documents_shipped",
|
|
15
|
+
"verified_in",
|
|
16
|
+
"supersedes",
|
|
17
|
+
"superseded_by"
|
|
18
|
+
],
|
|
19
|
+
"properties": {
|
|
20
|
+
"id": {
|
|
21
|
+
"type": "string",
|
|
22
|
+
"pattern": "^ADR-[0-9]{3,4}$",
|
|
23
|
+
"description": "Canonical ADR identifier."
|
|
24
|
+
},
|
|
25
|
+
"title": {
|
|
26
|
+
"type": "string",
|
|
27
|
+
"minLength": 1,
|
|
28
|
+
"description": "Human title without the ADR id prefix."
|
|
29
|
+
},
|
|
30
|
+
"status": {
|
|
31
|
+
"type": "string",
|
|
32
|
+
"enum": [
|
|
33
|
+
"Proposed",
|
|
34
|
+
"Accepted",
|
|
35
|
+
"Deprecated",
|
|
36
|
+
"Superseded",
|
|
37
|
+
"Amended",
|
|
38
|
+
"Rejected"
|
|
39
|
+
],
|
|
40
|
+
"description": "Current lifecycle status."
|
|
41
|
+
},
|
|
42
|
+
"date": {
|
|
43
|
+
"type": [
|
|
44
|
+
"string",
|
|
45
|
+
"null"
|
|
46
|
+
],
|
|
47
|
+
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
|
|
48
|
+
"description": "Date from the status line when known."
|
|
49
|
+
},
|
|
50
|
+
"binding": {
|
|
51
|
+
"type": "boolean",
|
|
52
|
+
"description": "True when the ADR constrains future implementation."
|
|
53
|
+
},
|
|
54
|
+
"gate": {
|
|
55
|
+
"type": [
|
|
56
|
+
"string",
|
|
57
|
+
"null"
|
|
58
|
+
],
|
|
59
|
+
"minLength": 1,
|
|
60
|
+
"description": "Named consuming-repo verification gate, if any."
|
|
61
|
+
},
|
|
62
|
+
"documents_shipped": {
|
|
63
|
+
"type": "boolean",
|
|
64
|
+
"description": "True when this ADR documents behavior already shipped before authoring."
|
|
65
|
+
},
|
|
66
|
+
"verified_in": {
|
|
67
|
+
"type": "array",
|
|
68
|
+
"items": {
|
|
69
|
+
"type": "string",
|
|
70
|
+
"minLength": 1
|
|
71
|
+
},
|
|
72
|
+
"description": "Local evidence pointers such as file paths, symbols, tests, or commits."
|
|
73
|
+
},
|
|
74
|
+
"supersedes": {
|
|
75
|
+
"type": "array",
|
|
76
|
+
"items": {
|
|
77
|
+
"type": "string",
|
|
78
|
+
"pattern": "^ADR-[0-9]{3,4}$"
|
|
79
|
+
},
|
|
80
|
+
"description": "ADR ids this ADR supersedes."
|
|
81
|
+
},
|
|
82
|
+
"superseded_by": {
|
|
83
|
+
"type": [
|
|
84
|
+
"string",
|
|
85
|
+
"null"
|
|
86
|
+
],
|
|
87
|
+
"pattern": "^ADR-[0-9]{3,4}$",
|
|
88
|
+
"description": "Successor ADR id when this ADR is superseded."
|
|
89
|
+
},
|
|
90
|
+
"related": {
|
|
91
|
+
"type": "array",
|
|
92
|
+
"items": {
|
|
93
|
+
"type": "string",
|
|
94
|
+
"pattern": "^ADR-[0-9]{3,4}$"
|
|
95
|
+
},
|
|
96
|
+
"description": "ADR ids this ADR is related to, written on both sides by `bin/adr relate`. Symmetric: if A lists B, B lists A."
|
|
97
|
+
},
|
|
98
|
+
"format": {
|
|
99
|
+
"type": "string",
|
|
100
|
+
"enum": [
|
|
101
|
+
"madr",
|
|
102
|
+
"nygard",
|
|
103
|
+
"canonical"
|
|
104
|
+
],
|
|
105
|
+
"description": "Optional ADR body profile discriminator. Legacy records may omit it and are detected from headings."
|
|
106
|
+
},
|
|
107
|
+
"topics": {
|
|
108
|
+
"$ref": "#/$defs/retrievalStrings",
|
|
109
|
+
"description": "Optional deterministic topic terms for selective ADR retrieval."
|
|
110
|
+
},
|
|
111
|
+
"aliases": {
|
|
112
|
+
"$ref": "#/$defs/retrievalStrings",
|
|
113
|
+
"description": "Optional alternative names and phrases for selective ADR retrieval."
|
|
114
|
+
},
|
|
115
|
+
"components": {
|
|
116
|
+
"$ref": "#/$defs/retrievalStrings",
|
|
117
|
+
"description": "Optional architectural components named by this decision."
|
|
118
|
+
},
|
|
119
|
+
"symbols": {
|
|
120
|
+
"$ref": "#/$defs/retrievalStrings",
|
|
121
|
+
"description": "Optional code symbols named by this decision."
|
|
122
|
+
},
|
|
123
|
+
"context_scope": {
|
|
124
|
+
"type": "string",
|
|
125
|
+
"enum": [
|
|
126
|
+
"global",
|
|
127
|
+
"selective"
|
|
128
|
+
],
|
|
129
|
+
"description": "Whether the ADR is baseline context or requires positive selective evidence."
|
|
130
|
+
}
|
|
131
|
+
},
|
|
132
|
+
"$defs": {
|
|
133
|
+
"retrievalStrings": {
|
|
134
|
+
"type": "array",
|
|
135
|
+
"maxItems": 32,
|
|
136
|
+
"uniqueItems": true,
|
|
137
|
+
"items": {
|
|
138
|
+
"type": "string",
|
|
139
|
+
"minLength": 1,
|
|
140
|
+
"maxLength": 120
|
|
141
|
+
}
|
|
142
|
+
}
|
|
143
|
+
}
|
|
144
|
+
}
|