yarramate 0.3.1 → 0.3.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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "yarramate",
3
- "version": "0.3.1",
3
+ "version": "0.3.2",
4
4
  "description": "Tool-neutral semantic architecture engine and guided methodology",
5
5
  "license": "MIT",
6
6
  "repository": {
@@ -52,19 +52,34 @@ document, projection, evidence, or architecture-state syntax is needed.
52
52
  YAML directly when states or several related declarations make that clearer.
53
53
  6. Add an evidence overlay only for existing subjects or stable claim IDs.
54
54
  Evidence supports or challenges the proposal; it is not a second model.
55
- 7. Add one focused projection that answers the repository-orientation
56
- question.
57
- 8. Run:
55
+ 7. Add the focused projections needed to answer the
56
+ repository-orientation question. Add a separate projection for every
57
+ ordered flow that needs a dynamic view, then include each intended view in
58
+ `.yarramate/integrations/likec4/project.yaml`.
59
+ 8. Unless the user requested semantic-only output, create the optional LikeC4
60
+ mapping and project described in the authoring reference. Synchronize the
61
+ project mapping before every export, then run:
58
62
 
59
63
  ```sh
60
64
  yarramate check .yarramate/workspace.yaml --json
65
+ yarramate compile .yarramate/workspace.yaml
61
66
  yarramate evidence .yarramate/evidence/<evidence>.yaml .yarramate/workspace.yaml
62
67
  yarramate reconcile .yarramate/workspace.yaml
63
68
  yarramate context .yarramate/projections/<projection>.yaml .yarramate/workspace.yaml
64
69
  yarramate view .yarramate/projections/<projection>.yaml .yarramate/workspace.yaml
70
+ yarramate-likec4 map --sync .yarramate/integrations/likec4/subject-mapping.yaml .yarramate/workspace.yaml
71
+ yarramate-likec4 export-project .yarramate/integrations/likec4/project.yaml .yarramate-out/likec4 .yarramate/workspace.yaml
65
72
  ```
66
73
 
67
- 9. Present observations, reconciliation findings, interpretive proposals,
74
+ 9. Audit rendering coverage before handoff. Answer these as reporting
75
+ questions, not Core correctness rules:
76
+ - Which concepts appear in no projection?
77
+ - Which ordered relationship chains have no dynamic view?
78
+ - Which projections are absent from the LikeC4 project?
79
+ Inspect compiled subjects, projection results, and the project definition;
80
+ state intentional omissions explicitly. A green check does not answer
81
+ these questions.
82
+ 10. Present observations, reconciliation findings, interpretive proposals,
68
83
  evidence gaps, and Git diff separately. Do not claim completeness from a
69
84
  green check and do not automatically turn findings into edits.
70
85
 
@@ -84,17 +99,29 @@ yarramate view .yarramate/projections/<projection>.yaml .yarramate/workspace.yam
84
99
  5. Create:
85
100
  - an alternatives projection for the decision;
86
101
  - a bounded target projection for implementation agents.
87
- 6. Run:
102
+ - one focused projection per ordered flow that needs a dynamic view.
103
+ Include every intended view in
104
+ `.yarramate/integrations/likec4/project.yaml`.
105
+ 6. Synchronize the project mapping before every export, then run:
88
106
 
89
107
  ```sh
90
108
  yarramate check .yarramate/workspace.yaml --json
109
+ yarramate compile .yarramate/workspace.yaml
91
110
  yarramate context .yarramate/projections/<alternatives>.yaml .yarramate/workspace.yaml
92
111
  yarramate context .yarramate/projections/<target>.yaml .yarramate/workspace.yaml
93
112
  yarramate view .yarramate/projections/<target>.yaml .yarramate/workspace.yaml
94
- yarramate compare <baseline-state> <target-state> .yarramate/workspace.yaml
113
+ yarramate view .yarramate/projections/<flow>.yaml .yarramate/workspace.yaml
114
+ yarramate compare <document-id>#<baseline-state> <document-id>#<target-state> .yarramate/workspace.yaml
115
+ yarramate-likec4 map --sync .yarramate/integrations/likec4/subject-mapping.yaml .yarramate/workspace.yaml
116
+ yarramate-likec4 export-project .yarramate/integrations/likec4/project.yaml .yarramate-out/likec4 .yarramate/workspace.yaml
95
117
  ```
96
118
 
97
- 7. Present alternatives, selected intent, unresolved decisions, and bounded
119
+ Skip the two adapter commands only when the user requested semantic-only
120
+ output, and report that no visual project was produced.
121
+ 7. Audit rendering coverage using the same three reporting questions from
122
+ discovery. State which omissions are intentional; do not convert partial
123
+ coverage into a validation failure.
124
+ 8. Present alternatives, selected intent, unresolved decisions, and bounded
98
125
  implementation context. Do not generate code until the requested design
99
126
  decision is reviewable.
100
127
 
@@ -102,6 +129,8 @@ yarramate compare <baseline-state> <target-state> .yarramate/workspace.yaml
102
129
 
103
130
  - Treat `check` as deterministic correctness, never as architecture approval,
104
131
  completeness, or quality scoring.
132
+ - Keep LikeC4 optional. Default to visual output for these guided journeys,
133
+ but respect an explicit request for tool-neutral semantic output only.
105
134
  - Keep adapter fields outside native documents.
106
135
  - Use globally qualified identities at CLI and projection boundaries.
107
136
  - Preserve source-located diagnostics verbatim when asking the author to fix
@@ -119,7 +148,9 @@ Report:
119
148
  - journey used and question answered;
120
149
  - canonical files proposed or changed;
121
150
  - observations and evidence results;
122
- - projections produced;
151
+ - projections and views produced, including the LikeC4 project and generated
152
+ output path;
153
+ - rendering coverage gaps and whether the generated output is current;
123
154
  - validation commands and outcomes;
124
155
  - unresolved architectural decisions;
125
156
  - whether changes are merely proposed or already accepted in Git.
@@ -46,6 +46,9 @@ Discovery is minimally useful when:
46
46
  - significant proposed subjects have traceable observations or are explicitly
47
47
  identified as interpretation;
48
48
  - a focused projection gives an agent useful repository context;
49
+ - intended projections are rendered through a current LikeC4 project;
50
+ - concepts outside all projections, ordered flows without dynamic views, and
51
+ projections absent from the project are reported as coverage gaps;
49
52
  - evidence has not been promoted automatically.
50
53
 
51
54
  Design is minimally useful when:
@@ -54,4 +57,6 @@ Design is minimally useful when:
54
57
  - material alternatives remain reviewable;
55
58
  - the selected target has explicit boundaries and relationships;
56
59
  - a bounded target projection can guide implementation;
60
+ - intended projections are rendered through a current LikeC4 project;
61
+ - rendering coverage gaps are stated, including intentional omissions;
57
62
  - missing detail is visible without becoming a Core correctness error.
@@ -172,6 +172,47 @@ Evidence evaluates an existing subject or stable claim ID. Results are
172
172
  observed subject directly through evidence or mutate declared intent from an
173
173
  evidence result.
174
174
 
175
+ ## LikeC4 project
176
+
177
+ Keep visualization configuration outside native documents:
178
+
179
+ ```yaml
180
+ format: yarramate/likec4-project/v1
181
+ id: delivery
182
+ version: "1.0"
183
+ title: Delivery architecture
184
+ mapping: .yarramate/integrations/likec4/subject-mapping.yaml
185
+ views:
186
+ - projection: .yarramate/projections/delivery-target.yaml
187
+ - id: submit-order
188
+ projection: .yarramate/projections/submit-order.yaml
189
+ dynamic:
190
+ steps:
191
+ - relationship: delivery#customer-triggers-submit
192
+ - relationship: delivery#submit-triggers-confirmation
193
+ ```
194
+
195
+ Give every ordered flow its own focused projection and dynamic view. A dynamic
196
+ view takes its title and description from its projection; reusing one broad
197
+ projection for several flows makes their rendered identities ambiguous.
198
+ Ensure every intended projection is listed in the project.
199
+
200
+ Start the referenced mapping as a valid empty mapping, then let sync populate
201
+ it:
202
+
203
+ ```yaml
204
+ format: yarramate/adapter-mapping/v1
205
+ id: delivery-likec4
206
+ version: "1.0"
207
+ adapter: likec4
208
+ mappings: []
209
+ ```
210
+
211
+ `export-project` writes `.yarramate-out/likec4/yarramate.generated.json` with
212
+ digests for generated files. It refuses to replace a generated file that was
213
+ hand-edited. Treat that refusal as drift to inspect; do not delete the marker
214
+ or overwrite the output manually.
215
+
175
216
  ## Stable commands
176
217
 
177
218
  ```sh
@@ -193,6 +234,10 @@ yarramate reconcile .yarramate/workspace.yaml
193
234
  yarramate-likec4 map --sync \
194
235
  .yarramate/integrations/likec4/subject-mapping.yaml \
195
236
  .yarramate/workspace.yaml
237
+ yarramate-likec4 export-project \
238
+ .yarramate/integrations/likec4/project.yaml \
239
+ .yarramate-out/likec4 \
240
+ .yarramate/workspace.yaml
196
241
  ```
197
242
 
198
243
  Sync preserves and reports mappings for native subjects that no longer exist.