yarramate 0.3.3 → 0.4.0

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.
@@ -0,0 +1,273 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://yarramate.org/schema/status-result/v1",
4
+ "title": "YarraMate workspace status result",
5
+ "type": "object",
6
+ "additionalProperties": false,
7
+ "required": [
8
+ "format",
9
+ "workspace",
10
+ "ok",
11
+ "check",
12
+ "inventory"
13
+ ],
14
+ "properties": {
15
+ "format": {
16
+ "const": "yarramate/status-result/v1"
17
+ },
18
+ "workspace": {
19
+ "type": "string",
20
+ "minLength": 1
21
+ },
22
+ "ok": {
23
+ "type": "boolean"
24
+ },
25
+ "check": {
26
+ "type": "object",
27
+ "additionalProperties": false,
28
+ "required": [
29
+ "ok",
30
+ "diagnostics"
31
+ ],
32
+ "properties": {
33
+ "ok": {
34
+ "type": "boolean"
35
+ },
36
+ "diagnostics": {
37
+ "type": "array",
38
+ "items": {
39
+ "$ref": "#/$defs/diagnostic"
40
+ }
41
+ },
42
+ "counted": {
43
+ "type": "object",
44
+ "additionalProperties": false,
45
+ "required": [
46
+ "documents",
47
+ "concepts",
48
+ "relationships",
49
+ "states"
50
+ ],
51
+ "properties": {
52
+ "documents": {
53
+ "type": "integer",
54
+ "minimum": 0
55
+ },
56
+ "concepts": {
57
+ "type": "integer",
58
+ "minimum": 0
59
+ },
60
+ "relationships": {
61
+ "type": "integer",
62
+ "minimum": 0
63
+ },
64
+ "states": {
65
+ "type": "integer",
66
+ "minimum": 0
67
+ }
68
+ }
69
+ }
70
+ }
71
+ },
72
+ "reconciliation": {
73
+ "type": "object",
74
+ "additionalProperties": false,
75
+ "required": [
76
+ "evidenceDocuments",
77
+ "observations",
78
+ "confirmed",
79
+ "findings",
80
+ "contradicted",
81
+ "unknown",
82
+ "notObserved"
83
+ ],
84
+ "properties": {
85
+ "evidenceDocuments": {
86
+ "type": "integer",
87
+ "minimum": 0
88
+ },
89
+ "observations": {
90
+ "type": "integer",
91
+ "minimum": 0
92
+ },
93
+ "confirmed": {
94
+ "type": "integer",
95
+ "minimum": 0
96
+ },
97
+ "findings": {
98
+ "type": "integer",
99
+ "minimum": 0
100
+ },
101
+ "contradicted": {
102
+ "type": "integer",
103
+ "minimum": 0
104
+ },
105
+ "unknown": {
106
+ "type": "integer",
107
+ "minimum": 0
108
+ },
109
+ "notObserved": {
110
+ "type": "integer",
111
+ "minimum": 0
112
+ }
113
+ }
114
+ },
115
+ "inventory": {
116
+ "type": "object",
117
+ "additionalProperties": false,
118
+ "required": [
119
+ "documents",
120
+ "profiles",
121
+ "states",
122
+ "projections",
123
+ "evidence",
124
+ "adapterMappings",
125
+ "contracts"
126
+ ],
127
+ "properties": {
128
+ "documents": {
129
+ "type": "array",
130
+ "items": {
131
+ "type": "object",
132
+ "additionalProperties": false,
133
+ "required": [
134
+ "id",
135
+ "path"
136
+ ],
137
+ "properties": {
138
+ "id": {
139
+ "type": "string",
140
+ "minLength": 1
141
+ },
142
+ "path": {
143
+ "type": "string",
144
+ "minLength": 1
145
+ }
146
+ }
147
+ }
148
+ },
149
+ "profiles": {
150
+ "type": "array",
151
+ "items": {
152
+ "type": "string",
153
+ "minLength": 1
154
+ }
155
+ },
156
+ "states": {
157
+ "type": "array",
158
+ "items": {
159
+ "type": "object",
160
+ "additionalProperties": false,
161
+ "required": [
162
+ "id",
163
+ "type"
164
+ ],
165
+ "properties": {
166
+ "id": {
167
+ "type": "string",
168
+ "minLength": 1
169
+ },
170
+ "type": {
171
+ "enum": [
172
+ "baseline",
173
+ "transition",
174
+ "target"
175
+ ]
176
+ }
177
+ }
178
+ }
179
+ },
180
+ "projections": {
181
+ "type": "array",
182
+ "items": {
183
+ "type": "object",
184
+ "additionalProperties": false,
185
+ "required": [
186
+ "id",
187
+ "path"
188
+ ],
189
+ "properties": {
190
+ "id": {
191
+ "type": "string",
192
+ "minLength": 1
193
+ },
194
+ "path": {
195
+ "type": "string",
196
+ "minLength": 1
197
+ },
198
+ "title": {
199
+ "type": "string",
200
+ "minLength": 1
201
+ }
202
+ }
203
+ }
204
+ },
205
+ "evidence": {
206
+ "type": "array",
207
+ "items": {
208
+ "type": "string",
209
+ "minLength": 1
210
+ }
211
+ },
212
+ "adapterMappings": {
213
+ "type": "array",
214
+ "items": {
215
+ "type": "string",
216
+ "minLength": 1
217
+ }
218
+ },
219
+ "contracts": {
220
+ "type": "array",
221
+ "items": {
222
+ "type": "string",
223
+ "minLength": 1
224
+ }
225
+ }
226
+ }
227
+ }
228
+ },
229
+ "$defs": {
230
+ "diagnostic": {
231
+ "type": "object",
232
+ "additionalProperties": false,
233
+ "required": [
234
+ "severity",
235
+ "code",
236
+ "message",
237
+ "path",
238
+ "pointer",
239
+ "line",
240
+ "column"
241
+ ],
242
+ "properties": {
243
+ "severity": {
244
+ "const": "error"
245
+ },
246
+ "code": {
247
+ "type": "string",
248
+ "pattern": "^YM[0-9]{3}$"
249
+ },
250
+ "message": {
251
+ "type": "string",
252
+ "minLength": 1
253
+ },
254
+ "path": {
255
+ "type": "string",
256
+ "minLength": 1
257
+ },
258
+ "pointer": {
259
+ "type": "string",
260
+ "pattern": "^/"
261
+ },
262
+ "line": {
263
+ "type": "integer",
264
+ "minimum": 1
265
+ },
266
+ "column": {
267
+ "type": "integer",
268
+ "minimum": 1
269
+ }
270
+ }
271
+ }
272
+ }
273
+ }
@@ -22,6 +22,15 @@ automatically.
22
22
 
23
23
  ## Choose the journey
24
24
 
25
+ When a workspace already exists, orient first with one call before choosing:
26
+
27
+ ```sh
28
+ yarramate status <workspace.yaml> --json
29
+ ```
30
+
31
+ It reports the check verdict, the reconciliation summary, and a titled
32
+ inventory of documents, states, projections, evidence, and contracts.
33
+
25
34
  - Existing implementation is the starting point: follow **Discover an
26
35
  existing project**.
27
36
  - Intent and a not-yet-built solution are the starting point: follow **Design