thurview 0.16.0 → 0.17.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.
- package/README.md +1 -1
- package/dist/document/compile.js +81 -2
- package/dist/document/compile.js.map +1 -1
- package/dist/document/parse.js +37 -13
- package/dist/document/parse.js.map +1 -1
- package/dist/document/schema.js +36 -0
- package/dist/document/schema.js.map +1 -1
- package/dist/ui/app.css +55 -0
- package/dist/ui/app.js +148 -0
- package/dist/ui/app.js.map +3 -3
- package/package.json +1 -1
- package/skills/thurview/references/components.md +47 -0
- package/skills/thurview/references/document-authoring.md +5 -2
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "thurview",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.17.0",
|
|
4
4
|
"description": "Guided, evidence-anchored reviews of agent-written code. A coding agent authors the review; you read, ask, comment and decide in the browser.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -170,6 +170,53 @@ Rules:
|
|
|
170
170
|
against added lines in the pinned diff. Listing a frame on one side only
|
|
171
171
|
for contrast is rejected.
|
|
172
172
|
|
|
173
|
+
## flow
|
|
174
|
+
|
|
175
|
+
````markdown
|
|
176
|
+
```flow
|
|
177
|
+
label: Sign in
|
|
178
|
+
steps:
|
|
179
|
+
- { id: land, label: Visitor opens /login, actor: visitor, next: post }
|
|
180
|
+
- { id: post, label: Credentials posted, anchor: loginRoute, next: check }
|
|
181
|
+
- { id: check, label: Credentials valid?, anchor: checkUser,
|
|
182
|
+
when: [{ case: valid, to: home }, { case: rejected, to: retry }] }
|
|
183
|
+
- { id: retry, label: Error shown, anchor: renderError, next: post }
|
|
184
|
+
- { id: home, label: Dashboard, anchor: dashboard }
|
|
185
|
+
```
|
|
186
|
+
````
|
|
187
|
+
|
|
188
|
+
A user journey and where it branches - the shape `sequence` cannot hold,
|
|
189
|
+
because a decision is not a message. The first step is the entry; a step
|
|
190
|
+
continues with `next` or branches with `when`, and one with neither ends the
|
|
191
|
+
flow. Cycles are fine: a retry loop is what a journey does, and a step that
|
|
192
|
+
leads back up is drawn down a lane on the right, one lane per loop so two
|
|
193
|
+
retries never share a vertical run.
|
|
194
|
+
|
|
195
|
+
Every step is either code or a person: `anchor` is where the code does it and
|
|
196
|
+
the reader opens it by clicking, `actor` is a declared actor doing it outside
|
|
197
|
+
the code, and a step carries at least one of the two. An actor-only step is
|
|
198
|
+
drawn dashed, so the reader can see at a glance which parts open something.
|
|
199
|
+
|
|
200
|
+
`publish` refuses:
|
|
201
|
+
|
|
202
|
+
1. A step with neither `anchor` nor `actor`, and a block where no step has an
|
|
203
|
+
`anchor` at all - a flow nothing opens is prose in a box.
|
|
204
|
+
2. `next` and `when` on one step, and a `when` with a single case. One is a
|
|
205
|
+
branch, the other is a `next`.
|
|
206
|
+
3. A `next` or `to` naming a step the block does not declare, or naming itself.
|
|
207
|
+
4. A step unreachable from the first one, a duplicate `id`, an unknown `actor`,
|
|
208
|
+
and an anchor with no `peek`.
|
|
209
|
+
|
|
210
|
+
## Fences thurview does not render
|
|
211
|
+
|
|
212
|
+
`mermaid`, `plantuml`, `puml`, `dot`, `graphviz` and `d2` in a document body are
|
|
213
|
+
a publish error. They used to be neither components nor an error, so the block
|
|
214
|
+
reached the reader as its own source text with nothing saying so. thurview draws
|
|
215
|
+
only what it can anchor at the pinned commit: use `flow` for a journey and
|
|
216
|
+
`sequence` for a message exchange. To quote one of those languages as source -
|
|
217
|
+
reviewing a change to a repository's own diagrams - fence it as `text`, which
|
|
218
|
+
renders as the code block it is.
|
|
219
|
+
|
|
173
220
|
## database
|
|
174
221
|
|
|
175
222
|
````markdown
|
|
@@ -142,11 +142,14 @@ A claim you cannot anchor is a question, not a fact. Write it as one.
|
|
|
142
142
|
Use the fenced components for behaviour that prose explains badly:
|
|
143
143
|
|
|
144
144
|
- `sequence` for temporal behaviour across actors
|
|
145
|
+
- `flow` for a user journey and where it branches
|
|
145
146
|
- `callstack` for call-flow differences between base and head
|
|
146
147
|
- `database` for persisted-state structure and the operations on it
|
|
147
148
|
|
|
148
|
-
Each message, frame and operation carries an anchor, so the reader can
|
|
149
|
-
the code behind every arrow.
|
|
149
|
+
Each message, frame, step and operation carries an anchor, so the reader can
|
|
150
|
+
open the code behind every arrow. `mermaid` and the other general diagram
|
|
151
|
+
languages are a publish error rather than a fifth option: thurview draws only
|
|
152
|
+
what it can anchor. See [Components](components.md).
|
|
150
153
|
|
|
151
154
|
Add a diagram only when it materially helps. A document with one good
|
|
152
155
|
sequence diagram beats one with four.
|