Compare commits

...
Author SHA1 Message Date
root-at-skic 268c75cfae 0.9.2: fast-uri 3.1.9 and markdown-it 14.3.3 (npm audit)
fast-uri comes with ajv, which ships in extension.js from this release;
markdown-it is stubbed out of the Source bundle but was in the lockfile.
2026-10-27 23:47:50 +02:00
root-at-skic 27d4794ff8 0.9.2: Source view, schema checks without the YAML extension
Every Archify page can show its file's YAML in place. Diagrams get
Diagram | Graph | Source (Graph only inside a model), main.archify
Model | Graph | Source, registry and decision pages View | Source, and the
Graph page a Source segment. 2D | 3D moves left of that switch and hides
while Source shows.

The YAML opens in a CodeMirror editor inside the page (dist/source.js,
loaded on first use), themed with the page's colours. Edits go to the VS
Code document as WorkspaceEdits; outside changes come back to the page.
Undo and redo are the editor's own, since VS Code sends ⌘Z in a focused
webview to the webview; save and find stay VS Code's. Problems come from
the host only (what the Problems panel holds for the file) and are
counted on the Source segment; completion and hover come from the schema,
folded into one draft-07 document per diagram type.

The host now checks .archify files against the extension's schema with
ajv on the YAML as written, before archify validate, and checks
.archify-registry files against the registry schema for the first time.
Registry and decision pages become text editor providers. While Source
shows, new renders wait and appear when the picture comes back.

Show Source switches the page to Source; Open in Text Editor (the editor
title button) opens the text beside it, as Show Source did. The decision
schema is no longer given to the YAML extension. Fixed: YAML errors in
registry and decision files were reported on line 1; "Webview is
disposed" when a diagram closed mid-render; the model heading under the
toolbar in narrow editors.
2026-10-27 23:46:05 +02:00
root-at-skic 5bcd34b839 Merge pull request '0.9.1: republish for Open VSX' (#28) from rel/0.9.1 into main 2026-10-23 03:29:25 -07:00
root-at-skic 69b87833b7 0.9.1: republish so Open VSX carries the release 2026-10-23 13:29:14 +03:00
root-at-skic 058c0d17a8 Merge pull request '0.9.0: model graph with queries' (#27) from feat/model-graph into main 2026-10-21 13:08:35 -07:00
root-at-skic 8398c44ca8 Model graph: one head block with a consistent gutter and rhythm 2026-10-21 22:47:40 +03:00
root-at-skic 60ad7479fd Model graph: decision titles on two lines, refit after resize 2026-10-21 22:39:30 +03:00
root-at-skic bc9f55e2fa Model graph: decision and registry links on by default, placed near their elements 2026-10-21 22:33:02 +03:00
root-at-skic 27d1b4381c Model graph: theme toggle in the same pill as the switch and Export 2026-10-21 22:03:39 +03:00
root-at-skic 82dd10253b Model graph: toolbar on Archify's rules
- Archify's theme toggle: pill track, sliding knob, masked sun/moon icon
- buttons as quiet 0.5rem pills inside 0.5625rem controls, pressed state like Archify's, Export PNG as the filled 0.6875rem primary
- Model | Graph switch styled as the 2D | 3D switch's twin
2026-10-21 21:55:24 +03:00
root-at-skic 91fcde9fa5 Model graph: connection labels at the less crowded end 2026-10-21 21:47:08 +03:00
root-at-skic 17e07adb33 Model graph: layered layout and a cleaner look
- layered layout by type (clients left, data right), empty columns left out, barycenter row ordering; registries in a row above, decisions in a row below; Force layout as the alternative
- orthogonal connections with labels staggered next to their source; opaque tinted nodes hide lines behind them
- hover glow on elements and their connections; decision and registry links show for the selected element or all with Links
2026-10-21 21:45:42 +03:00
root-at-skic 3ed2d7eed8 Model graph: dark/light theme toggle on the page
- sun/moon button next to Export; the choice is remembered in the page state and written to the archify-theme key the diagram pages use
- explicit dark and light token sets; without a choice the page follows VS Code's theme as before
- Cytoscape restyles from the page tokens whenever the theme changes
2026-10-21 21:33:38 +03:00
root-at-skic 99ea076571 Model graph: decisions and registry files as nodes
- one node per decision (tag coloured by status) with decides links to its elements and supersedes links
- one node per registry file with defines links to its elements
- own legend chips, side panels (Open decision, Open registry), type:decision and type:registry
- walks and paths follow the diagrams' connections only; attached nodes follow their elements into a result
2026-10-21 20:46:05 +03:00
root-at-skic c8645b228b Model graph: the whole model as one graph with queries; 0.9.0
- Model | Graph switch on main.archify (Diagram | Graph on diagram pages, narrowed to that diagram)
- union graph of every element and connection, registry and inline, built from the model index
- query box: text, type:, diagram:, decision:, uses:, near:, from: to:, unused, shared, -shared
- side panel per element and connection with diagrams, registry line and decisions one click away
- legend chips, Fit, Layout, Labels, Export PNG; Cytoscape.js bundled as dist/graph.js
- command Archify | Open Model Graph; integration check; unit tests for graph and queries
2026-10-21 15:47:00 +03:00
root-at-skic 265f8c57f6 Merge pull request '0.8.1: New Registry command, creator order' (#26) from feat/new-registry into main 2026-10-20 01:23:03 -07:00
root-at-skic c66e819abe Archify | New Registry…; creators ordered Model, Registry, Diagram, Decision; 0.8.1 2026-10-20 10:55:00 +03:00
root-at-skic 2ba66c1ee2 Merge pull request '0.8.0: architecture decisions' (#25) from feat/decisions into main 2026-10-19 13:13:17 -07:00
root-at-skic ebf320a023 Architecture decisions: files, diagram references, views and panels
- *.archify-decision files: id (unique, words), title, status, date,
  elements, diagrams, supersedes, and prose; parsed, merged and link-checked
  in the model index; diagnostics on the file
- diagrams point at decisions with decisions: [...] on the diagram, nodes
  and edges; stripped before Archify, unknown ids reported, completion,
  hover and go-to-definition for the ids and for elements/diagrams/
  supersedes in decision files
- Decisions panel on the main.archify page; Decisions rail panel under a
  diagram (hover lights up the node or connection); decisions on element
  cards and in the element dialog; decision view for the file, with a
  lost-model note outside a model
- Archify | New Decision… command and template; editor schemas; the three
  New Model examples carry decisions; docs, changelog, 0.8.0
2026-10-19 23:13:05 +03:00
root-at-skic 33ebdd6328 Model page: title the registry files panel Registries; 0.7.2 2026-10-19 21:25:58 +03:00
root-at-skic 9684464630 Merge pull request '0.7.1: Registry panel lists registry files' (#23) from feat/registry-files into main 2026-10-19 10:59:47 -07:00
root-at-skic 094ca2925f Drop generated cards; registry descriptions become Elements tooltips
- resolveRefs no longer adds cards to a diagram; it returns node id →
  description, which the page sets as the tooltip of the matching row in
  Archify's Elements panel
- hand-written cards pass through unchanged; docs and changelog
2026-10-19 20:44:09 +03:00
root-at-skic de1a57e4c6 Model page: Registry panel lists registry files, elements inside each
- one collapsible header per .archify-registry file with its element
  count and an Open button that opens the registry view; files start
  collapsed, the Registry panel open
- view types moved to views/viewTypes.ts so the diagram page can open a
  registry without a circular import
- 0.7.1
2026-10-19 20:39:24 +03:00
root-at-skic 4382730343 Merge pull request 'Release 0.7.0: models (main.archify, registries, refs, links, model page)' (#22) from feat/model into main 2026-10-19 04:46:19 -07:00
root-at-skic b9676ece83 Registry view with element dialog; Elements and Connectors panels under diagrams
- .archify-registry opens in a new read-only custom editor (archify.registry,
  default): the file's elements as cards; click one for a dialog with its
  description, the defining line (opens the YAML) and the diagrams that use
  it (open on click); Show Source and Open Model work from the view
- the same dialog opens from the registry cards on the model page
- Archify's node index is titled Elements; a Connectors panel built from the
  SVG edges lists from → to with the label, highlights on hover and keeps the
  highlight on click; side by side in the bottom rail
- integration test for the registry view; docs and changelog
2026-10-19 13:53:14 +03:00
root-at-skic 36bccb69a5 Model page: Diagrams and Registry as collapsible panels, one header per folder
- <details> panels for Diagrams (open) and Registry (closed by default)
- each folder inside Diagrams is its own collapsible header with a count,
  above its diagram cards; diagrams next to main.archify list directly
- open/closed state is kept in the webview state, so re-renders and
  restores keep it
2026-10-19 12:58:07 +03:00
root-at-skic 38cdc7604f Registry as Archify cards on the model page; cards under model diagrams from registry descriptions
- model page: registry elements are rendered as Archify info cards (type
  colour dot, label, id · type, description, used-in chips that open the
  diagram), replacing the table
- resolveRefs: a diagram without cards of its own gets one card per drawn
  shared element that has a description, so the registry text shows under
  every model diagram as it does on hand-written diagrams
- unit tests for generated cards, own cards winning and no cards without
  refs; docs and changelog
2026-10-19 12:53:45 +03:00
root-at-skic 57914d435c Add Archify | New Model… with three C4 examples and Open Model in the Explorer menu
- templates/models: C4 - Standard Web App, C4 - E-Shop, C4 - Event-Based
  Integration; each a complete model (main.archify, registry, context,
  containers, components) that validates
- archify.newModel: pick an example and a folder name, copy it, name the
  model after the folder, open the model page
- Explorer menu: New Model… on folders, Open Model on .archify and
  .archify-registry files; File → New File… lists New Model…
- unit test validates every example end to end; integration test runs the
  command; README, CHANGELOG, docs/model.md
2026-10-19 12:12:49 +03:00
root-at-skic 7a2b661afe Models: main.archify, registries, refs, links and the model page; 0.7.0
A folder with main.archify at its top is a model, a set of diagrams
that belong together. Opening main.archify shows the model page: the
model's name and description, its own overview diagram when the file
has one, the diagrams grouped by folder (click to open), and the
registry with where each element is used. The page is built by
traversing the folder tree and refreshes when files change.

*.archify-registry files define shared elements once; diagrams draw
them with `ref: <id>` plus position and may override label, sublabel
and tag. References are resolved before Archify runs, so Archify is
unchanged. Hover, go-to-definition and completion on ref; unknown
names, forbidden overrides, duplicate ids and broken registries in
Problems; registry edits re-render open diagrams. `diagram:` links on
elements and components open the linked diagram on double-click.

New command Archify | Open Model, a Model template for New Diagram…,
editor schemas for the new keys and for registries, docs/model.md and
examples/online-shop. Single diagrams behave exactly as before.
2026-10-19 11:37:20 +03:00
root-at-skic 701ffc7607 Merge pull request 'Release 0.6.2: Sponsor button and Support section (Buy Me a Coffee)' (#21) from chore/sponsor-link into main 2026-10-19 00:04:54 -07:00
root-at-skic 17ca07d9ba Add the sponsor link (Buy Me a Coffee); 0.6.2
package.json declares sponsor.url, so the Extensions view and the
Marketplace page show a Sponsor button. The README mentions it after
the introduction and gets a Support section with the button.
2026-10-19 10:04:48 +03:00
root-at-skic 66a60bada6 Merge pull request 'Release 0.6.1: 2D | 3D switch next to Export, 3D controls in the dock' (#20) from fix/3d-switch into main 2026-10-12 11:09:19 -07:00
115 changed files with 9754 additions and 124 deletions

No files matched your search

+56
View File
@@ -1,5 +1,61 @@
# Changelog # Changelog
## 0.9.2 — 2026-10-27
- **Source view.** Every Archify page can show its file's YAML in place: **Diagram | Graph | Source** on diagrams (the old **Diagram | Graph** switch, now on every diagram; Graph only inside a model), **Model | Graph | Source** on `main.archify`, **View | Source** on registry and decision pages, and Source on the Graph page too. The YAML opens in an editor inside the page, under its toolbar and heading, in the page's own colours: line numbers, folding, brackets, multiple cursors, undo and redo, ⌘S/Ctrl+S saves. Problems are underlined as you type, listed under the editor (click the count to go to the next one) and counted on the **Source** segment, also while the picture shows. Completion and hover come from the schema of the file, with nothing else installed. Edits go to the VS Code document, so the tab's dirty dot, save, Git and the text editor stay in step. **Diagram** (or **Model**, **View**) brings the picture back as it was left; anything rendered meanwhile shows then.
- **2D | 3D** now sits left of the view switch (it says how the picture is drawn, the switch what is shown) and hides while Source shows; the 3D stage stops drawing meanwhile.
- **Schema checks without the YAML extension.** `.archify` files are checked against the extension's schema on the YAML as written, at once and with readable messages (`Unknown key "lable" in connections[4].`) on the key or value concerned; `archify validate` runs once the schema is satisfied. `.archify-registry` files are checked against the registry schema for the first time (types, unknown keys, ids). The decision schema is no longer handed to the YAML extension: decision files use the `decision` key twice by design, which it reported as an error in every file.
- **Commands.** *Archify | Show Source* switches the focused page to its Source view. The old behaviour, the YAML in VS Code's text editor beside the page, is *Archify | Open in Text Editor*, which is now the editor-title button.
- Registry and decision pages are text editors of their files (as diagram pages already were), so edits made there make the tab dirty and save with it.
- Fixed: a YAML error in a registry or decision file was reported on its first line instead of where it is.
- Fixed: an unhandled "Webview is disposed" error when a diagram closed while it was rendering. On `main.archify` pages with a diagram, the model heading no longer runs under the toolbar in narrow editors.
## 0.9.1 — 2026-10-23
- No functional change. Republished so that Open VSX carries the release: the 0.9.0 upload there was held under review while the `root-at-skic` namespace was still unverified, and a held upload is not released by the later ownership grant.
## 0.9.0 — 2026-10-21
- **Model graph.** A **Model | Graph** switch on the `main.archify` page (next to **Export** when the file has a diagram, top right otherwise) replaces the page with the whole model as one graph: every element any diagram draws plus every registry element, every connection between them, each once, drawn with Cytoscape.js in Archify's type colours. Registry elements have a solid border, inline ones a dashed border. **Decisions** and **registry files** are nodes as well: a decision is a tag coloured by status with dotted links to the elements and connections it is about and dashed links to what it supersedes; a registry links to the elements it defines. Layered layout by type (clients left, data right, registries above, decisions below, orthogonal connections) or a force layout; hover lights up an element and its connections; the dotted decision and registry links are shown by default; **Links** switches them to the selected element only. Drag, zoom, **Fit**, **Labels**, a dark/light theme toggle of its own (remembered, and shared with the diagram pages' theme key), legend chips that hide a type (decisions and registries included), **Export PNG**. The choice is remembered per file; the graph updates in place as the model changes.
- **Queries.** A query box narrows the graph: `database`, `type:backend`, `diagram:0200-*`, `decision:<id>`, `uses:api`, `near:api,2`, `from:web to:db` (shortest path), `unused`, `shared`, `-shared`, `type:decision`, `type:registry`; terms AND together, a leading `-` excludes; decisions and registries follow their elements into a result, and walks never pass through them; the count reads "9 of 14 elements"; **?** lists the forms and runs an example on click.
- **Side panel.** An element shows its description, type, registry file and line (**Registry** opens it), the diagrams that draw it, its connections and its decisions, each one click away; **Neighbours** queries around it. A connection shows its labels, diagrams and decisions. A decision node shows its status, text, the elements and connections it is about and **Open decision**; a registry node the elements it defines and **Open registry**.
- **Entry points.** On a diagram page inside a model the switch reads **Diagram | Graph** and opens the graph narrowed to `diagram:<that diagram>`. New command *Archify | Open Model Graph* in the editor title, the Command Palette and the Explorer menu, wherever *Open Model* is.
- Diagram summaries in the model index now carry every node and edge of a diagram (shared and inline), which the graph is built from.
## 0.8.1 — 2026-10-20
- **Archify | New Registry…** on a folder (also *File → New File…* and the Command Palette) creates an `.archify-registry` file from the template and opens it.
- The Archify entries in the Explorer menu and *File → New File…* come in the order New Model, New Registry, New Diagram, New Decision.
## 0.8.0 — 2026-10-19
- **Architecture decisions.** A model can hold decisions: one `*.archify-decision` file each, anywhere under the model root, with an id (unique in the model), title, status, date, the registry `elements` and `diagrams` it is about, `supersedes`, and prose for context, decision and consequences.
- **Diagrams point at decisions** with `decisions: [<id>]` on the diagram, on a component, node or participant, and on a connection, edge, flow, transition or message. The key is stripped before Archify renders. Unknown ids, and the key outside a model, are reported in Problems. Completion, hover and go-to-definition for decision ids; in decision files the same for `elements`, `diagrams` and `supersedes`.
- **Where they show.** A **Decisions** panel on the `main.archify` page (one list, live decisions first, superseded and rejected dimmed and last). A **Decisions** rail panel under a diagram with the decisions it points at or that name it; hovering a row lights up the node or connection it is attached to, clicking opens the decision. A decision view when a `.archify-decision` file is opened: status, date, context, decision, consequences, related decisions, the elements as cards, the diagrams with where the decision is attached. Decisions also appear on element cards and in the element dialog.
- **Authoring.** *Archify | New Decision…* on a folder inside a model creates a decision file from a template, with the id taken from the title. Editor schema for decision files and the new `decisions` key. A decision outside a model opens, but the page and Problems say it has lost its model.
- The three New Model examples carry decisions. Model page: the registry files panel is titled **Registries**.
## 0.7.1 — 2026-10-19
- **No generated cards.** The cards 0.7.0 generated under model diagrams from registry descriptions are gone; they repeated the Elements panel. The description now shows as the tooltip of the element's row in the Elements panel. Hand-written `cards:` are unchanged.
- **Model page, Registry panel:** lists the registry files of the model, one collapsible header per file with its element count and an **Open** button that opens the registry view; expand a file to see its elements as cards. Before, all elements of all files were shown in one grid.
## 0.7.0 — 2026-10-19
- **Models:** a folder with a `main.archify` at its top is a model, a set of diagrams that belong together. Opening `main.archify` shows the model page: name and description, the overview diagram if the file has one, the diagrams grouped by folder (click to open), and the registry with where each element is used.
- **Registry:** `*.archify-registry` files define shared elements once; diagrams draw them with `ref: <id>` plus position, and may override `label`, `sublabel` and `tag`. Hover, go-to-definition and completion on `ref`; unknown names, forbidden overrides, duplicate ids and broken registries in Problems. Registry edits re-render open diagrams.
- **Registry view:** `.archify-registry` files open as their elements (cards). Clicking an element opens a dialog with its description, the registry line that defines it and the diagrams that use it; the same dialog opens from the registry cards on the model page. *Show Source* opens the YAML beside the view.
- **Elements and Connectors:** the node index under a diagram is titled *Elements*; a new *Connectors* panel lists every connection (from → to, label), highlights it on hover and keeps it highlighted on click.
- **Model page panels:** Diagrams and Registry are collapsible panels; inside Diagrams every folder has its own collapsible header above its diagram cards. Open or closed is remembered.
- **Cards:** a model diagram without `cards` of its own gets Archify cards from the registry descriptions of the elements it draws; the model page shows the registry as the same cards, each with the diagrams it is used in.
- **Links:** `diagram:` on a registry element or a component points at the diagram that explains it; double-click the node (2D view) to open it.
- **New Model…:** right-click a folder and choose *Archify | New Model…* (also in *File → New File…* and the Command Palette) to start from one of three complete C4 examples: **C4 - Standard Web App**, **C4 - E-Shop**, **C4 - Event-Based Integration**. Each creates a model folder with `main.archify`, a registry and context, container and component diagrams, named after the folder you choose, and opens the model page.
- New commands *Archify | Open Model* (editor title, Command Palette and the Explorer menu of `.archify` and `.archify-registry` files); *New Diagram… → Model (main.archify)* template for an empty model; editor schema for registries and the new keys; example model in `examples/online-shop`.
## 0.6.2 — 2026-10-19
- **Sponsor button:** the extension now declares a sponsor link, so VS Code's Extensions view and the Marketplace page show **Sponsor** (Buy Me a Coffee). The README has a Support section with the same link.
## 0.6.1 — 2026-10-12 ## 0.6.1 — 2026-10-12
- The 3D menu is replaced by a **2D | 3D** switch next to **Export**: the filled half is the view you are in, one click flips it. - The 3D menu is replaced by a **2D | 3D** switch next to **Export**: the filled half is the view you are in, one click flips it.
+55 -8
View File
@@ -6,11 +6,13 @@ Create and view [Archify](https://github.com/tt-a1i/archify) diagrams inside VS
This is an unofficial extension. It bundles the Archify renderer (MIT, © tt-a1i) and runs it on VS Code's own Node runtime, so nothing else needs to be installed. This is an unofficial extension. It bundles the Archify renderer (MIT, © tt-a1i) and runs it on VS Code's own Node runtime, so nothing else needs to be installed.
Free and open source. If it saves you time, you can [buy me a coffee](https://buymeacoffee.com/root.at.skic) ☕
## Supported files ## Supported files
| File | Format | What the extension does | | File | Format | What the extension does |
|---|---|---| |---|---|---|
| **`name.archify`** | **YAML** (the main format) | Opens as the interactive diagram. Show Source, live updates, validation, completion, templates. | | **`name.archify`** | **YAML** (the main format) | Opens as the interactive diagram, with a Source view for its YAML. Live updates, validation, completion, templates. |
| `name.architecture.json`, `name.workflow.json`, `name.sequence.json`, `name.dataflow.json`, `name.lifecycle.json` | JSON (Archify's own CLI format) | Opens as text, with a preview beside it and validation. For files produced by the Archify CLI or AI agents. | | `name.architecture.json`, `name.workflow.json`, `name.sequence.json`, `name.dataflow.json`, `name.lifecycle.json` | JSON (Archify's own CLI format) | Opens as text, with a preview beside it and validation. For files produced by the Archify CLI or AI agents. |
| Rendered Archify `.html` | HTML | Read-only viewer instead of a browser. | | Rendered Archify `.html` | HTML | Read-only viewer instead of a browser. |
@@ -20,6 +22,8 @@ New diagrams should be `.archify` files; everything below describes them unless
The fastest start: right-click a folder in the Explorer and choose **Archify | New Diagram…** (also in *File → New File…* and the Command Palette). Pick a kind of diagram (Architecture, Workflow, Sequence, Data Flow, Lifecycle or Everyday Plan), give it a name, and a small working `.archify` file is created and opened. Change its YAML to fit your case. The fastest start: right-click a folder in the Explorer and choose **Archify | New Diagram…** (also in *File → New File…* and the Command Palette). Pick a kind of diagram (Architecture, Workflow, Sequence, Data Flow, Lifecycle or Everyday Plan), give it a name, and a small working `.archify` file is created and opened. Change its YAML to fit your case.
For a whole set of diagrams, choose **Archify | New Model…** instead and pick one of the examples (C4 - Standard Web App, C4 - E-Shop, C4 - Event-Based Integration). A model folder with context, container and component diagrams and a shared registry is created and its model page opens. See [Models](#models).
To write one by hand: To write one by hand:
1. Create a file ending in `.archify`, for example `hello.archify`: 1. Create a file ending in `.archify`, for example `hello.archify`:
@@ -40,7 +44,7 @@ To write one by hand:
``` ```
2. Click it in the Explorer: the diagram opens. 2. Click it in the Explorer: the diagram opens.
3. To edit, use **Show Source** in the editor title. The YAML opens beside the diagram, which re-renders as you type. 3. To edit, click **Source** in the diagram's toolbar (**Diagram | Graph | Source**). The YAML takes the picture's place, checked as you type; **Diagram** brings the picture back. To see the text and the picture side by side, use **Open in Text Editor** in the editor title instead: the diagram re-renders as you type.
The same file is in [examples/hello.archify](examples/hello.archify). The same file is in [examples/hello.archify](examples/hello.archify).
@@ -49,7 +53,7 @@ The same file is in [examples/hello.archify](examples/hello.archify).
A `.archify` file is an Archify diagram written in **YAML**. Its fields are those of Archify's diagram schema; the extension converts the YAML for the renderer, so you never handle JSON yourself. `diagram_type` selects the kind of diagram: `architecture`, `workflow`, `sequence`, `dataflow` or `lifecycle`. A `.archify` file is an Archify diagram written in **YAML**. Its fields are those of Archify's diagram schema; the extension converts the YAML for the renderer, so you never handle JSON yourself. `diagram_type` selects the kind of diagram: `architecture`, `workflow`, `sequence`, `dataflow` or `lifecycle`.
- **Opening:** the **Archify Diagram** editor is the default for `.archify`. Use *Reopen Editor With… → Text Editor* to edit the YAML full-screen. - **Opening:** the **Archify Diagram** editor is the default for `.archify`. Use *Reopen Editor With… → Text Editor* to edit the YAML full-screen.
- **Completion:** with the [YAML extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) (`redhat.vscode-yaml`) installed, `.archify` files get completion and hover from Archify's schemas. The schema follows `diagram_type`. - **Completion:** in the Source view, `.archify` and `.archify-registry` files get completion and hover from Archify's schemas, with nothing else installed; the schema follows `diagram_type`. In VS Code's text editor the same comes from the [YAML extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) (`redhat.vscode-yaml`), if installed.
`.archify` files from extension version 0.2.0 were written in JSON. They still open, because JSON is valid YAML, but new files should use YAML. `.archify` files from extension version 0.2.0 were written in JSON. They still open, because JSON is valid YAML, but new files should use YAML.
@@ -60,19 +64,21 @@ The Archify CLI and the AI agents that use it write diagrams as JSON, named `nam
## Features ## Features
- **New diagram from a template**: *Archify | New Diagram…* creates a starter `.archify` file for any of the five diagram kinds, or an everyday plan, in the chosen folder. - **New diagram from a template**: *Archify | New Diagram…* creates a starter `.archify` file for any of the five diagram kinds, or an everyday plan, in the chosen folder.
- **Diagram editor**: `.archify` files open as the rendered diagram. **Show Source** opens the YAML beside it, and edits re-render live. - **New model from an example**: *Archify | New Model…* creates a complete model folder from a C4 example (Standard Web App, E-Shop, Event-Based Integration).
- **Model graph**: the **Graph** switch on any page of a model shows the whole model as one graph, with a query box (`type:database`, `uses:api`, `from:web to:db`, …), a side panel per element and PNG export. See [Models](#models).
- **Diagram editor**: `.archify` files open as the rendered diagram. **Source** shows the YAML in its place, in an editor inside the page: problems underlined as you type and counted on the switch, completion and hover from the schema, undo, and ⌘S/Ctrl+S to save. **Open in Text Editor** opens the YAML beside the diagram instead, and edits re-render live.
- **Live updates**: the diagram re-renders as you edit, and keeps the focus and route you selected (`#focus=…`, `#route=…`). - **Live updates**: the diagram re-renders as you edit, and keeps the focus and route you selected (`#focus=…`, `#route=…`).
- **HTML viewer**: right-click a rendered `.html` file and choose **Archify | Open in HTML Viewer**, or use *Reopen Editor With… → Archify HTML Viewer*. For Archify HTML already open as text, a button appears in the editor title. The viewer reloads when the file changes on disk. - **HTML viewer**: right-click a rendered `.html` file and choose **Archify | Open in HTML Viewer**, or use *Reopen Editor With… → Archify HTML Viewer*. For Archify HTML already open as text, a button appears in the editor title. The viewer reloads when the file changes on disk.
- **Problems**: YAML syntax errors, plus `archify validate`'s schema, layout and evidence problems, appear at the matching line of the `.archify` file. - **Problems**: YAML syntax errors, schema problems (unknown keys, wrong types, missing fields, checked with the extension's own schema check on the YAML as written) and `archify validate`'s layout and evidence problems appear at the matching place in the `.archify` file. Registries are checked against their schema too.
- **Brand logos**: after `brand:` the editor suggests Archify's built-in brand IDs (PostgreSQL, Redis, Kafka, Docker, …). Typing an alias or product name finds them too, so `kafka` offers `apache-kafka`. An unknown brand is reported on its own line. - **Brand logos**: after `brand:` the editor suggests Archify's built-in brand IDs (PostgreSQL, Redis, Kafka, Docker, …). Typing an alias or product name finds them too, so `kafka` offers `apache-kafka`. An unknown brand is reported on its own line.
- **Schema help**: completion and hover from Archify's own schemas, through the YAML extension for `.archify` files. - **Schema help**: completion and hover from Archify's own schemas: in the Source view built in, in the text editor through the YAML extension.
- **Source links**: in source-backed diagrams, clicking a source reference opens that file and line range in the editor. If the file is not in the workspace, the web link opens instead. - **Source links**: in source-backed diagrams, clicking a source reference opens that file and line range in the editor. If the file is not in the workspace, the web link opens instead.
- **Export**: the diagram's own Export menu (PNG, SVG, share card, …) saves through a VS Code save dialog. - **Export**: the diagram's own Export menu (PNG, SVG, share card, …) saves through a VS Code save dialog.
- **Commands**: *Archify | New Diagram…*, *Archify | Render to HTML File…*, *Archify | Open in Browser*, *Archify | Refresh Preview*, *Archify | Show Source*. - **Commands**: *Archify | New Model…*, *Archify | New Registry…*, *Archify | New Diagram…*, *Archify | New Decision…*, *Archify | Open Model*, *Archify | Open Model Graph*, *Archify | Render to HTML File…*, *Archify | Open in Browser*, *Archify | Refresh Preview*, *Archify | Show Source* (switches the page to its Source view), *Archify | Open in Text Editor*.
## 3D view ## 3D view
Every diagram can also be seen in 3D. The **2D | 3D** switch next to **Export** in the diagram's toolbar shows which view you are in; click it to flip. Every diagram can also be seen in 3D. The **2D | 3D** switch in the diagram's toolbar, left of **Diagram | Graph | Source**, shows which view you are in; click it to flip. It hides while Source shows, and **Diagram** returns to the 2D or 3D you left.
![The same diagram in the 3D view](docs/preview-3d.png) ![The same diagram in the 3D view](docs/preview-3d.png)
@@ -95,6 +101,39 @@ Animation follows 2D exactly, because the 3D view reads Archify's own animations
The 3D view draws only when something moves, so an idle diagram costs no GPU time. The 3D view draws only when something moves, so an idle diagram costs no GPU time.
## Models
A single `.archify` file is one diagram. A folder with a **`main.archify`** at its top is a **model**: a set of diagrams that belong together, of any kind, with shared elements defined once. Diagrams inside a model still open, render and export on their own.
```
online-shop/
main.archify id, name, description; optionally an overview diagram
registry/
people.archify-registry shared elements: one name for one thing
systems.archify-registry
containers.archify-registry
decisions/
0002-queue-between-api-and-worker.archify-decision
0100-context/online-shop.archify
0200-containers/online-shop.archify
0300-components/api.archify
```
- **The model page.** Click `main.archify` and you get the model's page: its name and description, the overview diagram if the file has one, then two collapsible panels: **Diagrams**, with a collapsible header per folder and a card per diagram (click to open), and **Registries**, one collapsible header per registry file (with an **Open** button for its view) and the file's elements as cards inside, each with the diagrams it is used in. Open or closed is remembered per page.
- **Shared elements.** A registry file defines an element once (`type`, `label`, `sublabel`, `brand`, `description`, …). A diagram draws it with `ref: api` plus `pos` and `size`; it may override `label`, `sublabel` and `tag`, and may still define unshared elements inline. Hover a `ref` for the description, F12 jumps to the registry, completion after `ref:` lists the elements, unknown names appear in Problems.
- **Links.** A registry element (or a component) with `diagram: 0300-components/api.archify` points at the diagram that explains it: double-click the node in the 2D view to open it.
- **Descriptions.** Under a model diagram, hovering a row of the **Elements** panel shows the registry description of that element.
- **Decisions.** One `*.archify-decision` file per architecture decision: id, title, status, date, the registry elements and diagrams it is about, and prose for context, decision and consequences. Diagrams point at decisions with `decisions: [<id>]` on the diagram, a component or a connection. They show as a **Decisions** panel on the `main.archify` page, a **Decisions** rail panel under each diagram (hover lights up what the decision is attached to), on element cards and in the element dialog, and a decision opens as its own page. *Archify | New Decision…* creates one; links are checked in Problems.
- **Registry view.** A `.archify-registry` file opens as its elements, as cards. Click one and a dialog shows its description, where it is defined and the diagrams that use it; click a diagram to open it. **View | Source** at the top right switches to the YAML, checked against the registry schema as you type.
- **Elements and Connectors.** Under every diagram, Archify's node index is titled **Elements**, and a **Connectors** panel next to it lists every connection as "from → to" with its label. Hovering highlights the connector in the diagram; clicking keeps it highlighted and scrolls to it.
- **Starting one.** *Archify | New Model…* (right-click a folder) copies one of the shipped examples into a new folder, named as you choose: **C4 - Standard Web App** (single-page app, API, database, cache, storage, identity provider), **C4 - E-Shop** (web shop, API, worker, queue, payment and email providers) or **C4 - Event-Based Integration** (event bus, router, dead-letter queue, event store, consumers). Each has a registry and context, container and component diagrams. For an empty model, *Archify | New Diagram… → Model* creates just a `main.archify`.
- **The graph.** The **Model | Graph | Source** switch at the top of the `main.archify` page (next to **Export** when the file has a diagram) replaces the page with the whole model as one graph: every element any diagram draws plus every registry element, every connection between them, each once. Registry elements have a solid border, inline ones a dashed border; colours are Archify's type colours and the legend chips at the bottom hide or show a type. **Decisions** are nodes too (tags coloured by status, dotted links to the elements they are about, dashed links to what they supersede), and so are **registries** (one node per file, dotted links to the elements it defines); their chips hide them when the picture gets busy. The layout is **Layered** by default, like Archify's stack: clients on the left, data on the right, registries in a row above, decisions in a row below, connections drawn orthogonally; click the button for a **Force** layout instead. Drag nodes, scroll to zoom, **Fit** (or <kbd>0</kbd>) frames what matches, **Labels** toggles connection labels, the dotted **Links** from decisions and registries to their elements are on by default and can be switched off, in which case only the selected element's show (hovering an element lights up its connections), the sun/moon button switches the page between its dark and light theme (remembered, shared with the diagram pages' theme choice), **Export PNG** saves the picture. On a diagram page the switch reads **Diagram | Graph | Source** and Graph opens the graph already narrowed to that diagram; **Source** on the graph page goes back to `main.archify` in its Source view. *Archify | Open Model Graph* does the same from the Command Palette or Explorer.
- **Queries.** Type a few words in the box (<kbd>/</kbd> focuses it); matches stay bright, the rest dims, the count shows "9 of 14 elements". Terms combine with AND and a leading `-` excludes: `database` (id, label, sublabel, brand or type contain it), `type:backend`, `diagram:0200-*` (what those diagrams draw), `decision:<id>` (what a decision is about or is attached to), `uses:api` (an element and its neighbours), `near:api,2` (within two steps), `from:web to:db` (the shortest path, following the arrows first), `unused` (registry elements no diagram draws), `shared` and `-shared` (registry or inline elements only), `type:decision` and `type:registry` for the decision and registry nodes. Decisions and registries follow the elements they are attached to into a result; `-type:decision` or `-type:registry` leaves them out. Walks and paths follow the diagrams' connections only, so a registry is never a shortcut between its elements. The **?** button lists them; clicking an example runs it.
- **Side panel.** Click an element for its description, type, where it is defined (**Registry** opens the file at the line), the diagrams that draw it (click to open), its connections and its decisions (click to open). **Neighbours** runs `uses:` for it. Click a connection for its labels, the diagrams that draw it and its decisions. Click a decision node for its status, context and decision text, the elements and connections it is about, and **Open decision**; a registry node for the elements it defines, the ones no diagram draws yet, and **Open registry**.
- **Commands.** *Archify | Open Model* opens the model page of the current file, from the editor title, the Command Palette or the Explorer menu of a `.archify` or `.archify-registry` file; *Archify | Open Model Graph* opens the graph.
Formats in detail: [docs/model.md](docs/model.md). A full example: [examples/online-shop](examples/online-shop).
## Source evidence ## Source evidence
A diagram that declares `meta.repository` and `sources` is verified against a local Git checkout whose `origin` and pinned commit match. The extension uses the Git top-level directory of the diagram file, or `archify.repoRoot` when set. A diagram that declares `meta.repository` and `sources` is verified against a local Git checkout whose `origin` and pinned commit match. The extension uses the Git top-level directory of the diagram file, or `archify.repoRoot` when set.
@@ -156,6 +195,14 @@ npm test
`vendor/archify.json` records the upstream version and commit. `vendor/archify.json` records the upstream version and commit.
## Support
Archify Diagram Viewer is built and maintained in my spare time. If it helps you, a coffee keeps the releases coming:
[![Buy me a coffee](https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png)](https://buymeacoffee.com/root.at.skic)
Bug reports and ideas are welcome in the [repository issues](https://gitea.lego-cloud.eu/vscode-extensions/archify-vscode-ext/issues).
## License ## License
MIT. See [LICENSE](LICENSE). The bundled renderer is MIT-licensed by tt-a1i; see `vendor/archify/LICENSE` and `vendor/archify/THIRD_PARTY_NOTICES.md`. MIT. See [LICENSE](LICENSE). The bundled renderer is MIT-licensed by tt-a1i; see `vendor/archify/LICENSE` and `vendor/archify/THIRD_PARTY_NOTICES.md`.
+146
View File
@@ -0,0 +1,146 @@
# Models: the file formats
A model is a folder of diagrams that belong together: a `main.archify` at its top, any number of diagrams below it, and `*.archify-registry` files for the things several diagrams share. Three file kinds, all YAML, all read by the extension; Archify itself only ever sees plain diagrams.
## `main.archify`
```yaml
schema_version: 1
model:
id: online-shop
name: Online Shop
description: >
Web shop, its API, workers and stores.
```
Optionally, below the `model` block, a diagram exactly as in any other `.archify` file (`diagram_type`, `meta`, `components`, …). The extension shows it on the model page; Archify never sees the `model` block.
## `name.archify-registry`
```yaml
schema_version: 1
elements:
api:
type: backend
label: API
sublabel: REST service
brand: node-js
description: >
Node.js service behind the load balancer.
diagram: 0300-components/api.archify
db:
type: database
label: Database
sublabel: PostgreSQL
brand: postgresql
description: Orders, customers and catalogue.
```
- The key is the element's id, unique across all registry files of the model.
- `type`, `label`, `sublabel`, `tag`, `icon`, `brand`, `sources` are Archify's component fields and are copied into every diagram that refers to the element.
- `description` is the one description of the thing; shown on hover and on the model page, never sent to Archify.
- `diagram` is the link: the diagram that explains the element, relative to the model root. Clicking the element in any diagram opens it.
## A diagram that refers to the registry
```yaml
components:
- ref: api
pos: [250, 160]
size: [130, 60]
- ref: db
label: Orders DB # a diagram may override label, sublabel, tag
pos: [460, 260]
size: [130, 60]
- id: cron # an unshared element, inline, as today
type: backend
label: Nightly job
pos: [460, 420]
size: [130, 60]
```
- `ref` names a registry element; `id` defaults to the same name. `id: db-replica` with `ref: db` draws the same element twice or under another id.
- A diagram may override `label`, `sublabel` and `tag`; never `type` or `brand` (if those differ, it is a different element).
- Before Archify runs, the extension replaces each `ref` component with the registry element plus the diagram's own fields, drops `description` and `diagram`, and hands Archify an ordinary component.
- Connections, boundaries and everything else stay as they are and use the ids as before.
## Descriptions under a model diagram
Archify's **Elements** panel under a diagram lists its nodes. For a `ref` component the row's tooltip is the element's registry `description`. Archify's own `cards:` stay what they are: write them in the diagram when you want text blocks below it; nothing is generated.
## Links between diagrams
A diagram may point at another diagram from a component, whether shared or inline:
```yaml
- ref: api
pos: [250, 160]
size: [130, 60]
diagram: 0300-components/api.archify # overrides the registry's link for this diagram
```
Registry `diagram` links and component `diagram` links are the same mechanism; the component's wins when both exist. Paths are relative to the model root.
## Outside a model
A diagram with `ref` components outside any model (no `main.archify` above it) reports "no registry found" and shows the component by its ref name with type `external`, so the picture still renders.
## Starting a model
*Archify | New Model…* (right-click a folder, *File → New File…*, Command Palette) offers three complete examples: **C4 - Standard Web App**, **C4 - E-Shop** and **C4 - Event-Based Integration**. Pick one and a folder name; the example is copied into that folder with `model.id`, `model.name` and the overview title taken from the folder name (an example kept under its own name is copied as is). Each example has `registry/{people,systems,containers}.archify-registry` and diagrams under `0100-context`, `0200-containers` and `0300-components`; every registry element is used by at least one diagram and every diagram validates.
## Decisions
An architecture decision is one `*.archify-decision` file, anywhere under the model root (`decisions/` is the convention):
```yaml
schema_version: 1
decision:
id: queue-between-api-and-worker # unique in the model, any short string
title: A queue between the API and the worker
status: accepted # proposed | accepted | superseded | rejected
date: 2026-09-16
elements: [api, queue, worker] # registry ids
diagrams: [0200-containers/online-shop.archify]
supersedes: [] # ids of older decisions this one replaces
context: >
Why a decision was needed.
decision: >
What was decided.
consequences: >
What becomes easier, harder, or must change.
```
Ids are strings; an unquoted number such as `0001` is refused because YAML reads it as 1. A decision another decision supersedes shows as superseded whatever its own status says. Unknown elements, missing diagrams, duplicate ids, unknown statuses and dangling `supersedes` are problems on the decision file.
Diagrams point back at decisions with a `decisions` list of ids on the diagram itself, on a component (or node, participant, state) and on a connection (or edge, flow, transition, message):
```yaml
decisions: [postgres-as-source-of-truth]
components:
- ref: queue
pos: [460, 360]
size: [130, 60]
decisions: [queue-between-api-and-worker]
connections:
- { from: api, to: queue, label: enqueue, decisions: [queue-between-api-and-worker] }
```
The key is stripped before Archify renders. An unknown id is a problem at its line; outside a model the key is an error, like `ref`. The `main.archify` page lists all decisions; a diagram page lists the ones it points at or that name it; an element's card and dialog list the decisions about it. A `.archify-decision` file opens as its own page. Outside a model it still opens, with a note that it has lost its model.
## The model graph
The **Model | Graph** switch on the `main.archify` page replaces it with the whole model as one graph. It is built from the model index, not from Archify's renderer:
- **Nodes** are every element any diagram draws (`components`, `nodes`, `participants`, `states`), joined by id across diagrams, plus every registry element even when no diagram draws it yet. Registry elements carry their description, file and line; inline elements only what the diagram says. The same inline id in two diagrams is one node.
- **Edges** are every `connections`, `edges`, `flows`, `transitions` and `messages` entry between two nodes of the same diagram, keyed by `from>to`; the labels different diagrams give the same pair are joined with " / ". Direction is kept.
- **Decisions** reach nodes through `elements:` in the decision file and through `decisions:` on a node in a diagram; they reach edges through `decisions:` on a connection.
- **Decision nodes** (`decision:<id>`, type `decision`) carry the effective status, the context and decision text, and the diagrams the decision names; `decides` edges point at the elements it is about, `supersedes` edges at the decisions it replaces.
- **Registry nodes** (`registry:<file>`, type `registry`) stand for each `.archify-registry` file; `defines` edges point at its elements.
Walks (`uses:`, `near:`, `from: to:`) follow `connection` edges only. Decision and registry nodes join a result when an element they link to matches, and `-type:decision` or `-type:registry` removes them.
Queries run in the page against that graph; the forms are listed under **?** on the page and in the README. `uses:` and `near:` ignore direction; `from: to:` follows the arrows first and ignores them only when no directed path exists. Connections are shown when both ends match, so `type:backend` shows backend-to-backend connections only.
The switch is remembered per `main.archify` in the workspace. The graph page updates in place when a file of the model changes: elements that are still there keep their position, new ones are laid out around them.
+30
View File
@@ -18,6 +18,17 @@ const common = {
mainFields: ['module', 'main'], mainFields: ['module', 'main'],
}; };
// codemirror-json-schema formats schema descriptions with markdown-it and
// shiki (about 400 KB); a small stub does what our descriptions need.
const stubMarkdown = {
name: 'stub-markdown',
setup(build) {
build.onResolve({ filter: /utils\/markdown(\.js)?$/ }, (args) =>
args.importer.includes('codemirror-json-schema') ? { path: path.resolve('src/webview/source/markdownStub.ts') } : undefined,
);
},
};
if (tests) { if (tests) {
// Unit tests cover the modules that do not import 'vscode'; the // Unit tests cover the modules that do not import 'vscode'; the
// integration suite runs inside VS Code, which provides it. // integration suite runs inside VS Code, which provides it.
@@ -49,6 +60,25 @@ if (tests) {
entryPoints: ['src/viewer3d/index.ts'], entryPoints: ['src/viewer3d/index.ts'],
outfile: 'dist/viewer3d.js', outfile: 'dist/viewer3d.js',
}), }),
// The Graph page of a model; Cytoscape.js is bundled in.
esbuild.context({
...common,
format: 'iife',
platform: 'browser',
target: 'es2022',
entryPoints: ['src/graph/index.ts'],
outfile: 'dist/graph.js',
}),
// The Source view; CodeMirror is bundled in. Loaded the first time Source is chosen.
esbuild.context({
...common,
format: 'iife',
platform: 'browser',
target: 'es2022',
entryPoints: ['src/webview/source/index.ts'],
outfile: 'dist/source.js',
plugins: [stubMarkdown],
}),
]); ]);
if (watch) { if (watch) {
await Promise.all(contexts.map((ctx) => ctx.watch())); await Promise.all(contexts.map((ctx) => ctx.watch()));
@@ -0,0 +1,26 @@
schema_version: 1
diagram_type: architecture
meta:
title: System context
output: context.html
components:
- ref: customer
pos: [40, 60]
size: [130, 60]
- ref: support
pos: [40, 260]
size: [130, 60]
- ref: shop
pos: [280, 160]
size: [150, 60]
- ref: psp
pos: [520, 60]
size: [150, 60]
- ref: email
pos: [520, 260]
size: [150, 60]
connections:
- { from: customer, to: shop, label: buys, variant: emphasis }
- { from: support, to: shop, label: manages orders }
- { from: shop, to: psp, label: charges, variant: security }
- { from: shop, to: email, label: sends mail }
@@ -0,0 +1,41 @@
schema_version: 1
diagram_type: architecture
meta:
title: Containers
output: containers.html
decisions: [postgres-as-source-of-truth]
components:
- ref: customer
pos: [40, 160]
size: [130, 60]
- ref: web
pos: [250, 160]
size: [130, 60]
- ref: api
pos: [460, 160]
size: [130, 60]
- ref: cache
pos: [670, 60]
size: [130, 60]
- ref: db
pos: [670, 260]
size: [130, 60]
- ref: queue
pos: [460, 360]
size: [130, 60]
decisions: [queue-between-api-and-worker]
- ref: worker
pos: [670, 460]
size: [130, 60]
boundaries:
- kind: region
label: Online Shop
wraps: [web, api, cache, db, queue, worker]
connections:
- { from: customer, to: web, label: HTTPS, variant: emphasis }
- { from: web, to: api, label: JSON }
- { from: api, to: cache, label: read }
- { from: api, to: db, label: SQL }
- { from: api, to: queue, label: enqueue, labelAt: [560, 290], decisions: [queue-between-api-and-worker] }
- { from: queue, to: worker, label: poll }
- { from: worker, to: db, label: SQL, labelAt: [735, 420] }
@@ -0,0 +1,42 @@
schema_version: 1
diagram_type: architecture
meta:
title: API components
output: api.html
components:
- ref: web
pos: [40, 160]
size: [130, 60]
- id: auth
type: security
label: Auth
sublabel: sessions, OIDC
pos: [250, 60]
size: [130, 60]
- id: orders
type: backend
label: Orders
pos: [250, 160]
size: [130, 60]
- id: catalogue
type: backend
label: Catalogue
pos: [250, 260]
size: [130, 60]
- ref: db
pos: [460, 160]
size: [130, 60]
- ref: queue
pos: [460, 310]
size: [130, 60]
boundaries:
- kind: region
label: API
wraps: [auth, orders, catalogue]
connections:
- { from: web, to: auth, label: sign in, variant: security }
- { from: web, to: orders, label: place order }
- { from: web, to: catalogue, label: browse }
- { from: orders, to: db, label: SQL }
- { from: catalogue, to: db, label: SQL }
- { from: orders, to: queue, label: enqueue }
@@ -0,0 +1,20 @@
schema_version: 1
decision:
id: postgres-as-source-of-truth
title: PostgreSQL as the single source of truth
status: accepted
date: 2026-09-02
elements: [db, api, worker]
diagrams: [0200-containers/online-shop.archify]
context: >
Orders, customers and the catalogue were spread over the
shop database and two spreadsheets kept by support.
Refunds were reconciled by hand every Monday.
decision: >
One PostgreSQL database owns orders, customers and the
catalogue. The API is the only writer. Everything else
(cache, search, reports) is derived and may be rebuilt.
consequences: >
Support loses the spreadsheets and gets the admin console.
Any new store must be declared derived or get its own
decision. Backups and migrations are the API team's job.
@@ -0,0 +1,20 @@
schema_version: 1
decision:
id: queue-between-api-and-worker
title: A queue between the API and the worker
status: accepted
date: 2026-09-16
elements: [api, queue, worker]
diagrams: [0200-containers/online-shop.archify]
context: >
Order confirmation emails and invoices were sent inside
the checkout request. A slow mail provider made checkout
slow; a failing one made checkout fail.
decision: >
The API enqueues a job per side effect on SQS. One worker
service consumes the queue and does the slow work.
Checkout returns as soon as the order is stored.
consequences: >
Emails arrive seconds later, not instantly. Jobs must be
idempotent because SQS delivers at least once. The worker
is the second place that writes to the database.
@@ -0,0 +1,20 @@
schema_version: 1
decision:
id: opensearch-for-product-search
title: OpenSearch for product search
status: proposed
date: 2026-10-19
elements: [api, worker, db]
diagrams: [0200-containers/online-shop.archify]
context: >
Catalogue search runs as SQL LIKE queries on the
database. Typos find nothing and the catalogue page is
the slowest page in the shop.
decision: >
Add a dedicated search service on OpenSearch. The API
queries it; the worker rebuilds the index from the
database after every catalogue change.
consequences: >
The index is derived data under decision 0001 and may be
rebuilt at any time. One more service to run. Search
results can lag the database by the rebuild interval.
+24
View File
@@ -0,0 +1,24 @@
schema_version: 1
model:
id: online-shop
name: Online Shop
description: >
The web shop, its API and workers, and the stores behind them.
Context, containers and components, C4 style.
diagram_type: architecture
meta:
title: Online Shop — overview
output: main.html
components:
- ref: customer
pos: [40, 160]
size: [130, 60]
- ref: shop
pos: [250, 160]
size: [150, 60]
- ref: psp
pos: [480, 160]
size: [150, 60]
connections:
- { from: customer, to: shop, label: buys, variant: emphasis }
- { from: shop, to: psp, label: charges }
@@ -0,0 +1,37 @@
schema_version: 1
elements:
web:
type: frontend
label: Web App
sublabel: React
brand: react
description: The shop as customers see it; talks only to the API.
api:
type: backend
label: API
sublabel: Node.js
brand: node-js
description: Owns authentication, orders and the catalogue.
diagram: 0300-components/api.archify
worker:
type: backend
label: Worker
sublabel: async jobs
description: Picks jobs from the queue; emails, invoices, exports.
queue:
type: messagebus
label: Queue
sublabel: SQS
description: Job queue between the API and the workers.
db:
type: database
label: Database
sublabel: PostgreSQL
brand: postgresql
description: Orders, customers and catalogue; the source of truth.
cache:
type: database
label: Cache
sublabel: Redis
brand: redis
description: Sessions and catalogue cache; nothing here is the source of truth.
@@ -0,0 +1,12 @@
schema_version: 1
elements:
customer:
type: external
label: Customer
sublabel: web and mobile
description: Buys products; signs in with email or a social account.
support:
type: external
label: Support agent
sublabel: back office
description: Handles refunds and order problems in the admin console.
@@ -0,0 +1,19 @@
schema_version: 1
elements:
shop:
type: cloud
label: Online Shop
sublabel: the system
description: Everything we build and run; web app, API, workers and stores.
diagram: 0200-containers/online-shop.archify
psp:
type: external
label: Payment provider
sublabel: Stripe
brand: stripe
description: Charges cards and pays out; we never see card numbers.
email:
type: external
label: Email service
sublabel: transactional mail
description: Sends order confirmations and password resets.
+1034 -22
View File
File diff suppressed because it is too large. Load diff
+156 -17
View File
@@ -2,9 +2,12 @@
"name": "archify-vscode-ext", "name": "archify-vscode-ext",
"displayName": "Archify Diagram Viewer", "displayName": "Archify Diagram Viewer",
"description": "Archify diagrams in VS Code. Write diagrams as .archify files in YAML: they open as the interactive diagram, with live updates, validation, templates and completion. Also previews Archify's own JSON files (*.architecture.json, …) and opens rendered Archify HTML.", "description": "Archify diagrams in VS Code. Write diagrams as .archify files in YAML: they open as the interactive diagram, with live updates, validation, templates and completion. Also previews Archify's own JSON files (*.architecture.json, …) and opens rendered Archify HTML.",
"version": "0.6.1", "version": "0.9.2",
"publisher": "root-at-skic", "publisher": "root-at-skic",
"license": "MIT", "license": "MIT",
"sponsor": {
"url": "https://buymeacoffee.com/root.at.skic"
},
"icon": "media/icon.png", "icon": "media/icon.png",
"galleryBanner": { "galleryBanner": {
"color": "#0f172a", "color": "#0f172a",
@@ -23,11 +26,16 @@
], ],
"keywords": [ "keywords": [
"archify", "archify",
"yaml",
"diagram",
"architecture", "architecture",
"c4",
"diagram",
"model",
"registry",
"sequence", "sequence",
"workflow" "workflow",
"yaml",
"adr",
"decisions"
], ],
"main": "./dist/extension.js", "main": "./dist/extension.js",
"activationEvents": [ "activationEvents": [
@@ -35,15 +43,32 @@
"onLanguage:jsonc", "onLanguage:jsonc",
"onLanguage:html", "onLanguage:html",
"workspaceContains:**/*.{archify,architecture.json,workflow.json,sequence.json,dataflow.json,lifecycle.json}", "workspaceContains:**/*.{archify,architecture.json,workflow.json,sequence.json,dataflow.json,lifecycle.json}",
"onWebviewPanel:archify.preview" "onWebviewPanel:archify.preview",
"workspaceContains:**/*.archify-registry",
"workspaceContains:**/*.archify-decision"
], ],
"contributes": { "contributes": {
"commands": [ "commands": [
{
"command": "archify.newModel",
"title": "Archify | New Model…",
"icon": "$(new-folder)"
},
{
"command": "archify.newRegistry",
"title": "Archify | New Registry…",
"icon": "$(symbol-field)"
},
{ {
"command": "archify.newDiagram", "command": "archify.newDiagram",
"title": "Archify | New Diagram…", "title": "Archify | New Diagram…",
"icon": "$(new-file)" "icon": "$(new-file)"
}, },
{
"command": "archify.newDecision",
"title": "Archify | New Decision…",
"icon": "$(law)"
},
{ {
"command": "archify.showPreview", "command": "archify.showPreview",
"title": "Archify | Open Preview", "title": "Archify | Open Preview",
@@ -77,7 +102,22 @@
{ {
"command": "archify.showSource", "command": "archify.showSource",
"title": "Archify | Show Source", "title": "Archify | Show Source",
"icon": "$(code)"
},
{
"command": "archify.openInTextEditor",
"title": "Archify | Open in Text Editor",
"icon": "$(go-to-file)" "icon": "$(go-to-file)"
},
{
"command": "archify.openModel",
"title": "Archify | Open Model",
"icon": "$(symbol-structure)"
},
{
"command": "archify.openModelGraph",
"title": "Archify | Open Model Graph",
"icon": "$(type-hierarchy)"
} }
], ],
"menus": { "menus": {
@@ -108,7 +148,19 @@
}, },
{ {
"command": "archify.showSource", "command": "archify.showSource",
"when": "archifyPreviewFocus || activeCustomEditorId == 'archify.htmlViewer' || activeCustomEditorId == 'archify.diagram'" "when": "archifyPreviewFocus || activeCustomEditorId == 'archify.htmlViewer' || activeCustomEditorId == 'archify.diagram' || activeCustomEditorId == 'archify.registry' || activeCustomEditorId == 'archify.decision'"
},
{
"command": "archify.openInTextEditor",
"when": "archifyPreviewFocus || activeCustomEditorId == 'archify.htmlViewer' || activeCustomEditorId == 'archify.diagram' || activeCustomEditorId == 'archify.registry' || activeCustomEditorId == 'archify.decision'"
},
{
"command": "archify.openModel",
"when": "archify.isDiagramSource || archifyPreviewFocus || activeCustomEditorId == 'archify.diagram' || activeCustomEditorId == 'archify.registry' || activeCustomEditorId == 'archify.decision'"
},
{
"command": "archify.openModelGraph",
"when": "archify.isDiagramSource || archifyPreviewFocus || activeCustomEditorId == 'archify.diagram' || activeCustomEditorId == 'archify.registry' || activeCustomEditorId == 'archify.decision'"
} }
], ],
"editor/title": [ "editor/title": [
@@ -128,8 +180,8 @@
"group": "navigation" "group": "navigation"
}, },
{ {
"command": "archify.showSource", "command": "archify.openInTextEditor",
"when": "archifyPreviewFocus || activeCustomEditorId == 'archify.htmlViewer' || activeCustomEditorId == 'archify.diagram'", "when": "archifyPreviewFocus || activeCustomEditorId == 'archify.htmlViewer' || activeCustomEditorId == 'archify.diagram' || activeCustomEditorId == 'archify.registry' || activeCustomEditorId == 'archify.decision'",
"group": "navigation" "group": "navigation"
}, },
{ {
@@ -141,28 +193,63 @@
"command": "archify.renderToHtml", "command": "archify.renderToHtml",
"when": "archify.isDiagramSource || archifyPreviewFocus", "when": "archify.isDiagramSource || archifyPreviewFocus",
"group": "1_archify" "group": "1_archify"
},
{
"command": "archify.openModel",
"when": "archify.inModel && (archify.isDiagramSource || activeCustomEditorId == 'archify.diagram' || activeCustomEditorId == 'archify.registry' || activeCustomEditorId == 'archify.decision') && !notebookEditorFocused",
"group": "navigation@60"
},
{
"command": "archify.openModelGraph",
"when": "archify.inModel && (archify.isDiagramSource || activeCustomEditorId == 'archify.diagram' || activeCustomEditorId == 'archify.registry' || activeCustomEditorId == 'archify.decision') && !notebookEditorFocused",
"group": "navigation@61"
} }
], ],
"explorer/context": [ "explorer/context": [
{ {
"command": "archify.newDiagram", "command": "archify.newModel",
"when": "explorerResourceIsFolder", "when": "explorerResourceIsFolder",
"group": "zzz_archify@1" "group": "zzz_archify@1"
}, },
{ {
"command": "archify.showPreview", "command": "archify.newRegistry",
"when": "resourceFilename =~ /(\\.archify|\\.(architecture|workflow|sequence|dataflow|lifecycle)\\.json)$/", "when": "explorerResourceIsFolder",
"group": "zzz_archify@2" "group": "zzz_archify@2"
}, },
{ {
"command": "archify.renderToHtml", "command": "archify.newDiagram",
"when": "resourceFilename =~ /(\\.archify|\\.(architecture|workflow|sequence|dataflow|lifecycle)\\.json)$/", "when": "explorerResourceIsFolder",
"group": "zzz_archify@3" "group": "zzz_archify@3"
}, },
{
"command": "archify.newDecision",
"when": "explorerResourceIsFolder",
"group": "zzz_archify@4"
},
{
"command": "archify.showPreview",
"when": "resourceFilename =~ /(\\.archify|\\.archify-registry|\\.archify-decision|\\.(architecture|workflow|sequence|dataflow|lifecycle)\\.json)$/",
"group": "zzz_archify@5"
},
{ {
"command": "archify.openHtmlViewer", "command": "archify.openHtmlViewer",
"when": "resourceExtname == .html", "when": "resourceExtname == .html",
"group": "zzz_archify@2" "group": "zzz_archify@6"
},
{
"command": "archify.renderToHtml",
"when": "resourceFilename =~ /(\\.archify|\\.(architecture|workflow|sequence|dataflow|lifecycle)\\.json)$/",
"group": "zzz_archify@7"
},
{
"command": "archify.openModel",
"when": "resourceFilename =~ /\\.archify(-registry|-decision)?$/",
"group": "zzz_archify@8"
},
{
"command": "archify.openModelGraph",
"when": "resourceFilename =~ /\\.archify(-registry|-decision)?$/",
"group": "zzz_archify@9"
} }
], ],
"editor/title/context": [ "editor/title/context": [
@@ -173,9 +260,21 @@
} }
], ],
"file/newFile": [ "file/newFile": [
{
"command": "archify.newModel",
"group": "file@1"
},
{
"command": "archify.newRegistry",
"group": "file@2"
},
{ {
"command": "archify.newDiagram", "command": "archify.newDiagram",
"group": "file" "group": "file@3"
},
{
"command": "archify.newDecision",
"group": "file@4"
} }
] ]
}, },
@@ -204,6 +303,26 @@
], ],
"priority": "default" "priority": "default"
}, },
{
"viewType": "archify.registry",
"displayName": "Archify Registry",
"selector": [
{
"filenamePattern": "*.archify-registry"
}
],
"priority": "default"
},
{
"viewType": "archify.decision",
"displayName": "Archify Decision",
"selector": [
{
"filenamePattern": "*.archify-decision"
}
],
"priority": "default"
},
{ {
"viewType": "archify.htmlViewer", "viewType": "archify.htmlViewer",
"displayName": "Archify HTML Viewer", "displayName": "Archify HTML Viewer",
@@ -330,7 +449,9 @@
{ {
"id": "yaml", "id": "yaml",
"extensions": [ "extensions": [
".archify" ".archify",
".archify-registry",
".archify-decision"
] ]
} }
], ],
@@ -338,6 +459,10 @@
{ {
"fileMatch": "*.archify", "fileMatch": "*.archify",
"url": "./schemas/archify.schema.json" "url": "./schemas/archify.schema.json"
},
{
"fileMatch": "*.archify-registry",
"url": "./schemas/archify-registry.schema.json"
} }
] ]
}, },
@@ -352,12 +477,13 @@
"test:integration": "node esbuild.mjs && node esbuild.mjs --tests && node test/integration/run.mjs" "test:integration": "node esbuild.mjs && node esbuild.mjs --tests && node test/integration/run.mjs"
}, },
"devDependencies": { "devDependencies": {
"@types/cytoscape": "^3.21.9",
"@types/cytoscape-fcose": "^2.2.5",
"@types/node": "^22.0.0", "@types/node": "^22.0.0",
"@types/three": "^0.186.0", "@types/three": "^0.186.0",
"@types/vscode": "~1.100.0", "@types/vscode": "~1.100.0",
"@vscode/test-electron": "^3.1.0", "@vscode/test-electron": "^3.1.0",
"@vscode/vsce": "^3.0.0", "@vscode/vsce": "^3.0.0",
"ajv": "^8.20.0",
"esbuild": "^0.25.0", "esbuild": "^0.25.0",
"jsonc-parser": "^3.3.1", "jsonc-parser": "^3.3.1",
"typescript": "^5.8.0" "typescript": "^5.8.0"
@@ -367,6 +493,19 @@
}, },
"homepage": "https://gitea.lego-cloud.eu/vscode-extensions/archify-vscode-ext#readme", "homepage": "https://gitea.lego-cloud.eu/vscode-extensions/archify-vscode-ext#readme",
"dependencies": { "dependencies": {
"@codemirror/autocomplete": "^6.20.4",
"@codemirror/commands": "^6.11.1",
"@codemirror/lang-yaml": "^6.1.3",
"@codemirror/language": "^6.13.1",
"@codemirror/lint": "^6.9.7",
"@codemirror/state": "^6.7.6",
"@codemirror/view": "^6.43.15",
"@lezer/highlight": "^1.2.5",
"ajv": "^8.20.0",
"codemirror": "^6.0.2",
"codemirror-json-schema": "^0.8.1",
"cytoscape": "^3.34.4",
"cytoscape-fcose": "^2.2.0",
"three": "^0.186.1", "three": "^0.186.1",
"yaml": "^2.9.1" "yaml": "^2.9.1"
} }
+27
View File
@@ -0,0 +1,27 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Archify architecture decision",
"description": "One architecture decision of a model. Diagrams point at it with `decisions: [<id>]`.",
"type": "object",
"additionalProperties": false,
"required": [
"decision"
],
"properties": {
"schema_version": {
"const": 1
},
"decision": {
"type": "string",
"description": "What was decided."
},
"context": {
"type": "string",
"description": "The situation and what forced a decision."
},
"consequences": {
"type": "string",
"description": "What becomes easier, harder, or must change."
}
}
}
+156
View File
@@ -0,0 +1,156 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Archify model registry",
"description": "Shared elements of a model: one name for one thing. Diagrams refer to an element with `ref: <id>`.",
"type": "object",
"additionalProperties": false,
"required": [
"elements"
],
"properties": {
"schema_version": {
"const": 1
},
"elements": {
"type": "object",
"description": "Element id → element. Ids are unique across all registry files of the model.",
"propertyNames": {
"pattern": "^[a-zA-Z][a-zA-Z0-9_-]*$"
},
"additionalProperties": {
"type": "object",
"additionalProperties": false,
"required": [
"type",
"label"
],
"properties": {
"type": {
"enum": [
"frontend",
"backend",
"database",
"cloud",
"security",
"messagebus",
"external"
]
},
"label": {
"type": "string",
"minLength": 1
},
"sublabel": {
"type": "string"
},
"tag": {
"type": "string"
},
"icon": {
"description": "Decorative corner icon. Omit the icon field for the type default; none hides it. Does not change type, color, or legend grouping.",
"enum": [
"calendar",
"clock",
"person",
"briefcase",
"flag",
"moon",
"frontend",
"backend",
"database",
"cloud",
"security",
"messagebus",
"external",
"start",
"active",
"waiting",
"success",
"failure",
"neutral",
"none"
]
},
"brand": {
"oneOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 2048,
"anyOf": [
{
"maxLength": 80,
"pattern": "^[^\\r\\n]+$"
},
{
"pattern": "^https?://"
}
]
},
{
"type": "object",
"additionalProperties": false,
"required": [
"url",
"sha256"
],
"properties": {
"url": {
"type": "string",
"minLength": 8,
"maxLength": 2048,
"pattern": "^https?://"
},
"sha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
}
}
}
]
},
"sources": {
"type": "array",
"minItems": 1,
"maxItems": 3,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"path"
],
"properties": {
"path": {
"type": "string",
"minLength": 1,
"maxLength": 240
},
"line": {
"type": "integer",
"minimum": 1
},
"end_line": {
"type": "integer",
"minimum": 1
},
"label": {
"type": "string",
"minLength": 1,
"maxLength": 48
}
}
}
},
"description": {
"type": "string",
"description": "The one description of this thing; shown on hover and on the model page."
},
"diagram": {
"type": "string",
"description": "Diagram that explains this element, relative to the model root (main.archify). Double-click the node to open it."
}
}
}
}
}
}
+72 -5
View File
@@ -158,11 +158,6 @@
"items": { "items": {
"type": "object", "type": "object",
"additionalProperties": false, "additionalProperties": false,
"required": [
"id",
"type",
"label"
],
"properties": { "properties": {
"id": { "id": {
"$ref": "common.schema.json#/$defs/id" "$ref": "common.schema.json#/$defs/id"
@@ -215,8 +210,39 @@
"items": false, "items": false,
"minItems": 2, "minItems": 2,
"maxItems": 2 "maxItems": 2
},
"ref": {
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9_-]*$",
"description": "A shared element from the model’s registry (*.archify-registry). Its type, label, sublabel, brand and sources come from there; the diagram adds pos/size and may override label, sublabel and tag."
},
"diagram": {
"type": "string",
"description": "Diagram that explains this element, relative to the model root (main.archify). Double-click the node to open it."
},
"decisions": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"description": "Ids of architecture decisions (*.archify-decision files of the model) this is about. Shown in the Decisions panel under the diagram."
} }
},
"anyOf": [
{
"required": [
"ref"
]
},
{
"required": [
"id",
"type",
"label"
]
} }
]
} }
}, },
"boundaries": { "boundaries": {
@@ -314,12 +340,53 @@
}, },
"width": { "width": {
"$ref": "common.schema.json#/$defs/relationshipWidth" "$ref": "common.schema.json#/$defs/relationshipWidth"
},
"decisions": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"description": "Ids of architecture decisions (*.archify-decision files of the model) this is about. Shown in the Decisions panel under the diagram."
} }
} }
} }
}, },
"cards": { "cards": {
"$ref": "common.schema.json#/$defs/cards" "$ref": "common.schema.json#/$defs/cards"
},
"model": {
"type": "object",
"description": "Only in main.archify: the entry point of a model (a folder of diagrams that belong together).",
"additionalProperties": false,
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9_-]*$",
"description": "Stable id of the model."
},
"name": {
"type": "string",
"minLength": 1,
"description": "Name shown on the model page."
},
"description": {
"type": "string",
"description": "What the model covers; shown on the model page."
}
}
},
"decisions": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"description": "Ids of architecture decisions (*.archify-decision files of the model) this is about. Shown in the Decisions panel under the diagram."
} }
} }
} }
+49
View File
@@ -180,6 +180,14 @@
}, },
"yOffset": { "yOffset": {
"type": "number" "type": "number"
},
"decisions": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"description": "Ids of architecture decisions (*.archify-decision files of the model) this is about. Shown in the Decisions panel under the diagram."
} }
} }
} }
@@ -256,12 +264,53 @@
}, },
"width": { "width": {
"$ref": "common.schema.json#/$defs/relationshipWidth" "$ref": "common.schema.json#/$defs/relationshipWidth"
},
"decisions": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"description": "Ids of architecture decisions (*.archify-decision files of the model) this is about. Shown in the Decisions panel under the diagram."
} }
} }
} }
}, },
"cards": { "cards": {
"$ref": "common.schema.json#/$defs/cards" "$ref": "common.schema.json#/$defs/cards"
},
"model": {
"type": "object",
"description": "Only in main.archify: the entry point of a model (a folder of diagrams that belong together).",
"additionalProperties": false,
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9_-]*$",
"description": "Stable id of the model."
},
"name": {
"type": "string",
"minLength": 1,
"description": "Name shown on the model page."
},
"description": {
"type": "string",
"description": "What the model covers; shown on the model page."
}
}
},
"decisions": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"description": "Ids of architecture decisions (*.archify-decision files of the model) this is about. Shown in the Decisions panel under the diagram."
} }
} }
} }
+49
View File
@@ -208,6 +208,14 @@
}, },
"yOffset": { "yOffset": {
"type": "number" "type": "number"
},
"decisions": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"description": "Ids of architecture decisions (*.archify-decision files of the model) this is about. Shown in the Decisions panel under the diagram."
} }
} }
} }
@@ -288,12 +296,53 @@
}, },
"width": { "width": {
"$ref": "common.schema.json#/$defs/relationshipWidth" "$ref": "common.schema.json#/$defs/relationshipWidth"
},
"decisions": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"description": "Ids of architecture decisions (*.archify-decision files of the model) this is about. Shown in the Decisions panel under the diagram."
} }
} }
} }
}, },
"cards": { "cards": {
"$ref": "common.schema.json#/$defs/cards" "$ref": "common.schema.json#/$defs/cards"
},
"model": {
"type": "object",
"description": "Only in main.archify: the entry point of a model (a folder of diagrams that belong together).",
"additionalProperties": false,
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9_-]*$",
"description": "Stable id of the model."
},
"name": {
"type": "string",
"minLength": 1,
"description": "Name shown on the model page."
},
"description": {
"type": "string",
"description": "What the model covers; shown on the model page."
}
}
},
"decisions": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"description": "Ids of architecture decisions (*.archify-decision files of the model) this is about. Shown in the Decisions panel under the diagram."
} }
} }
} }
+49
View File
@@ -144,6 +144,14 @@
}, },
"sources": { "sources": {
"$ref": "common.schema.json#/$defs/sourceReferences" "$ref": "common.schema.json#/$defs/sourceReferences"
},
"decisions": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"description": "Ids of architecture decisions (*.archify-decision files of the model) this is about. Shown in the Decisions panel under the diagram."
} }
} }
} }
@@ -213,6 +221,14 @@
}, },
"note": { "note": {
"type": "string" "type": "string"
},
"decisions": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"description": "Ids of architecture decisions (*.archify-decision files of the model) this is about. Shown in the Decisions panel under the diagram."
} }
} }
} }
@@ -245,6 +261,39 @@
}, },
"cards": { "cards": {
"$ref": "common.schema.json#/$defs/cards" "$ref": "common.schema.json#/$defs/cards"
},
"model": {
"type": "object",
"description": "Only in main.archify: the entry point of a model (a folder of diagrams that belong together).",
"additionalProperties": false,
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9_-]*$",
"description": "Stable id of the model."
},
"name": {
"type": "string",
"minLength": 1,
"description": "Name shown on the model page."
},
"description": {
"type": "string",
"description": "What the model covers; shown on the model page."
}
}
},
"decisions": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"description": "Ids of architecture decisions (*.archify-decision files of the model) this is about. Shown in the Decisions panel under the diagram."
} }
} }
} }
+49
View File
@@ -331,6 +331,14 @@
}, },
"yOffset": { "yOffset": {
"type": "number" "type": "number"
},
"decisions": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"description": "Ids of architecture decisions (*.archify-decision files of the model) this is about. Shown in the Decisions panel under the diagram."
} }
} }
} }
@@ -419,12 +427,53 @@
"width": { "width": {
"type": "number", "type": "number",
"minimum": 0.5 "minimum": 0.5
},
"decisions": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"description": "Ids of architecture decisions (*.archify-decision files of the model) this is about. Shown in the Decisions panel under the diagram."
} }
} }
} }
}, },
"cards": { "cards": {
"$ref": "common.schema.json#/$defs/cards" "$ref": "common.schema.json#/$defs/cards"
},
"model": {
"type": "object",
"description": "Only in main.archify: the entry point of a model (a folder of diagrams that belong together).",
"additionalProperties": false,
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[a-zA-Z][a-zA-Z0-9_-]*$",
"description": "Stable id of the model."
},
"name": {
"type": "string",
"minLength": 1,
"description": "Name shown on the model page."
},
"description": {
"type": "string",
"description": "What the model covers; shown on the model page."
}
}
},
"decisions": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"description": "Ids of architecture decisions (*.archify-decision files of the model) this is about. Shown in the Decisions panel under the diagram."
} }
}, },
"$defs": { "$defs": {
+117
View File
@@ -0,0 +1,117 @@
#!/usr/bin/env node
// Adds the model keys to the editor schemas in schemas/ (the CLI keeps the
// strict originals): `model` on main.archify, `ref` and `diagram` on
// architecture components, and a schema for *.archify-registry files.
// Run after sync-archify.mjs, or on its own after editing this file.
import fs from 'node:fs';
import path from 'node:path';
import { fileURLToPath } from 'node:url';
const root = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..');
const schemas = path.join(root, 'schemas');
const read = (file) => JSON.parse(fs.readFileSync(path.join(schemas, file), 'utf8'));
const write = (file, value) => fs.writeFileSync(path.join(schemas, file), `${JSON.stringify(value, null, 2)}\n`);
const MODEL = {
type: 'object',
description: 'Only in main.archify: the entry point of a model (a folder of diagrams that belong together).',
additionalProperties: false,
required: ['id', 'name'],
properties: {
id: { type: 'string', pattern: '^[a-zA-Z][a-zA-Z0-9_-]*$', description: 'Stable id of the model.' },
name: { type: 'string', minLength: 1, description: 'Name shown on the model page.' },
description: { type: 'string', description: 'What the model covers; shown on the model page.' },
},
};
const DIAGRAM_LINK = { type: 'string', description: 'Diagram that explains this element, relative to the model root (main.archify). Double-click the node to open it.' };
const DECISIONS = { type: 'array', items: { type: 'string', minLength: 1 }, description: 'Ids of architecture decisions (*.archify-decision files of the model) this is about. Shown in the Decisions panel under the diagram.' };
const NODE_COLLECTIONS = ['components', 'nodes', 'participants', 'states'];
const EDGE_COLLECTIONS = ['connections', 'edges', 'flows', 'transitions', 'messages'];
for (const file of fs.readdirSync(schemas)) {
if (!/^(architecture|workflow|sequence|dataflow|lifecycle)\.schema\.json$/.test(file)) continue;
const schema = read(file);
schema.properties.model = MODEL;
schema.properties.decisions = DECISIONS;
for (const key of [...NODE_COLLECTIONS, ...EDGE_COLLECTIONS]) {
const items = schema.properties[key]?.items;
if (items?.properties) items.properties.decisions = DECISIONS;
}
if (file === 'architecture.schema.json') {
const item = schema.properties.components.items;
item.properties.ref = { type: 'string', pattern: '^[a-zA-Z][a-zA-Z0-9_-]*$', description: 'A shared element from the model’s registry (*.archify-registry). Its type, label, sublabel, brand and sources come from there; the diagram adds pos/size and may override label, sublabel and tag.' };
item.properties.diagram = DIAGRAM_LINK;
// A ref brings type and label with it; an inline component must state them.
item.anyOf = [{ required: ['ref'] }, { required: ['id', 'type', 'label'] }];
delete item.required;
}
write(file, schema);
}
const common = read('common.schema.json');
const componentType = common.$defs.componentType;
const registry = {
$schema: 'https://json-schema.org/draft/2020-12/schema',
title: 'Archify model registry',
description: 'Shared elements of a model: one name for one thing. Diagrams refer to an element with `ref: <id>`.',
type: 'object',
additionalProperties: false,
required: ['elements'],
properties: {
schema_version: { const: 1 },
elements: {
type: 'object',
description: 'Element id → element. Ids are unique across all registry files of the model.',
propertyNames: { pattern: '^[a-zA-Z][a-zA-Z0-9_-]*$' },
additionalProperties: {
type: 'object',
additionalProperties: false,
required: ['type', 'label'],
properties: {
type: componentType,
label: { type: 'string', minLength: 1 },
sublabel: { type: 'string' },
tag: { type: 'string' },
icon: common.$defs.nodeIcon,
brand: common.$defs.brandMark,
sources: common.$defs.sourceReferences,
description: { type: 'string', description: 'The one description of this thing; shown on hover and on the model page.' },
diagram: DIAGRAM_LINK,
},
},
},
},
};
write('archify-registry.schema.json', registry);
const decision = {
$schema: 'https://json-schema.org/draft/2020-12/schema',
title: 'Archify architecture decision',
description: 'One architecture decision of a model. Diagrams point at it with `decisions: [<id>]`.',
type: 'object',
additionalProperties: false,
required: ['decision'],
properties: {
schema_version: { const: 1 },
decision: {
type: 'object',
additionalProperties: false,
required: ['id', 'title'],
properties: {
id: { type: 'string', minLength: 1, description: 'Unique in the model. Any short string.' },
title: { type: 'string', minLength: 1 },
status: { enum: ['proposed', 'accepted', 'superseded', 'rejected'], description: 'A decision another one supersedes shows as superseded whatever this says.' },
date: { type: 'string', description: 'YYYY-MM-DD.' },
elements: { type: 'array', items: { type: 'string', minLength: 1 }, description: 'Registry element ids the decision is about.' },
diagrams: { type: 'array', items: { type: 'string', minLength: 1 }, description: 'Diagram paths (from the model root) the decision names.' },
supersedes: { type: 'array', items: { type: 'string', minLength: 1 }, description: 'Ids of older decisions this one replaces.' },
},
},
context: { type: 'string', description: 'The situation and what forced a decision.' },
decision: { type: 'string', description: 'What was decided.' },
consequences: { type: 'string', description: 'What becomes easier, harder, or must change.' },
},
};
write('archify-decision.schema.json', decision);
console.log('Patched editor schemas: model, ref, diagram, decisions; wrote archify-registry.schema.json and archify-decision.schema.json');
+1
View File
@@ -92,3 +92,4 @@ fs.writeFileSync(
`${JSON.stringify({ upstream: 'https://github.com/tt-a1i/archify', version, revision }, null, 2)}\n`, `${JSON.stringify({ upstream: 'https://github.com/tt-a1i/archify', version, revision }, null, 2)}\n`,
); );
console.log(`Synced archify ${version} (${revision.slice(0, 12)}) from ${source}`); console.log(`Synced archify ${version} (${revision.slice(0, 12)}) from ${source}`);
await import('./patch-schemas.mjs');
+7 -1
View File
@@ -1,12 +1,18 @@
import * as vscode from 'vscode'; import * as vscode from 'vscode';
import { HTML_VIEW_TYPE, HtmlViewerProvider } from '../views/htmlViewer'; import { HTML_VIEW_TYPE, HtmlViewerProvider } from '../views/htmlViewer';
import { ModelService } from '../model/service';
import { DiagramViewManager } from '../views/diagramView'; import { DiagramViewManager } from '../views/diagramView';
import { RegistryViewProvider } from '../views/registryView';
import { DecisionViewProvider } from '../views/decisionView';
/** What command handlers share: the extension context and the open views. */ /** What command handlers share: the extension context and the open views. */
export interface CommandContext { export interface CommandContext {
extension: vscode.ExtensionContext; extension: vscode.ExtensionContext;
views: DiagramViewManager; views: DiagramViewManager;
htmlViewer: HtmlViewerProvider; htmlViewer: HtmlViewerProvider;
registry: RegistryViewProvider;
decision: DecisionViewProvider;
models: ModelService;
} }
export function isHtmlUri(uri: vscode.Uri): boolean { export function isHtmlUri(uri: vscode.Uri): boolean {
@@ -16,7 +22,7 @@ export function isHtmlUri(uri: vscode.Uri): boolean {
/** The file a command applies to: explicit argument, focused preview or viewer, then the text editor. */ /** The file a command applies to: explicit argument, focused preview or viewer, then the text editor. */
export function targetUri(ctx: CommandContext, arg?: unknown): vscode.Uri | undefined { export function targetUri(ctx: CommandContext, arg?: unknown): vscode.Uri | undefined {
if (arg instanceof vscode.Uri) return arg; if (arg instanceof vscode.Uri) return arg;
return ctx.views.activePreview?.uri ?? ctx.htmlViewer.activeUri ?? vscode.window.activeTextEditor?.document.uri; return ctx.views.activePreview?.uri ?? ctx.registry.activeUri ?? ctx.decision.activeUri ?? ctx.htmlViewer.activeUri ?? vscode.window.activeTextEditor?.document.uri;
} }
export function sourceUri(ctx: CommandContext, arg?: unknown): vscode.Uri | undefined { export function sourceUri(ctx: CommandContext, arg?: unknown): vscode.Uri | undefined {
+3 -1
View File
@@ -1,14 +1,16 @@
import * as vscode from 'vscode'; import * as vscode from 'vscode';
import { clearGitRootCache } from '../archify/runtime'; import { clearGitRootCache } from '../archify/runtime';
import { ModelService } from '../model/service';
import { isArchifyFile, isArchifyHtml, isDiagramFileName, readDiagramSource } from '../sources/detect'; import { isArchifyFile, isArchifyHtml, isDiagramFileName, readDiagramSource } from '../sources/detect';
const JSON_LANGUAGES = new Set(['json', 'jsonc']); const JSON_LANGUAGES = new Set(['json', 'jsonc']);
/** Keeps the archify.* context keys (editor title buttons, keybindings) up to date. */ /** Keeps the archify.* context keys (editor title buttons, keybindings) up to date. */
export function registerContextKeys(context: vscode.ExtensionContext): void { export function registerContextKeys(context: vscode.ExtensionContext, models: ModelService): void {
let contextTimer: NodeJS.Timeout | undefined; let contextTimer: NodeJS.Timeout | undefined;
const updateContext = () => { const updateContext = () => {
const doc = vscode.window.activeTextEditor?.document; const doc = vscode.window.activeTextEditor?.document;
if (doc) void models.rootOf(doc.uri).then((root) => vscode.commands.executeCommand('setContext', 'archify.inModel', Boolean(root)));
const diagram = Boolean( const diagram = Boolean(
doc && doc &&
(isArchifyFile(doc.fileName) || (isArchifyFile(doc.fileName) ||
+135
View File
@@ -0,0 +1,135 @@
import * as vscode from 'vscode';
import { MODEL_EXAMPLES, mainFromExample } from '../language/examples';
import { diagramName, invalidNameReason } from '../language/templates';
import { DECISION_EXT, slugify } from '../model/decisions';
import { MAIN_FILE, REGISTRY_EXT } from '../model/format';
import { REGISTRY_VIEW_TYPE } from '../views/registryView';
import { DECISION_VIEW_TYPE } from '../views/decisionView';
import { readText } from '../util/files';
import { DIAGRAM_EDITOR_VIEW_TYPE } from '../views/diagramView';
import { CommandContext, exists, targetUri } from './context';
/** Folder the new model folder goes into: the clicked folder (or a file's folder), else a workspace folder. */
async function parentFolder(arg?: unknown): Promise<vscode.Uri | undefined> {
if (arg instanceof vscode.Uri) {
const stat = await vscode.workspace.fs.stat(arg);
return stat.type & vscode.FileType.Directory ? arg : vscode.Uri.joinPath(arg, '..');
}
const folders = vscode.workspace.workspaceFolders ?? [];
if (folders.length <= 1) return folders[0]?.uri;
return (await vscode.window.showWorkspaceFolderPick({ placeHolder: 'Folder for the new model' }))?.uri;
}
export function modelCommands(ctx: CommandContext): vscode.Disposable[] {
return [
// Opens the model page (main.archify) of the model the current file is in.
vscode.commands.registerCommand('archify.openModel', async (arg?: unknown) => {
const uri = targetUri(ctx, arg);
const root = uri ? await ctx.models.rootOf(uri) : undefined;
if (!root) {
vscode.window.showInformationMessage(`Archify: this file is not inside a model (no ${MAIN_FILE} in a folder above it).`);
return;
}
await vscode.commands.executeCommand('vscode.openWith', vscode.Uri.joinPath(root, MAIN_FILE), DIAGRAM_EDITOR_VIEW_TYPE, vscode.ViewColumn.Active);
}),
// Opens the model's Graph page: every element and connection of the model in one picture, with a query box.
vscode.commands.registerCommand('archify.openModelGraph', async (arg?: unknown) => {
const uri = targetUri(ctx, arg);
const root = uri ? await ctx.models.rootOf(uri) : undefined;
if (!root) {
vscode.window.showInformationMessage(`Archify: this file is not inside a model (no ${MAIN_FILE} in a folder above it).`);
return;
}
await ctx.views.showGraph(root);
}),
// Creates a registry file in the clicked folder and opens it.
vscode.commands.registerCommand('archify.newRegistry', async (arg?: unknown) => {
const folder = await parentFolder(arg);
if (!folder) return;
const root = await ctx.models.rootOf(vscode.Uri.joinPath(folder, 'x'));
const name = await vscode.window.showInputBox({
title: 'Archify | New Registry',
prompt: `File name in ${vscode.workspace.asRelativePath(folder, true)}${root ? '' : ' (not inside a model: add a main.archify above it so diagrams can refer to its elements)'}`,
value: 'elements',
validateInput: async (value) =>
invalidNameReason(value) ?? ((await exists(vscode.Uri.joinPath(folder, `${diagramName(value).replace(/\.archify-registry$/i, '')}${REGISTRY_EXT}`))) ? `${diagramName(value)}${REGISTRY_EXT} already exists.` : undefined),
});
if (name === undefined) return;
const target = vscode.Uri.joinPath(folder, `${diagramName(name).replace(/\.archify-registry$/i, '')}${REGISTRY_EXT}`);
const template = await readText(vscode.Uri.joinPath(ctx.extension.extensionUri, 'templates', 'registry.archify-registry'));
await vscode.workspace.fs.writeFile(target, Buffer.from(template, 'utf8'));
await vscode.commands.executeCommand('vscode.openWith', target, REGISTRY_VIEW_TYPE);
}),
// Creates a decision file in the clicked folder of a model and opens it.
vscode.commands.registerCommand('archify.newDecision', async (arg?: unknown) => {
const folder = await parentFolder(arg);
if (!folder) return;
const root = await ctx.models.rootOf(vscode.Uri.joinPath(folder, 'x'));
if (!root) {
vscode.window.showWarningMessage(`Archify: ${vscode.workspace.asRelativePath(folder, true)} is not inside a model (no ${MAIN_FILE} in it or a folder above it). Decisions belong to a model.`);
return;
}
const index = await ctx.models.index(root);
const title = await vscode.window.showInputBox({
title: 'Archify | New Decision',
prompt: `Title of the decision (file goes into ${vscode.workspace.asRelativePath(folder, true)})`,
placeHolder: 'OpenSearch for product search',
validateInput: async (value) => {
if (!value.trim()) return 'Enter a title.';
const id = slugify(value);
if (index.decisions.decisions.has(id)) return `A decision with id "${id}" already exists in this model.`;
if (await exists(vscode.Uri.joinPath(folder, `${id}${DECISION_EXT}`))) return `${id}${DECISION_EXT} already exists.`;
return undefined;
},
});
if (title === undefined) return;
const id = slugify(title);
const target = vscode.Uri.joinPath(folder, `${id}${DECISION_EXT}`);
const template = await readText(vscode.Uri.joinPath(ctx.extension.extensionUri, 'templates', 'decision.archify-decision'));
const today = new Date().toISOString().slice(0, 10);
const text = template.replace('__ID__', id).replace('__TITLE__', JSON.stringify(title.trim())).replace('__DATE__', today);
await vscode.workspace.fs.writeFile(target, Buffer.from(text, 'utf8'));
await vscode.commands.executeCommand('vscode.openWith', target, DECISION_VIEW_TYPE);
}),
// Creates a new model folder from one of the shipped examples and opens its model page.
vscode.commands.registerCommand('archify.newModel', async (arg?: unknown) => {
const picked = await vscode.window.showQuickPick(
MODEL_EXAMPLES.map((example) => ({ label: example.label, description: example.description, example })),
{ title: 'Archify | New Model', placeHolder: 'Example to start from' },
);
if (!picked) return;
const { example } = picked;
let parent = await parentFolder(arg);
if (!parent) {
const chosen = await vscode.window.showOpenDialog({ title: 'Archify | New Model', canSelectFiles: false, canSelectFolders: true, openLabel: 'Create model here' });
parent = chosen?.[0];
if (!parent) return;
}
const name = await vscode.window.showInputBox({
title: 'Archify | New Model',
prompt: `Folder name in ${vscode.workspace.asRelativePath(parent, true)}`,
value: example.folder,
validateInput: async (value) =>
invalidNameReason(value) ?? ((await exists(vscode.Uri.joinPath(parent, diagramName(value)))) ? `${diagramName(value)} already exists.` : undefined),
});
if (name === undefined) return;
const folderName = diagramName(name);
const target = vscode.Uri.joinPath(parent, folderName);
if (await exists(target)) {
vscode.window.showWarningMessage(`Archify: ${vscode.workspace.asRelativePath(target, true)} already exists.`);
return;
}
const source = vscode.Uri.joinPath(ctx.extension.extensionUri, 'templates', 'models', example.folder);
await vscode.workspace.fs.copy(source, target, { overwrite: false });
const main = vscode.Uri.joinPath(target, MAIN_FILE);
await vscode.workspace.fs.writeFile(main, Buffer.from(mainFromExample(await readText(main), folderName, example), 'utf8'));
await vscode.commands.executeCommand('vscode.openWith', main, DIAGRAM_EDITOR_VIEW_TYPE);
}),
];
}
+13 -4
View File
@@ -1,5 +1,6 @@
import path from 'node:path';
import * as vscode from 'vscode'; import * as vscode from 'vscode';
import { diagramFromTemplate, diagramName, invalidNameReason, TEMPLATES } from '../language/templates'; import { diagramFromTemplate, diagramName, invalidNameReason, modelFromTemplate, TEMPLATES } from '../language/templates';
import { diagramBaseName, isArchifyFile } from '../sources/detect'; import { diagramBaseName, isArchifyFile } from '../sources/detect';
import { readText } from '../util/files'; import { readText } from '../util/files';
import { DIAGRAM_EDITOR_VIEW_TYPE } from '../views/diagramView'; import { DIAGRAM_EDITOR_VIEW_TYPE } from '../views/diagramView';
@@ -24,11 +25,17 @@ export function newDiagramCommands(ctx: CommandContext): vscode.Disposable[] {
{ title: 'Archify | New Diagram', placeHolder: 'Kind of diagram' }, { title: 'Archify | New Diagram', placeHolder: 'Kind of diagram' },
); );
if (!template) return; if (!template) return;
const { file, defaultName } = template.template; const { file, defaultName, fixedName } = template.template;
const folder = await newDiagramFolder(arg); const folder = await newDiagramFolder(arg);
let target: vscode.Uri | undefined; let target: vscode.Uri | undefined;
if (folder) { if (folder && fixedName) {
target = vscode.Uri.joinPath(folder, fixedName);
if (await exists(target)) {
vscode.window.showWarningMessage(`Archify: ${vscode.workspace.asRelativePath(folder, true)} already has a ${fixedName}.`);
return;
}
} else if (folder) {
const name = await vscode.window.showInputBox({ const name = await vscode.window.showInputBox({
title: 'Archify | New Diagram', title: 'Archify | New Diagram',
prompt: `File name in ${vscode.workspace.asRelativePath(folder, true)}`, prompt: `File name in ${vscode.workspace.asRelativePath(folder, true)}`,
@@ -51,7 +58,9 @@ export function newDiagramCommands(ctx: CommandContext): vscode.Disposable[] {
} }
const templateText = await readText(vscode.Uri.joinPath(ctx.extension.extensionUri, 'templates', file)); const templateText = await readText(vscode.Uri.joinPath(ctx.extension.extensionUri, 'templates', file));
const text = diagramFromTemplate(templateText, diagramBaseName(target.path)); const text = fixedName
? modelFromTemplate(templateText, path.basename(path.dirname(target.fsPath)))
: diagramFromTemplate(templateText, diagramBaseName(target.path));
await vscode.workspace.fs.writeFile(target, Buffer.from(text, 'utf8')); await vscode.workspace.fs.writeFile(target, Buffer.from(text, 'utf8'));
await vscode.commands.executeCommand('vscode.openWith', target, DIAGRAM_EDITOR_VIEW_TYPE); await vscode.commands.executeCommand('vscode.openWith', target, DIAGRAM_EDITOR_VIEW_TYPE);
}), }),
+4 -3
View File
@@ -3,7 +3,8 @@ import path from 'node:path';
import * as vscode from 'vscode'; import * as vscode from 'vscode';
import { isEvidenceError, renderDiagram, renderToFile } from '../archify/cli'; import { isEvidenceError, renderDiagram, renderToFile } from '../archify/cli';
import { evidenceMode, runtimeFor } from '../archify/runtime'; import { evidenceMode, runtimeFor } from '../archify/runtime';
import { diagramBaseName, readDiagramSource } from '../sources/detect'; import { prepareDiagram } from '../model/prepare';
import { diagramBaseName } from '../sources/detect';
import { log } from '../util/log'; import { log } from '../util/log';
import { readText } from '../util/files'; import { readText } from '../util/files';
import { CommandContext, isHtmlUri, openHtmlViewer, sourceUri } from './context'; import { CommandContext, isHtmlUri, openHtmlViewer, sourceUri } from './context';
@@ -14,7 +15,7 @@ export function renderCommands(ctx: CommandContext): vscode.Disposable[] {
const uri = sourceUri(ctx, arg); const uri = sourceUri(ctx, arg);
if (!uri) return; if (!uri) return;
const text = await readText(uri); const text = await readText(uri);
const source = readDiagramSource(text, uri.path); const source = (await prepareDiagram(ctx.models, uri, text))?.source;
if (!source) { if (!source) {
vscode.window.showWarningMessage(`Archify: ${path.basename(uri.path)} has no "diagram_type" (architecture, workflow, sequence, dataflow or lifecycle).`); vscode.window.showWarningMessage(`Archify: ${path.basename(uri.path)} has no "diagram_type" (architecture, workflow, sequence, dataflow or lifecycle).`);
return; return;
@@ -66,7 +67,7 @@ export function renderCommands(ctx: CommandContext): vscode.Disposable[] {
return; return;
} }
const text = await readText(uri); const text = await readText(uri);
const source = readDiagramSource(text, uri.path); const source = (await prepareDiagram(ctx.models, uri, text))?.source;
if (!source) { if (!source) {
vscode.window.showWarningMessage(`Archify: ${path.basename(uri.path)} has no "diagram_type" (architecture, workflow, sequence, dataflow or lifecycle).`); vscode.window.showWarningMessage(`Archify: ${path.basename(uri.path)} has no "diagram_type" (architecture, workflow, sequence, dataflow or lifecycle).`);
return; return;
+21
View File
@@ -1,6 +1,10 @@
import * as vscode from 'vscode'; import * as vscode from 'vscode';
import { isDecisionFile } from '../model/decisions';
import { isRegistryFile } from '../model/format';
import { isArchifyFile } from '../sources/detect'; import { isArchifyFile } from '../sources/detect';
import { DIAGRAM_EDITOR_VIEW_TYPE } from '../views/diagramView'; import { DIAGRAM_EDITOR_VIEW_TYPE } from '../views/diagramView';
import { REGISTRY_VIEW_TYPE } from '../views/registryView';
import { DECISION_VIEW_TYPE } from '../views/decisionView';
import { CommandContext, isHtmlUri, openHtmlViewer, sourceUri } from './context'; import { CommandContext, isHtmlUri, openHtmlViewer, sourceUri } from './context';
export function viewCommands(ctx: CommandContext): vscode.Disposable[] { export function viewCommands(ctx: CommandContext): vscode.Disposable[] {
@@ -9,6 +13,8 @@ export function viewCommands(ctx: CommandContext): vscode.Disposable[] {
const uri = sourceUri(ctx, arg); const uri = sourceUri(ctx, arg);
if (!uri) return; if (!uri) return;
if (isHtmlUri(uri)) return openHtmlViewer(uri); if (isHtmlUri(uri)) return openHtmlViewer(uri);
if (isRegistryFile(uri.path)) return vscode.commands.executeCommand('vscode.openWith', uri, REGISTRY_VIEW_TYPE);
if (isDecisionFile(uri.path)) return vscode.commands.executeCommand('vscode.openWith', uri, DECISION_VIEW_TYPE);
if (isArchifyFile(uri.path)) return vscode.commands.executeCommand('vscode.openWith', uri, DIAGRAM_EDITOR_VIEW_TYPE); if (isArchifyFile(uri.path)) return vscode.commands.executeCommand('vscode.openWith', uri, DIAGRAM_EDITOR_VIEW_TYPE);
ctx.views.show(uri, vscode.window.activeTextEditor?.viewColumn ?? vscode.ViewColumn.Active); ctx.views.show(uri, vscode.window.activeTextEditor?.viewColumn ?? vscode.ViewColumn.Active);
}), }),
@@ -33,7 +39,17 @@ export function viewCommands(ctx: CommandContext): vscode.Disposable[] {
vscode.commands.registerCommand('archify.refreshPreview', () => ctx.views.activePreview?.update(true)), vscode.commands.registerCommand('archify.refreshPreview', () => ctx.views.activePreview?.update(true)),
// On a page that has a Source view, show it; elsewhere open the text.
vscode.commands.registerCommand('archify.showSource', async () => { vscode.commands.registerCommand('archify.showSource', async () => {
const session = ctx.views.activePreview?.source ?? ctx.registry.activeView?.source ?? ctx.decision.activeView?.source;
if (session) {
session.reveal();
return;
}
await vscode.commands.executeCommand('archify.openInTextEditor');
}),
vscode.commands.registerCommand('archify.openInTextEditor', async () => {
const preview = ctx.views.activePreview; const preview = ctx.views.activePreview;
if (preview?.isEditor) { if (preview?.isEditor) {
// The diagram is the editor; open the YAML text beside it. // The diagram is the editor; open the YAML text beside it.
@@ -45,6 +61,11 @@ export function viewCommands(ctx: CommandContext): vscode.Disposable[] {
await vscode.window.showTextDocument(preview.uri, { viewColumn: column }); await vscode.window.showTextDocument(preview.uri, { viewColumn: column });
return; return;
} }
const page = ctx.registry.activeUri ?? ctx.decision.activeUri;
if (page) {
await vscode.commands.executeCommand('vscode.openWith', page, 'default', vscode.ViewColumn.Beside);
return;
}
const html = ctx.htmlViewer.activeUri; const html = ctx.htmlViewer.activeUri;
if (html) await vscode.commands.executeCommand('vscode.openWith', html, 'default'); if (html) await vscode.commands.executeCommand('vscode.openWith', html, 'default');
}), }),
+25 -3
View File
@@ -4,29 +4,51 @@ import { registerContextKeys } from './commands/contextKeys';
import { newDiagramCommands } from './commands/newDiagram'; import { newDiagramCommands } from './commands/newDiagram';
import { renderCommands } from './commands/renderCommands'; import { renderCommands } from './commands/renderCommands';
import { viewCommands } from './commands/viewCommands'; import { viewCommands } from './commands/viewCommands';
import { modelCommands } from './commands/modelCommands';
import { BRAND_COMPLETION_SELECTOR, BrandCompletionProvider } from './language/brandCompletion'; import { BRAND_COMPLETION_SELECTOR, BrandCompletionProvider } from './language/brandCompletion';
import { REF_SELECTOR, RefLanguage } from './language/refLanguage';
import { ModelService } from './model/service';
import { DiagnosticsController } from './language/diagnostics'; import { DiagnosticsController } from './language/diagnostics';
import { log } from './util/log'; import { log } from './util/log';
import { HtmlViewerProvider } from './views/htmlViewer'; import { HtmlViewerProvider } from './views/htmlViewer';
import { DiagramViewManager } from './views/diagramView'; import { DiagramViewManager } from './views/diagramView';
import { RegistryViewProvider } from './views/registryView';
import { DecisionViewProvider } from './views/decisionView';
import { DECISION_SELECTOR, DecisionLanguage } from './language/decisionLanguage';
export function activate(context: vscode.ExtensionContext): void { export function activate(context: vscode.ExtensionContext): void {
const models = new ModelService();
const ctx: CommandContext = { const ctx: CommandContext = {
extension: context, extension: context,
views: new DiagramViewManager(context), views: new DiagramViewManager(context, models),
htmlViewer: new HtmlViewerProvider(context.extensionUri), htmlViewer: new HtmlViewerProvider(context.extensionUri),
registry: new RegistryViewProvider(context, models),
decision: new DecisionViewProvider(context, models),
models,
}; };
const refs = new RefLanguage(models);
const decisions = new DecisionLanguage(models);
context.subscriptions.push( context.subscriptions.push(
models,
ctx.views, ctx.views,
ctx.htmlViewer, ctx.htmlViewer,
new DiagnosticsController(context), ctx.registry,
ctx.decision,
new DiagnosticsController(context, models),
log(), log(),
vscode.languages.registerCompletionItemProvider(BRAND_COMPLETION_SELECTOR, new BrandCompletionProvider(context.extensionPath), ' ', '"'), vscode.languages.registerCompletionItemProvider(BRAND_COMPLETION_SELECTOR, new BrandCompletionProvider(context.extensionPath), ' ', '"'),
vscode.languages.registerCompletionItemProvider(REF_SELECTOR, refs, ' ', '"'),
vscode.languages.registerHoverProvider(REF_SELECTOR, refs),
vscode.languages.registerDefinitionProvider(REF_SELECTOR, refs),
vscode.languages.registerCompletionItemProvider(DECISION_SELECTOR, decisions, ' ', '[', ',', '"'),
vscode.languages.registerHoverProvider(DECISION_SELECTOR, decisions),
vscode.languages.registerDefinitionProvider(DECISION_SELECTOR, decisions),
...viewCommands(ctx), ...viewCommands(ctx),
...newDiagramCommands(ctx), ...newDiagramCommands(ctx),
...renderCommands(ctx), ...renderCommands(ctx),
...modelCommands(ctx),
); );
registerContextKeys(context); registerContextKeys(context, models);
} }
export function deactivate(): void {} export function deactivate(): void {}
+855
View File
@@ -0,0 +1,855 @@
import cytoscape, { Core, EdgeSingular, NodeSingular } from 'cytoscape';
import fcose from 'cytoscape-fcose';
import type { GraphEdge, GraphNode, ModelGraph } from '../model/graph';
import { QueryResult, runQuery } from '../model/graphQuery';
import { GRAPH_PAGE_STYLE } from './style';
import { layeredLayout } from './layout';
import type { ArchifyHost } from '../webview/host';
/**
* The Graph page of a model: the whole model as one graph, a query box that
* narrows it, a side panel for the selected element or connection. Runs in
* the webview; the extension hands the graph over through the bridge
* (`window.__archifyHost.graph`) and posts a new one when the model changes.
*/
type Host = ArchifyHost;
interface SavedView {
query?: string;
labels?: boolean;
hidden?: string[];
/** A theme chosen on the page; absent means follow VS Code. */
theme?: 'dark' | 'light';
/** Layered by type (default) or force-directed. */
layout?: 'layered' | 'force';
/** Show every decision and registry link, not only the selected element's. */
links?: boolean;
}
type Theme = 'dark' | 'light';
/** The theme in effect: the page's own choice, else VS Code's. */
function currentTheme(): Theme {
const chosen = document.documentElement.dataset.theme;
if (chosen === 'dark' || chosen === 'light') return chosen;
return document.body.classList.contains('vscode-light') ? 'light' : 'dark';
}
cytoscape.use(fcose);
const TYPE_COLORS: Record<string, string> = { frontend: '#22d3ee', backend: '#34d399', database: '#a78bfa', cloud: '#fbbf24', security: '#fb7185', messagebus: '#fb923c', external: '#94a3b8', decision: '#e879f9', registry: '#cbd5e1' };
const TYPE_ORDER = ['external', 'frontend', 'cloud', 'security', 'backend', 'messagebus', 'database', 'decision', 'registry'];
const STATUS_COLORS: Record<string, string> = { accepted: '#34d399', proposed: '#fbbf24', rejected: '#fb7185', superseded: '#94a3b8' };
const colorOf = (type: string | undefined) => TYPE_COLORS[type ?? ''] ?? '#94a3b8';
/** An opaque mix of two `#rrggbb` colours (`amount` of the first), so nodes hide the connections behind them. */
function mix(front: string, back: string, amount: number): string {
const f = parseInt(front.slice(1), 16);
const b = parseInt(back.replace(/^#/, '').padEnd(6, '0').slice(0, 6), 16);
const channel = (shift: number) => Math.round(((f >> shift) & 255) * amount + ((b >> shift) & 255) * (1 - amount));
return `rgb(${channel(16)}, ${channel(8)}, ${channel(0)})`;
}
/** `#rrggbb` form of a CSS colour, read through the canvas so `rgb()` and names work too. */
function toHex(color: string): string {
if (/^#[0-9a-f]{6}$/i.test(color)) return color;
const canvas = document.createElement('canvas').getContext('2d');
if (!canvas) return '#000000';
canvas.fillStyle = color;
return /^#[0-9a-f]{6}$/i.test(canvas.fillStyle) ? canvas.fillStyle : '#000000';
}
const nodeColor = (n: GraphNode) => (n.kind === 'decision' ? STATUS_COLORS[n.status ?? ''] ?? TYPE_COLORS.decision : colorOf(n.type));
/** Edge labels are drawn by default up to this many connections; above it they clutter. */
const LABELS_UP_TO = 40;
const PLACEHOLDER = 'database · type:backend · diagram:0200-* · uses:api · near:api,2 · from:web to:db · decision:<id> · unused · -shared';
const HELP: [string, string][] = [
['database', 'elements whose id, label, sublabel, brand or type contain the word'],
['type:backend', 'elements of that type'],
['diagram:0200-*', 'what the diagrams matching the path draw (glob)'],
['decision:<id>', 'what a decision is about or is attached to'],
['uses:api', 'an element and its neighbours'],
['near:api,2', 'an element and everything within two steps'],
['from:web to:db', 'the shortest path between two elements'],
['unused', 'registry elements no diagram draws'],
['shared', 'registry elements only; -shared: inline elements only'],
['-worker', 'a leading minus excludes; terms combine with AND'],
];
function el<K extends keyof HTMLElementTagNameMap>(tag: K, className?: string, text?: string): HTMLElementTagNameMap[K] {
const node = document.createElement(tag);
if (className) node.className = className;
if (text !== undefined) node.textContent = text;
return node;
}
function cssVar(name: string, fallback: string): string {
const value = getComputedStyle(document.documentElement).getPropertyValue(name).trim();
return value || fallback;
}
/** Theme colours Cytoscape needs as literals: the page's tokens, read again whenever the theme changes. */
function palette() {
const dark = currentTheme() === 'dark';
return {
bg: cssVar('--ag-bg', dark ? '#0b1020' : '#ffffff'),
fg: cssVar('--ag-fg', dark ? '#e5e7eb' : '#1f2937'),
muted: cssVar('--ag-muted', dark ? '#9ca3af' : '#6b7280'),
panel: cssVar('--ag-panel', dark ? '#131c31' : '#f3f4f6'),
accent: cssVar('--ag-accent', '#22d3ee'),
edge: dark ? '#64748b' : '#94a3b8',
font: cssVar('--ag-font', 'system-ui, sans-serif'),
};
}
class GraphPage {
cy!: Core;
private graph: ModelGraph;
private readonly nodesById = new Map<string, GraphNode>();
private readonly edgesById = new Map<string, GraphEdge>();
private saved: SavedView;
private queryTimer: number | undefined;
private result: QueryResult | undefined;
private readonly hiddenTypes: Set<string>;
private readonly root = el('div', 'ag');
private readonly nameEl = el('div', 'ag-name');
private readonly kickerEl = el('div', 'ag-kicker');
private readonly queryInput = el('input', 'ag-query');
private readonly countEl = el('span', 'ag-count');
private readonly labelsButton = el('button', 'ag-button', 'Labels');
private readonly linksButton = el('button', 'ag-button', 'Links');
private readonly layoutButton = el('button', 'ag-button', 'Layered');
private readonly themeButton = el('button', 'ag-button ag-theme');
private readonly legend = el('div', 'ag-legend');
private readonly side = el('aside', 'ag-side');
private readonly main = el('div', 'ag-main');
private readonly canvas = el('div', 'ag-canvas');
private readonly help = el('div', 'ag-help');
constructor(private readonly host: Host, initial: { graph: ModelGraph; query?: string }) {
this.graph = initial.graph;
this.saved = (host.getState().graphView as SavedView | undefined) ?? {};
if (initial.query !== undefined) this.saved.query = initial.query;
if (this.saved.labels === undefined) this.saved.labels = initial.graph.edges.length <= LABELS_UP_TO;
if (this.saved.links === undefined) this.saved.links = true;
this.hiddenTypes = new Set(this.saved.hidden ?? []);
this.applyTheme(this.saved.theme ?? archifyThemePreference());
this.index();
this.buildChrome();
this.buildGraph(true);
this.syncLabels();
this.renderLegend();
this.syncLayoutButton();
this.queryInput.value = this.saved.query ?? '';
this.applyQuery();
this.showEmptySide();
this.listen();
}
// ---------------------------------------------------------------- data
private index(): void {
this.nodesById.clear();
this.edgesById.clear();
for (const n of this.graph.nodes) this.nodesById.set(n.id, n);
for (const e of this.graph.edges) this.edgesById.set(e.id, e);
}
private elements() {
const shorten = (text: string, max: number) => {
if (text.length <= max) return text;
const cut = text.slice(0, max - 1);
return `${cut.slice(0, Math.max(cut.lastIndexOf(' '), max - 16))}\u2026`;
};
const nodes = this.graph.nodes.map((n) => ({ group: 'nodes' as const, data: { id: n.id, label: n.kind === 'decision' ? shorten(n.label, 60) : n.label, type: n.type ?? '', kind: n.kind, shared: n.shared ? 1 : 0, color: nodeColor(n) } }));
// In the layered layout a label sits at the end of the connection where fewer connections meet, so a
// fan-out labels at its targets and a fan-in at its sources; what still shares an end is staggered.
const outCount = new Map<string, number>();
const inCount = new Map<string, number>();
for (const e of this.graph.edges) {
if (e.kind !== 'connection') continue;
outCount.set(e.from, (outCount.get(e.from) ?? 0) + 1);
inCount.set(e.to, (inCount.get(e.to) ?? 0) + 1);
}
const used = new Map<string, number>();
const edges = this.graph.edges.map((e) => {
const at = e.kind === 'connection' && (outCount.get(e.from) ?? 0) > (inCount.get(e.to) ?? 0) ? 'target' : 'source';
const key = `${at}:${at === 'source' ? e.from : e.to}`;
const index = used.get(key) ?? 0;
used.set(key, index + 1);
return { group: 'edges' as const, data: { id: e.id, source: e.from, target: e.to, kind: e.kind, label: e.labels.join(' / '), at, offset: 40 + (index % 3) * 34 } };
});
return [...nodes, ...edges];
}
/** A new graph from the extension: keep the positions of the elements that are still there. */
replace(graph: ModelGraph): void {
const positions = new Map<string, { x: number; y: number }>();
this.cy.nodes().forEach((n) => {
positions.set(n.id(), { ...n.position() });
});
const selected = this.cy.$(':selected').map((e) => e.id());
this.graph = graph;
this.index();
this.cy.elements().remove();
this.cy.add(this.elements());
let fresh = 0;
this.cy.nodes().forEach((n) => {
const at = positions.get(n.id());
if (at) n.position(at);
else fresh += 1;
});
if (fresh || this.saved.layout !== 'force') this.layout(false);
this.syncLinks();
this.renderLegend();
this.applyHidden();
this.applyQuery();
const again = this.cy.$(selected.map((id) => `#${CSS.escape(id)}`).join(','));
if (again.length) {
again.select();
this.showSide(again[0]);
} else this.showEmptySide();
this.kickerEl.textContent = `Model${graph.meta.id ? ` · ${graph.meta.id}` : ''}`;
this.nameEl.textContent = graph.meta.name || graph.meta.id || 'Untitled model';
}
// -------------------------------------------------------------- chrome
private buildChrome(): void {
const style = el('style');
style.textContent = GRAPH_PAGE_STYLE;
document.head.appendChild(style);
const top = el('header', 'ag-top');
const titles = el('div');
this.kickerEl.textContent = `Model${this.graph.meta.id ? ` · ${this.graph.meta.id}` : ''}`;
this.nameEl.textContent = this.graph.meta.name || this.graph.meta.id || 'Untitled model';
titles.append(this.kickerEl, this.nameEl);
const actions = el('div', 'ag-actions');
// Model | Graph | Source, as on the model page. Source goes back to the
// model page and opens it in Source (the page reads sourceView on load).
const sw = el('div', 'ag-switch');
sw.setAttribute('role', 'group');
sw.setAttribute('aria-label', 'View');
const segment = (label: string, title: string, on: boolean, action?: () => void) => {
const button = el('button', `ag-seg${on ? ' on' : ''}`, label);
button.type = 'button';
button.title = title;
button.setAttribute('aria-pressed', String(on));
if (action) button.addEventListener('click', action);
return button;
};
sw.append(
segment('Model', 'Back to the model page', false, () => this.host.post({ type: 'showModel' })),
segment('Graph', 'The model as one graph', true),
segment('Source', 'Edit the YAML of main.archify, checked as you type', false, () => {
this.host.setState({ sourceView: true });
this.host.post({ type: 'showModel' });
}),
);
const exportButton = el('button', 'ag-button ag-primary', 'Export PNG');
exportButton.type = 'button';
exportButton.title = 'Save the graph as it is on screen, as a PNG';
exportButton.addEventListener('click', () => this.exportPng());
this.themeButton.type = 'button';
this.themeButton.setAttribute('role', 'switch');
this.themeButton.append(el('span', 'ag-theme-track'), el('span', 'ag-theme-icon'), el('span', 'ag-sr', 'Dark theme'));
this.themeButton.addEventListener('click', () => this.setTheme(currentTheme() === 'dark' ? 'light' : 'dark'));
this.syncThemeButton();
actions.append(sw, this.themeButton, exportButton);
top.append(titles, actions);
const bar = el('div', 'ag-bar');
const wrap = el('div', 'ag-query-wrap');
this.queryInput.type = 'text';
this.queryInput.placeholder = PLACEHOLDER;
this.queryInput.spellcheck = false;
this.queryInput.setAttribute('aria-label', 'Query');
const clear = el('button', 'ag-clear', '×');
clear.type = 'button';
clear.title = 'Clear (Esc)';
clear.addEventListener('click', () => this.setQuery(''));
wrap.append(this.queryInput, clear);
const fit = el('button', 'ag-button', 'Fit');
fit.type = 'button';
fit.title = 'Fit the matching elements into view (0)';
fit.addEventListener('click', () => this.fit());
this.layoutButton.type = 'button';
this.layoutButton.addEventListener('click', () => {
this.saved.layout = this.saved.layout === 'force' ? 'layered' : 'force';
this.save();
this.layout(true);
this.syncLayoutButton();
});
this.linksButton.type = 'button';
this.linksButton.title = 'Links from decisions and registries to their elements: on for all, off for the selected element only';
this.linksButton.addEventListener('click', () => {
this.saved.links = !this.saved.links;
this.save();
this.syncLinks();
});
this.labelsButton.type = 'button';
this.labelsButton.title = 'Show or hide connection labels';
this.labelsButton.addEventListener('click', () => {
this.saved.labels = !this.saved.labels;
this.save();
this.syncLabels();
});
const helpButton = el('button', 'ag-button', '?');
helpButton.type = 'button';
helpButton.title = 'What can I type?';
helpButton.setAttribute('aria-expanded', 'false');
helpButton.addEventListener('click', () => {
this.help.hidden = !this.help.hidden;
helpButton.setAttribute('aria-expanded', String(!this.help.hidden));
});
bar.append(wrap, this.countEl, fit, this.layoutButton, this.labelsButton, this.linksButton, helpButton);
const cyHolder = el('div', 'ag-cy');
this.canvas.append(cyHolder, this.legend);
this.help.hidden = true;
this.help.appendChild(el('h3', '', 'Queries'));
const table = el('table');
for (const [example, meaning] of HELP) {
const row = el('tr');
const code = el('td', '', example);
code.title = 'Try it';
code.addEventListener('click', () => {
this.setQuery(example.includes('<id>') ? example.replace('<id>', this.graph.decisions[0]?.id ?? '') : example);
});
row.append(code, el('td', '', meaning));
table.appendChild(row);
}
this.help.appendChild(table);
this.help.appendChild(el('p', '', 'Matches stay bright, the rest dims. Connections show when both ends match. Click an element for its details; drag to move it; scroll to zoom. Press / to type a query. Layered puts clients on the left and data on the right, with registries before and decisions after; Links switches the dotted decision and registry links between all of them and the selected element\u2019s only.'));
this.main.append(this.canvas, this.side, this.help);
const head = el('div', 'ag-head');
head.append(top, bar);
this.root.append(head, this.main);
document.body.appendChild(this.root);
this.syncLabels();
}
private renderLegend(): void {
this.legend.textContent = '';
const counts = new Map<string, number>();
for (const n of this.graph.nodes) counts.set(n.type ?? 'other', (counts.get(n.type ?? 'other') ?? 0) + 1);
const types = [...counts.keys()].sort((a, b) => (TYPE_ORDER.indexOf(a) + 1 || 99) - (TYPE_ORDER.indexOf(b) + 1 || 99) || a.localeCompare(b));
for (const type of types) {
const chip = el('button', 'ag-chip');
chip.type = 'button';
chip.style.setProperty('--c', colorOf(type));
chip.setAttribute('aria-pressed', String(!this.hiddenTypes.has(type)));
chip.title = `Show or hide ${type} elements`;
chip.append(document.createTextNode(type), el('small', '', String(counts.get(type))));
chip.addEventListener('click', () => {
if (this.hiddenTypes.has(type)) this.hiddenTypes.delete(type);
else this.hiddenTypes.add(type);
chip.setAttribute('aria-pressed', String(!this.hiddenTypes.has(type)));
this.saved.hidden = [...this.hiddenTypes];
this.save();
this.applyHidden();
this.updateCount();
});
this.legend.appendChild(chip);
}
}
// --------------------------------------------------------------- graph
private buildGraph(first: boolean): void {
const holder = this.canvas.firstElementChild as HTMLElement;
this.cy = cytoscape({
container: holder,
elements: this.elements(),
style: this.stylesheet(),
wheelSensitivity: 0.2,
minZoom: 0.1,
maxZoom: 4,
});
this.applyHidden();
this.syncLinks();
this.layout(first);
this.cy.on('tap', 'node, edge', (event) => this.showSide(event.target as NodeSingular | EdgeSingular));
this.cy.on('tap', (event) => {
if (event.target === this.cy) this.showEmptySide();
});
// Hover lights up an element and its connections; selection also reveals its decision and registry links.
this.cy.on('mouseover', 'node', (event) => {
const node = event.target as NodeSingular;
node.addClass('hover');
node.connectedEdges('[kind = "connection"]').addClass('edge-hover');
});
this.cy.on('mouseout', 'node', (event) => {
const node = event.target as NodeSingular;
node.removeClass('hover');
node.connectedEdges().removeClass('edge-hover');
});
this.cy.on('select unselect', 'node', () => this.syncLinks());
}
/** Decision and registry links: all of them when Links is on, else those of the selected nodes. */
private syncLinks(): void {
const all = Boolean(this.saved.links);
this.linksButton.setAttribute('aria-pressed', String(all));
const meta = this.cy.edges('[kind != "connection"]');
meta.removeClass('shown');
if (all) meta.addClass('shown');
else this.cy.nodes(':selected').connectedEdges('[kind != "connection"]').addClass('shown');
}
private syncLayoutButton(): void {
const force = this.saved.layout === 'force';
this.layoutButton.textContent = force ? 'Force' : 'Layered';
this.layoutButton.title = force ? 'Force-directed layout; click for the layered one (clients left, data right)' : 'Layered by type; click for a force-directed layout';
}
private stylesheet(): cytoscape.StylesheetJson {
const p = palette();
const dark = currentTheme() === 'dark';
const bg = toHex(p.bg);
const fill = (amount: number) => (n: NodeSingular) => mix(String(n.data('color')), bg, amount);
return [
{ selector: 'node', style: { shape: 'round-rectangle', width: (n: NodeSingular) => Math.min(240, Math.max(110, String(n.data('label')).length * 7.6 + 40)), height: 46, 'background-color': fill(dark ? 0.16 : 0.1), 'border-width': 1.5, 'border-color': 'data(color)', 'border-opacity': 0.9, label: 'data(label)', color: p.fg, 'font-size': 13, 'font-weight': 600, 'font-family': p.font, 'text-valign': 'center', 'text-halign': 'center', 'text-wrap': 'ellipsis', 'text-max-width': '210px', 'overlay-opacity': 0, 'underlay-color': 'data(color)', 'underlay-padding': 6, 'underlay-opacity': 0, 'underlay-shape': 'round-rectangle', 'transition-property': 'underlay-opacity, border-width', 'transition-duration': 120 } },
{ selector: 'node[shared = 0]', style: { 'border-style': 'dashed' } },
{ selector: 'node[kind = "decision"]', style: { shape: 'round-tag', height: (n: NodeSingular) => (String(n.data('label')).length > 30 ? 44 : 34), 'font-size': 11, 'font-weight': 500, 'background-color': fill(dark ? 0.12 : 0.08), 'text-wrap': 'wrap', 'text-max-width': '196px', 'line-height': 1.2, width: (n: NodeSingular) => Math.min(244, Math.max(120, String(n.data('label')).length * 6.4 + 48)) } },
{ selector: 'node[kind = "registry"]', style: { shape: 'cut-rectangle', height: 32, 'font-size': 11, 'font-weight': 500, 'font-family': 'ui-monospace, Menlo, monospace', 'border-width': 1, 'border-color': p.muted, 'background-color': mix(dark ? '#94a3b8' : '#64748b', bg, 0.08), width: (n: NodeSingular) => Math.min(220, Math.max(110, String(n.data('label')).length * 6.8 + 36)) } },
{ selector: 'node.hover', style: { 'underlay-opacity': dark ? 0.22 : 0.16, 'border-width': 2, 'background-color': fill(dark ? 0.28 : 0.18) } },
{ selector: 'edge', style: { width: 1.4, 'line-color': p.edge, 'line-opacity': 0.85, 'target-arrow-color': p.edge, 'target-arrow-shape': 'triangle', 'arrow-scale': 0.8, 'curve-style': 'bezier', label: '', 'font-size': 10, 'font-family': p.font, color: p.muted, 'text-background-color': p.bg, 'text-background-opacity': 1, 'text-background-padding': '3px', 'text-background-shape': 'round-rectangle', 'text-rotation': 'autorotate', 'transition-property': 'width, line-color', 'transition-duration': 120 } },
{ selector: 'edge.ortho', style: { 'curve-style': 'taxi', 'taxi-direction': 'auto', 'taxi-turn': '45%', 'taxi-turn-min-distance': 24, 'text-rotation': 'none', 'source-text-offset': 'data(offset)', 'source-text-rotation': 'none', 'source-text-background-color': p.bg, 'source-text-background-opacity': 1, 'source-text-background-padding': '3px', 'source-text-background-shape': 'round-rectangle', 'target-text-offset': 'data(offset)', 'target-text-rotation': 'none', 'target-text-background-color': p.bg, 'target-text-background-opacity': 1, 'target-text-background-padding': '3px', 'target-text-background-shape': 'round-rectangle' } },
{ selector: 'edge.edge-hover', style: { width: 2.4, 'line-color': p.fg, 'target-arrow-color': p.fg, 'line-opacity': 1, color: p.fg } },
{ selector: 'edge[kind != "connection"]', style: { display: 'none', width: 1, 'curve-style': 'bezier', 'line-style': 'dotted', 'target-arrow-shape': 'none', 'line-color': p.muted, 'line-opacity': 0.55 } },
{ selector: 'edge[kind = "supersedes"]', style: { 'line-style': 'dashed', 'line-color': TYPE_COLORS.decision, 'target-arrow-shape': 'triangle', 'target-arrow-color': TYPE_COLORS.decision } },
{ selector: 'edge[kind != "connection"].shown', style: { display: 'element' } },
{ selector: 'edge.labelled[kind = "connection"], edge.labelled[kind = "supersedes"]', style: { label: 'data(label)' } },
{ selector: 'edge.labelled.ortho[kind = "connection"][at = "source"]', style: { label: '', 'source-label': 'data(label)' } },
{ selector: 'edge.labelled.ortho[kind = "connection"][at = "target"]', style: { label: '', 'target-label': 'data(label)' } },
{ selector: '.dim', style: { opacity: 0.12, events: 'no' } },
{ selector: 'node.hit', style: { 'border-width': 2.5 } },
{ selector: 'edge.path', style: { width: 3, 'line-color': p.accent, 'target-arrow-color': p.accent, color: p.fg, 'line-opacity': 1 } },
{ selector: 'node:selected', style: { 'border-color': p.accent, 'border-width': 2.5, 'underlay-color': p.accent, 'underlay-opacity': dark ? 0.28 : 0.18, 'background-color': fill(dark ? 0.3 : 0.2) } },
{ selector: 'edge:selected', style: { width: 3, 'line-color': p.accent, 'target-arrow-color': p.accent, 'line-opacity': 1 } },
{ selector: '.hidden', style: { display: 'none' } },
] as unknown as cytoscape.StylesheetJson;
}
private layout(fresh: boolean): void {
const force = this.saved.layout === 'force';
this.cy.edges().toggleClass('ortho', !force);
if (force) {
this.cy
.elements()
.not('.hidden')
.layout({ name: 'fcose', animate: false, randomize: fresh, quality: 'default', nodeDimensionsIncludeLabels: true, nodeRepulsion: () => 9000, idealEdgeLength: (e: EdgeSingular) => (e.data('kind') === 'connection' ? 150 : 110), edgeElasticity: (e: EdgeSingular) => (e.data('kind') === 'connection' ? 0.2 : 0.08), gravity: 0.3, padding: 40, fit: true } as cytoscape.LayoutOptions)
.run();
return;
}
const positions = layeredLayout(this.graph.nodes, this.graph.edges);
this.cy.batch(() => {
this.cy.nodes().forEach((n) => {
const at = positions.get(n.id());
if (at) n.position(at);
});
});
this.cy.fit(this.cy.elements().not('.hidden'), 40);
}
// --------------------------------------------------------------- theme
/** Sets the page's own theme (or follows VS Code when undefined) without touching the saved choice. */
private applyTheme(theme: Theme | undefined): void {
if (theme) document.documentElement.dataset.theme = theme;
else delete document.documentElement.dataset.theme;
}
private setTheme(theme: Theme): void {
this.applyTheme(theme);
this.saved.theme = theme;
this.save();
try {
localStorage.setItem('archify-theme', theme); // the diagram pages read the same key
} catch {
// storage may be unavailable; the page state keeps the choice
}
this.restyle();
}
private syncThemeButton(): void {
const dark = currentTheme() === 'dark';
this.themeButton.dataset.on = dark ? 'dark' : 'light';
this.themeButton.setAttribute('aria-checked', String(dark));
this.themeButton.title = dark ? 'Dark theme on; switch to light' : 'Light theme on; switch to dark';
this.themeButton.setAttribute('aria-label', this.themeButton.title);
}
private restyle(): void {
this.cy?.style(this.stylesheet());
this.syncLabels();
this.syncThemeButton();
}
private applyHidden(): void {
this.cy.nodes().forEach((n) => {
n.toggleClass('hidden', this.hiddenTypes.has(String(n.data('type') || 'other')));
});
}
private syncLabels(): void {
const on = Boolean(this.saved.labels);
this.labelsButton.setAttribute('aria-pressed', String(on));
this.cy?.edges().toggleClass('labelled', on);
}
// --------------------------------------------------------------- query
private setQuery(text: string): void {
this.queryInput.value = text;
this.applyQuery();
this.queryInput.focus();
}
private applyQuery(): void {
const text = this.queryInput.value;
this.saved.query = text;
this.save();
this.result = runQuery(this.graph, text);
const { nodes, edges, path } = this.result;
const empty = !text.trim();
this.cy.batch(() => {
this.cy.elements().removeClass('dim hit path');
if (empty) return;
this.cy.nodes().forEach((n) => {
n.toggleClass('dim', !nodes.has(n.id())).toggleClass('hit', nodes.has(n.id()));
});
this.cy.edges().forEach((e) => {
e.toggleClass('dim', !edges.has(e.id()));
});
if (path) for (const id of edges) this.cy.$id(id).addClass('path');
});
this.updateCount();
}
private updateCount(): void {
const total = this.cy.nodes('[kind = "element"]').not('.hidden').length;
const r = this.result;
if (!r || !this.queryInput.value.trim()) {
this.countEl.textContent = `${total} elements · ${this.cy.edges('[kind = "connection"]').not('.hidden').length} connections`;
this.countEl.classList.remove('is-error');
return;
}
const shown = this.cy.nodes('.hit[kind = "element"]').not('.hidden').length;
this.countEl.textContent = r.message ? r.message : r.path ? `path of ${r.path.length} elements` : `${shown} of ${total} elements`;
this.countEl.classList.toggle('is-error', Boolean(r.message));
}
private fit(): void {
const hits = this.cy.nodes('.hit').not('.hidden');
const target = hits.length ? hits.union(hits.connectedEdges().not('.dim')) : this.cy.elements().not('.hidden');
this.cy.animate({ fit: { eles: target, padding: 40 }, duration: 250 });
}
// ---------------------------------------------------------------- side
private showEmptySide(): void {
this.side.textContent = '';
this.side.appendChild(el('p', 'ag-empty', 'Click an element or a connection.'));
const h3 = el('h3', '', 'This model');
this.side.appendChild(h3);
const elements = this.graph.nodes.filter((n) => n.kind === 'element');
const registries = this.graph.nodes.filter((n) => n.kind === 'registry');
const summary = el('p', '', `${elements.length} elements, ${this.graph.edges.filter((e) => e.kind === 'connection').length} connections, ${this.graph.diagrams.length} diagrams, ${registries.length} ${registries.length === 1 ? 'registry' : 'registries'}, ${this.graph.decisions.length} decisions.`);
this.side.appendChild(summary);
const unused = elements.filter((n) => n.shared && !n.diagrams.length).length;
if (unused) {
const hint = el('button', 'ag-link', `${unused} unused registry element${unused === 1 ? '' : 's'}`);
hint.type = 'button';
hint.addEventListener('click', () => this.setQuery('unused'));
this.side.appendChild(hint);
}
}
private showSide(target: NodeSingular | EdgeSingular): void {
if (!target.isNode()) {
this.showEdge(this.edgesById.get(target.id()));
return;
}
const node = this.nodesById.get(target.id());
if (node?.kind === 'decision') this.showDecision(node);
else if (node?.kind === 'registry') this.showRegistry(node);
else this.showNode(node);
}
private selectNode(id: string): void {
const n = this.cy.$id(id);
this.cy.elements().unselect();
n.select();
this.showSide(n as NodeSingular);
}
private elementLinks(ids: string[]): HTMLElement {
const holder = el('div');
for (const id of ids) {
const n = this.nodesById.get(id);
if (!n) continue;
const button = this.link(n.label, `Show ${n.id}`, () => this.selectNode(n.id));
const dot = el('span', 'ag-dot');
dot.style.setProperty('--c', nodeColor(n));
button.prepend(dot);
holder.appendChild(button);
}
return holder;
}
/** Side panel of a decision node: status, text, what it is about, and the file. */
private showDecision(node: GraphNode): void {
this.side.textContent = '';
const title = el('h2');
const dot = el('span', 'ag-dot');
dot.style.setProperty('--c', nodeColor(node));
title.append(dot, document.createTextNode(node.label));
this.side.appendChild(title);
this.side.appendChild(el('div', 'ag-id', ['decision', node.sublabel, node.status].filter(Boolean).join(' · ')));
if (node.description) this.side.appendChild(el('p', '', node.description));
const actions = el('div', 'ag-side-actions');
if (node.file) actions.appendChild(this.link('Open decision', `Open ${node.file}`, () => this.host.post({ type: 'openDecision', file: node.file })));
if (node.sublabel) actions.appendChild(this.link('What it touches', `Show everything decision ${node.sublabel} is about`, () => this.setQuery(`decision:${node.sublabel}`)));
this.side.appendChild(actions);
const about = this.graph.edges.filter((e) => e.kind === 'decides' && e.from === node.id).map((e) => e.to);
this.side.appendChild(el('h3', '', `About ${about.length} element${about.length === 1 ? '' : 's'}`));
this.side.appendChild(about.length ? this.elementLinks(about) : el('p', 'ag-empty', 'Names no element of this model.'));
const onEdges = this.graph.edges.filter((e) => e.kind === 'connection' && node.sublabel && e.decisions.includes(node.sublabel));
if (onEdges.length) {
this.side.appendChild(el('h3', '', 'On connections'));
const holder = el('div');
for (const e of onEdges) holder.appendChild(this.link(`${this.nodesById.get(e.from)?.label ?? e.from} → ${this.nodesById.get(e.to)?.label ?? e.to}`, e.id, () => { this.cy.elements().unselect(); this.cy.$id(e.id).select(); this.showEdge(e); }));
this.side.appendChild(holder);
}
if (node.diagrams.length) {
this.side.appendChild(el('h3', '', 'Diagrams it names'));
this.side.appendChild(this.diagramLinks(node.diagrams));
}
const related = this.graph.edges.filter((e) => e.kind === 'supersedes' && (e.from === node.id || e.to === node.id));
if (related.length) {
this.side.appendChild(el('h3', '', 'Related decisions'));
const holder = el('div');
for (const e of related) {
const otherId = e.from === node.id ? e.to : e.from;
const other = this.nodesById.get(otherId);
if (other) holder.appendChild(this.link(`${e.from === node.id ? 'supersedes' : 'superseded by'} ${other.label}`, other.sublabel ?? otherId, () => this.selectNode(otherId)));
}
this.side.appendChild(holder);
}
}
/** Side panel of a registry node: the file and the elements it defines. */
private showRegistry(node: GraphNode): void {
this.side.textContent = '';
const title = el('h2');
const dot = el('span', 'ag-dot');
dot.style.setProperty('--c', nodeColor(node));
title.append(dot, document.createTextNode(node.label));
this.side.appendChild(title);
this.side.appendChild(el('div', 'ag-id', `registry · ${node.file ?? ''}`));
const actions = el('div', 'ag-side-actions');
if (node.file) actions.appendChild(this.link('Open registry', `Open ${node.file}`, () => this.host.post({ type: 'openRegistry', file: node.file, line: 0 })));
this.side.appendChild(actions);
const ids = node.elements ?? [];
this.side.appendChild(el('h3', '', `Defines ${ids.length} element${ids.length === 1 ? '' : 's'}`));
this.side.appendChild(ids.length ? this.elementLinks(ids) : el('p', 'ag-empty', 'No elements yet.'));
const unused = ids.filter((id) => !(this.nodesById.get(id)?.diagrams.length));
if (unused.length) {
this.side.appendChild(el('h3', '', `${unused.length} not drawn by any diagram`));
this.side.appendChild(this.elementLinks(unused));
}
}
private link(text: string, title: string, onClick?: () => void, className = ''): HTMLButtonElement {
const button = el('button', `ag-link ${className}${onClick ? '' : ' is-static'}`);
button.type = 'button';
button.title = title;
button.appendChild(document.createTextNode(text));
if (onClick) button.addEventListener('click', onClick);
return button;
}
private decisionLinks(ids: string[]): HTMLElement {
const holder = el('div');
for (const id of ids) {
const d = this.graph.decisions.find((x) => x.id === id);
const button = this.link('', d ? `${d.title ?? d.id} (${d.status})` : id, d ? () => this.host.post({ type: 'openDecision', file: d.file }) : undefined, `is-${d?.status ?? 'unknown'}`);
button.prepend(el('span', 'ag-dot'));
button.appendChild(document.createTextNode([id, d?.title, d?.status].filter(Boolean).join(' · ')));
holder.appendChild(button);
}
return holder;
}
private diagramLinks(paths: string[]): HTMLElement {
const holder = el('div');
for (const path of paths) {
const d = this.graph.diagrams.find((x) => x.path === path);
holder.appendChild(this.link(path.replace(/\.archify$/, ''), d?.title ? `Open ${d.title} (${path})` : `Open ${path}`, () => this.host.post({ type: 'openDiagram', path })));
}
return holder;
}
private showNode(node: GraphNode | undefined): void {
if (!node) return;
this.side.textContent = '';
const title = el('h2');
const dot = el('span', 'ag-dot');
dot.style.setProperty('--c', colorOf(node.type));
title.append(dot, document.createTextNode(node.label));
this.side.appendChild(title);
this.side.appendChild(el('div', 'ag-id', [node.id, node.type, node.sublabel, node.brand ? `brand ${node.brand}` : undefined, node.shared ? 'registry' : 'inline'].filter(Boolean).join(' · ')));
this.side.appendChild(node.description ? el('p', '', node.description) : el('p', 'ag-empty', node.shared ? 'No description in the registry.' : 'Inline element: defined in the diagram, not in a registry.'));
const actions = el('div', 'ag-side-actions');
actions.appendChild(this.link('Neighbours', `Show ${node.id} and everything connected to it`, () => this.setQuery(`uses:${node.id}`)));
if (node.file) actions.appendChild(this.link('Registry', `Open ${node.file} at line ${(node.line ?? 0) + 1}`, () => this.host.post({ type: 'openRegistry', file: node.file, line: node.line ?? 0 })));
if (node.link) actions.appendChild(this.link('Explained by', `Open ${node.link}`, () => this.host.post({ type: 'openDiagram', path: node.link })));
this.side.appendChild(actions);
this.side.appendChild(el('h3', '', `Used in ${node.diagrams.length} diagram${node.diagrams.length === 1 ? '' : 's'}`));
this.side.appendChild(node.diagrams.length ? this.diagramLinks(node.diagrams) : el('p', 'ag-empty', 'Not drawn by any diagram yet.'));
const connected = this.graph.edges.filter((e) => e.kind === 'connection' && (e.from === node.id || e.to === node.id));
this.side.appendChild(el('h3', '', `${connected.length} connection${connected.length === 1 ? '' : 's'}`));
const list = el('div');
for (const e of connected) {
const other = e.from === node.id ? e.to : e.from;
const otherLabel = this.nodesById.get(other)?.label ?? other;
const text = e.from === node.id ? `→ ${otherLabel}` : `← ${otherLabel}`;
list.appendChild(this.link(e.labels.length ? `${text} · ${e.labels.join(' / ')}` : text, `${e.from} → ${e.to}`, () => {
const edge = this.cy.$id(e.id);
this.cy.elements().unselect();
edge.select();
this.showEdge(e);
}));
}
this.side.appendChild(list);
if (node.decisions.length) {
this.side.appendChild(el('h3', '', 'Decisions'));
this.side.appendChild(this.decisionLinks(node.decisions));
}
}
private showEdge(edge: GraphEdge | undefined): void {
if (!edge) return;
this.side.textContent = '';
const from = this.nodesById.get(edge.from);
const to = this.nodesById.get(edge.to);
const title = el('h2');
title.textContent = `${from?.label ?? edge.from} → ${to?.label ?? edge.to}`;
this.side.appendChild(title);
this.side.appendChild(el('div', 'ag-id', `${edge.from} → ${edge.to}${edge.labels.length ? ` · ${edge.labels.join(' / ')}` : ''}`));
const ends = el('div', 'ag-side-actions');
for (const end of [from, to]) {
if (!end) continue;
const button = this.link(end.label, `Show ${end.id}`, () => {
const n = this.cy.$id(end.id);
this.cy.elements().unselect();
n.select();
this.showNode(end);
});
const dot = el('span', 'ag-dot');
dot.style.setProperty('--c', colorOf(end.type));
button.prepend(dot);
ends.appendChild(button);
}
this.side.appendChild(ends);
this.side.appendChild(el('h3', '', `Drawn in ${edge.diagrams.length} diagram${edge.diagrams.length === 1 ? '' : 's'}`));
this.side.appendChild(this.diagramLinks(edge.diagrams));
if (edge.decisions.length) {
this.side.appendChild(el('h3', '', 'Decisions'));
this.side.appendChild(this.decisionLinks(edge.decisions));
}
}
// -------------------------------------------------------------- export
private exportPng(): void {
const blob = this.cy.png({ output: 'blob', full: true, scale: 2, bg: palette().bg });
const url = URL.createObjectURL(blob);
const anchor = document.createElement('a');
anchor.href = url;
anchor.download = `${this.graph.meta.id || 'model'}-graph.png`;
anchor.hidden = true;
document.body.appendChild(anchor);
anchor.click(); // the bridge turns the download into a VS Code save dialog
setTimeout(() => {
anchor.remove();
URL.revokeObjectURL(url);
}, 1000);
}
// -------------------------------------------------------------- events
private listen(): void {
this.queryInput.addEventListener('input', () => {
window.clearTimeout(this.queryTimer);
this.queryTimer = window.setTimeout(() => this.applyQuery(), 120);
});
this.queryInput.addEventListener('keydown', (event) => {
if (event.key === 'Enter') {
window.clearTimeout(this.queryTimer);
this.applyQuery();
this.fit();
} else if (event.key === 'Escape') {
if (this.queryInput.value) this.setQuery('');
else this.queryInput.blur();
}
});
window.addEventListener('keydown', (event) => {
const target = event.target as HTMLElement | null;
const typing = target && (target.isContentEditable || /^(INPUT|TEXTAREA|SELECT)$/.test(target.tagName));
if (typing || event.metaKey || event.ctrlKey || event.altKey) return;
if (event.key === '/') {
event.preventDefault();
this.queryInput.focus();
this.queryInput.select();
} else if (event.key === '0') this.fit();
else if (event.key === 'Escape') {
this.cy.elements().unselect();
this.showEmptySide();
this.help.hidden = true;
}
});
let resizeTimer: number | undefined;
window.addEventListener('resize', () => {
this.cy.resize();
window.clearTimeout(resizeTimer);
resizeTimer = window.setTimeout(() => this.cy.fit(this.cy.elements().not('.hidden'), 40), 150);
});
new MutationObserver(() => this.restyle()).observe(document.body, { attributes: true, attributeFilter: ['class'] });
window.addEventListener('message', (event) => {
const message = event.data || {};
if (message.type === 'graph' && message.graph) this.replace(message.graph as ModelGraph);
if (message.type === 'query' && typeof message.query === 'string') this.setQuery(message.query);
});
}
private save(): void {
this.host.setState({ graphView: { query: this.saved.query, labels: this.saved.labels, hidden: this.saved.hidden ?? [], theme: this.saved.theme, layout: this.saved.layout, links: this.saved.links } });
}
}
/** The theme the Archify diagram pages last used, when they stored one. */
function archifyThemePreference(): Theme | undefined {
try {
const value = localStorage.getItem('archify-theme');
return value === 'dark' || value === 'light' ? value : undefined;
} catch {
return undefined;
}
}
function start(): void {
const host = window.__archifyHost;
if (!host?.graph) return;
// Exposed for the integration harness; nothing in the page depends on it.
(window as unknown as { __archifyGraphPage?: GraphPage }).__archifyGraphPage = new GraphPage(host, host.graph);
}
if (document.readyState === 'loading') document.addEventListener('DOMContentLoaded', start);
else start();
+88
View File
@@ -0,0 +1,88 @@
import type { GraphEdge, GraphNode } from '../model/graph';
/**
* Layered layout: a column per element type in Archify's stack order
* (clients on the left, data on the right), empty columns left out, rows
* ordered to shorten the connections; registries in a row above the
* columns, decisions in a row below. Deterministic, so the picture is stable.
*/
const COLUMN_ORDER = ['external', 'frontend', 'cloud', 'security', 'backend', 'other', 'messagebus', 'database'];
const STATUS_ORDER = ['accepted', 'proposed', 'superseded', 'rejected'];
export interface LayoutOptions {
columnGap: number;
rowGap: number;
}
export type Positions = Map<string, { x: number; y: number }>;
function columnOf(node: GraphNode): number {
if (node.kind === 'registry') return -1;
if (node.kind === 'decision') return COLUMN_ORDER.length;
const i = COLUMN_ORDER.indexOf(node.type ?? 'other');
return i < 0 ? COLUMN_ORDER.indexOf('other') : i;
}
export function layeredLayout(nodes: GraphNode[], edges: GraphEdge[], options: LayoutOptions = { columnGap: 230, rowGap: 84 }): Positions {
const columns = new Map<number, GraphNode[]>();
const registries = nodes.filter((n) => n.kind === 'registry').sort((a, b) => a.label.localeCompare(b.label));
const decisions = nodes.filter((n) => n.kind === 'decision').sort((a, b) => STATUS_ORDER.indexOf(a.status ?? '') - STATUS_ORDER.indexOf(b.status ?? '') || a.label.localeCompare(b.label));
for (const n of nodes) if (n.kind === 'element') columns.set(columnOf(n), [...(columns.get(columnOf(n)) ?? []), n]);
const order = new Map<string, number>();
const neighbours = new Map<string, string[]>();
for (const e of edges) {
if (e.kind === 'supersedes') continue;
neighbours.set(e.from, [...(neighbours.get(e.from) ?? []), e.to]);
neighbours.set(e.to, [...(neighbours.get(e.to) ?? []), e.from]);
}
// Start from a stable order: elements by label, decisions by status, registries by file.
for (const [col, list] of columns) {
list.sort((a, b) => {
if (a.kind === 'decision' && b.kind === 'decision') return STATUS_ORDER.indexOf(a.status ?? '') - STATUS_ORDER.indexOf(b.status ?? '') || a.label.localeCompare(b.label);
return a.label.localeCompare(b.label);
});
list.forEach((n, i) => order.set(n.id, i));
columns.set(col, list);
}
// Barycenter sweeps: each node moves towards the average row of what it is connected to.
const keys = [...columns.keys()].sort((a, b) => a - b);
for (let sweep = 0; sweep < 4; sweep += 1) {
const sequence = sweep % 2 === 0 ? keys : [...keys].reverse();
for (const col of sequence) {
const list = columns.get(col)!;
const weight = new Map<string, number>();
for (const n of list) {
const rows = (neighbours.get(n.id) ?? []).map((id) => order.get(id)).filter((r): r is number => r !== undefined);
weight.set(n.id, rows.length ? rows.reduce((a, b) => a + b, 0) / rows.length : order.get(n.id)!);
}
list.sort((a, b) => weight.get(a.id)! - weight.get(b.id)! || order.get(a.id)! - order.get(b.id)!);
list.forEach((n, i) => order.set(n.id, i));
}
}
const positions: Positions = new Map();
const tallest = Math.max(1, ...[...columns.values()].map((list) => list.length));
// Empty columns are left out, so the picture is as wide as the types the model uses.
const used = keys.filter((col) => columns.get(col)!.length);
used.forEach((col, index) => {
const list = columns.get(col)!;
const offset = ((tallest - list.length) * options.rowGap) / 2;
list.forEach((n, i) => positions.set(n.id, { x: index * options.columnGap, y: offset + i * options.rowGap }));
});
const width = Math.max(0, used.length - 1) * options.columnGap;
// Registries and decisions sit above or below the elements they link to: at the mean x of those
// elements, pushed apart only as far as needed so they do not overlap.
const spread = (list: GraphNode[], y: number, gap: number) => {
const wanted = list.map((n) => {
const xs = (neighbours.get(n.id) ?? []).map((id) => positions.get(id)?.x).filter((x): x is number => x !== undefined);
return { n, x: xs.length ? xs.reduce((a, b) => a + b, 0) / xs.length : width / 2 };
});
wanted.sort((a, b) => a.x - b.x || a.n.label.localeCompare(b.n.label));
for (let i = 1; i < wanted.length; i += 1) wanted[i].x = Math.max(wanted[i].x, wanted[i - 1].x + gap);
for (let i = wanted.length - 2; i >= 0; i -= 1) wanted[i].x = Math.min(wanted[i].x, wanted[i + 1].x - gap);
for (const { n, x } of wanted) positions.set(n.id, { x, y });
};
spread(registries, -options.rowGap * 1.6, 200);
spread(decisions, tallest * options.rowGap + options.rowGap * 0.6, 250);
return positions;
}
+95
View File
@@ -0,0 +1,95 @@
/** Page styles of the graph view. VS Code's theme variables, Archify's type colours. */
export const GRAPH_PAGE_STYLE = `
:root { --ag-bg: var(--vscode-editor-background, #0b1020); --ag-fg: var(--vscode-foreground, #e5e7eb); --ag-muted: var(--vscode-descriptionForeground, #9ca3af);
--ag-panel: var(--vscode-editorWidget-background, #111a2e); --ag-border: var(--vscode-editorWidget-border, rgba(128,128,128,.35)); --ag-accent: var(--vscode-textLink-foreground, #22d3ee);
--ag-input: var(--vscode-input-background, #1f2937); --ag-input-fg: var(--vscode-input-foreground, #e5e7eb); --ag-input-border: var(--vscode-input-border, var(--ag-border));
--ag-error: var(--vscode-errorForeground, #f87171); --ag-font: var(--vscode-font-family, system-ui, sans-serif); --ag-mono: var(--vscode-editor-font-family, ui-monospace, Menlo, monospace);
--ag-frontend: #22d3ee; --ag-backend: #34d399; --ag-database: #a78bfa; --ag-cloud: #fbbf24; --ag-security: #fb7185; --ag-messagebus: #fb923c; --ag-external: #94a3b8; --ag-decision: #e879f9; --ag-registry: #cbd5e1; }
/* A theme chosen on the page overrides VS Code's; without one the VS Code variables above apply. */
:root[data-theme="dark"] { --ag-bg: #0b1020; --ag-fg: #e5e7eb; --ag-muted: #9ca3af; --ag-panel: #111a2e; --ag-border: rgba(148, 163, 184, 0.28); --ag-accent: #22d3ee; --ag-input: #0f172a; --ag-input-fg: #e5e7eb; --ag-input-border: rgba(148, 163, 184, 0.28); --ag-error: #f87171; color-scheme: dark; }
:root[data-theme="light"] { --ag-bg: #ffffff; --ag-fg: #0f172a; --ag-muted: #64748b; --ag-panel: #f8fafc; --ag-border: rgba(15, 23, 42, 0.14); --ag-accent: #0e7490; --ag-input: #ffffff; --ag-input-fg: #0f172a; --ag-input-border: rgba(15, 23, 42, 0.2); --ag-error: #b91c1c; --ag-external: #64748b; --ag-registry: #94a3b8; color-scheme: light; }
html, body { margin: 0; height: 100%; overflow: hidden; background: var(--ag-bg); color: var(--ag-fg); font-family: var(--ag-font); font-size: 13px; }
:root { --ag-gutter: 1.5rem; }
.ag { display: grid; grid-template-rows: auto minmax(0, 1fr); height: 100%; }
/* One head block: title row and query row share a background and a single rule below. */
.ag-head { background: color-mix(in srgb, var(--ag-panel) 55%, var(--ag-bg)); border-bottom: 1px solid var(--ag-border); }
.ag-top { display: flex; align-items: center; gap: 1rem; padding: 1.1rem var(--ag-gutter) 0.6rem; }
.ag-kicker { font-size: 0.6875rem; font-weight: 700; letter-spacing: 0.12em; text-transform: uppercase; color: var(--ag-accent); margin-bottom: 0.2rem; }
.ag-name { font-weight: 700; font-size: 1.25rem; line-height: 1.2; letter-spacing: -0.015em; }
.ag-actions { margin-left: auto; display: flex; align-items: center; gap: 0.5rem; }
.ag-bar .ag-button { min-height: 2rem; }
/* Toolbar controls follow Archify's: quiet pills (0.5rem) inside 0.5625rem buttons, one filled primary action (0.6875rem), the 2D | 3D switch's twin. */
.ag-switch { position: relative; isolation: isolate; display: inline-flex; padding: 0 0.25rem; border: 0; border-radius: 0.5625rem; background: transparent; color: var(--ag-muted); font: inherit; }
.ag-switch::before { content: ""; position: absolute; z-index: -1; inset: 0.25rem 0; border-radius: 0.6875rem; background: color-mix(in srgb, var(--ag-panel) 78%, transparent); box-shadow: inset 0 0 0 1px color-mix(in srgb, var(--ag-border) 85%, transparent), 0 1px 2px rgba(15, 23, 42, 0.04); }
.ag-switch:hover::before { box-shadow: inset 0 0 0 1px color-mix(in srgb, var(--ag-fg) 22%, transparent), 0 1px 2px rgba(15, 23, 42, 0.04); }
.ag-seg { display: inline-flex; align-items: center; height: 1.75rem; margin: 0.25rem 0; padding: 0 0.7rem; border: 0; border-radius: 0.5rem; background: transparent; color: inherit; font: inherit; font-weight: 550; font-size: 0.8125rem; cursor: pointer; transition: background 0.15s, color 0.15s; }
.ag-seg.on { cursor: default; }
.ag-seg:focus-visible { outline: 2px solid var(--ag-accent); outline-offset: 1px; }
.ag-seg.on { color: var(--ag-bg); background: var(--ag-fg); box-shadow: 0 1px 2px rgba(15, 23, 42, 0.12), 0 6px 16px -8px rgba(15, 23, 42, 0.4); }
.ag-seg:hover:not(.on) { color: var(--ag-fg); }
.ag-button { position: relative; isolation: isolate; display: inline-flex; align-items: center; gap: 0.4rem; font: inherit; font-size: 0.8125rem; font-weight: 500; min-height: 2.25rem; padding: 0.25rem 0.58rem; border-radius: 0.5625rem; border: 0; background: transparent; color: var(--ag-muted); cursor: pointer; white-space: nowrap; transition: color 0.15s; }
.ag-button::before { content: ""; position: absolute; z-index: -1; inset: 0.25rem 0; border-radius: 0.5rem; background: transparent; transition: background 0.15s, box-shadow 0.15s; }
.ag-button:hover { color: var(--ag-fg); }
.ag-button:hover::before { background: color-mix(in srgb, var(--ag-fg) 6%, transparent); }
.ag-button[aria-pressed="true"] { color: var(--ag-fg); }
.ag-button[aria-pressed="true"]::before { background: color-mix(in srgb, var(--ag-fg) 8%, transparent); box-shadow: inset 0 0 0 1px color-mix(in srgb, var(--ag-fg) 14%, transparent); }
.ag-button:focus-visible { outline: 2px solid var(--ag-accent); outline-offset: -4px; }
.ag-primary { color: var(--ag-bg); font-weight: 600; padding: 0.25rem 0.9rem; }
.ag-primary::before { inset: 0.25rem 0; border-radius: 0.6875rem; background: var(--ag-fg); box-shadow: 0 1px 2px rgba(15, 23, 42, 0.12), 0 6px 16px -8px rgba(15, 23, 42, 0.4); }
.ag-primary:hover { color: var(--ag-bg); }
.ag-primary:hover::before { background: color-mix(in srgb, var(--ag-fg) 86%, var(--ag-bg)); }
/* Theme toggle: Archify's own, a pill track with a knob that slides and carries the sun or moon. */
.ag-theme { width: 4rem; padding: 0; justify-content: center; }
/* The same outer pill as the Model | Graph switch and Export, so the three line up; Archify's track and knob inside it. */
.ag-theme::before { inset: 0.25rem 0; border-radius: 0.6875rem; background: color-mix(in srgb, var(--ag-panel) 78%, transparent); box-shadow: inset 0 0 0 1px color-mix(in srgb, var(--ag-border) 85%, transparent), 0 1px 2px rgba(15, 23, 42, 0.04); }
.ag-theme:hover::before { background: color-mix(in srgb, var(--ag-panel) 78%, transparent); box-shadow: inset 0 0 0 1px color-mix(in srgb, var(--ag-fg) 22%, transparent), 0 1px 2px rgba(15, 23, 42, 0.04); }
.ag-theme-track { position: absolute; z-index: 0; inset: 0.6875rem 0.5625rem; border-radius: 999px; background: color-mix(in srgb, var(--ag-fg) 9%, transparent); box-shadow: inset 0 1px 2px rgba(15, 23, 42, 0.08); transition: background 0.15s; }
.ag-theme:hover .ag-theme-track { background: color-mix(in srgb, var(--ag-fg) 13%, transparent); }
.ag-theme::after { content: ""; position: absolute; z-index: 1; top: 50%; left: 0.6875rem; width: 1.125rem; height: 1.125rem; border-radius: 50%; background: var(--ag-panel); box-shadow: 0 1px 2px rgba(15, 23, 42, 0.18), 0 2px 6px rgba(15, 23, 42, 0.12); transform: translateY(-50%); transition: left 0.22s cubic-bezier(0.22, 1, 0.36, 1); }
.ag-theme[data-on="dark"] .ag-theme-track { background: rgba(148, 163, 184, 0.16); }
.ag-theme[data-on="dark"]::after { left: calc(100% - 0.6875rem - 1.125rem); background: #3b4a63; box-shadow: 0 1px 3px rgba(0, 0, 0, 0.4); }
.ag-theme-icon { position: absolute; z-index: 2; top: 50%; left: calc(0.6875rem + 0.1875rem); width: 0.75rem; height: 0.75rem; color: var(--ag-cloud); background: currentColor; transform: translateY(-50%); transition: left 0.22s cubic-bezier(0.22, 1, 0.36, 1); -webkit-mask: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 20 20'%3E%3Cg fill='none' stroke='black' stroke-width='1.7' stroke-linecap='round'%3E%3Ccircle cx='10' cy='10' r='3.1'/%3E%3Cpath d='M10 2.2v1.4M10 16.4v1.4M2.2 10h1.4M16.4 10h1.4M4.5 4.5l1 1M14.5 14.5l1 1M15.5 4.5l-1 1M5.5 14.5l-1 1'/%3E%3C/g%3E%3C/svg%3E") center / contain no-repeat; mask: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 20 20'%3E%3Cg fill='none' stroke='black' stroke-width='1.7' stroke-linecap='round'%3E%3Ccircle cx='10' cy='10' r='3.1'/%3E%3Cpath d='M10 2.2v1.4M10 16.4v1.4M2.2 10h1.4M16.4 10h1.4M4.5 4.5l1 1M14.5 14.5l1 1M15.5 4.5l-1 1M5.5 14.5l-1 1'/%3E%3C/g%3E%3C/svg%3E") center / contain no-repeat; }
.ag-theme[data-on="dark"] .ag-theme-icon { left: calc(100% - 0.6875rem - 1.125rem + 0.1875rem); color: #c7d2fe; -webkit-mask-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 20 20'%3E%3Cpath d='M15.2 12.7A6.3 6.3 0 017.3 4.8a6.3 6.3 0 107.9 7.9Z' fill='none' stroke='black' stroke-width='1.7' stroke-linejoin='round'/%3E%3C/svg%3E"); mask-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 20 20'%3E%3Cpath d='M15.2 12.7A6.3 6.3 0 017.3 4.8a6.3 6.3 0 107.9 7.9Z' fill='none' stroke='black' stroke-width='1.7' stroke-linejoin='round'/%3E%3C/svg%3E"); }
.ag-sr { position: absolute; width: 1px; height: 1px; overflow: hidden; clip: rect(0 0 0 0); white-space: nowrap; }
.ag-bar { display: flex; align-items: center; gap: 0.5rem; padding: 0.35rem var(--ag-gutter) 0.9rem; flex-wrap: wrap; }
.ag-query-wrap { flex: 1 1 18rem; display: flex; align-items: center; gap: 0.5rem; min-width: 0; background: var(--ag-input); border: 1px solid var(--ag-input-border); border-radius: 0.5625rem; padding: 0 0.6rem; }
.ag-query-wrap:focus-within { border-color: var(--ag-accent); }
.ag-query { flex: 1; min-width: 0; height: 2.125rem; border: 0; background: transparent; color: var(--ag-input-fg); font-family: var(--ag-mono); font-size: 0.875rem; outline: none; }
.ag-query::placeholder { color: var(--ag-muted); opacity: 0.8; }
.ag-clear { border: 0; background: transparent; color: var(--ag-muted); font-size: 1rem; cursor: pointer; padding: 0 0.1rem; }
.ag-clear:hover { color: var(--ag-fg); }
.ag-count { font-family: var(--ag-mono); font-size: 0.8125rem; color: var(--ag-muted); white-space: nowrap; margin: 0 0.35rem 0 0.25rem; }
.ag-count.is-error { color: var(--ag-error); }
.ag-main { position: relative; display: grid; grid-template-columns: minmax(0, 1fr) 20rem; min-height: 0; }
.ag-main.is-side-hidden { grid-template-columns: minmax(0, 1fr); }
.ag-canvas { position: relative; min-width: 0; min-height: 0; }
.ag-cy { position: absolute; inset: 0; }
.ag-legend { position: absolute; left: var(--ag-gutter); bottom: 1rem; display: flex; align-items: center; gap: 0.4rem; flex-wrap: wrap; z-index: 2; max-width: calc(100% - 2 * var(--ag-gutter)); }
.ag-chip { display: inline-flex; align-items: center; gap: 0.4rem; font: inherit; font-size: 0.75rem; padding: 0.2rem 0.6rem; border-radius: 999px; border: 1px solid var(--ag-border); background: color-mix(in srgb, var(--ag-panel) 85%, transparent); color: var(--ag-fg); cursor: pointer; backdrop-filter: blur(6px); }
.ag-chip::before { content: ""; width: 0.55rem; height: 0.55rem; border-radius: 2px; background: var(--c); }
.ag-chip[aria-pressed="false"] { opacity: 0.45; text-decoration: line-through; }
.ag-chip small { color: var(--ag-muted); font-family: var(--ag-mono); }
.ag-side { border-left: 1px solid var(--ag-border); background: var(--ag-panel); overflow: auto; padding: 1.1rem var(--ag-gutter) 1.5rem; min-width: 0; }
.ag-side h2 { margin: 0; font-size: 1.0625rem; font-weight: 700; display: flex; align-items: center; gap: 0.5rem; }
.ag-dot { display: inline-block; width: 0.6rem; height: 0.6rem; border-radius: 50%; background: var(--c, var(--ag-external)); flex: none; }
.ag-id { font-family: var(--ag-mono); color: var(--ag-muted); font-size: 0.75rem; margin: 0.25rem 0 0.8rem; word-break: break-all; }
.ag-side p { margin: 0 0 0.8rem; line-height: 1.5; white-space: pre-line; }
.ag-side h3 { margin: 0.9rem 0 0.4rem; font-size: 0.6875rem; letter-spacing: 0.1em; text-transform: uppercase; color: var(--ag-muted); font-weight: 700; }
.ag-link { display: inline-flex; align-items: baseline; gap: 0.35rem; line-height: 1.4; font: inherit; font-family: var(--ag-mono); font-size: 0.75rem; padding: 0.15rem 0.55rem; margin: 0 0.3rem 0.35rem 0; border: 1px solid var(--ag-border); border-radius: 999px; background: transparent; color: var(--ag-fg); cursor: pointer; text-align: left; max-width: 100%; }
.ag-link:hover { border-color: var(--ag-accent); }
.ag-link.is-static { cursor: default; }
.ag-link.is-static:hover { border-color: var(--ag-border); }
.ag-link.is-accepted .ag-dot { background: var(--ag-backend); } .ag-link.is-proposed .ag-dot { background: var(--ag-cloud); } .ag-link.is-rejected .ag-dot { background: var(--ag-security); } .ag-link.is-superseded .ag-dot { background: var(--ag-external); }
.ag-empty { color: var(--ag-muted); }
.ag-side-actions { display: flex; flex-wrap: wrap; gap: 0.4rem; margin-top: 0.6rem; }
.ag-help { position: absolute; top: 0.5rem; right: 20.75rem; z-index: 5; width: min(26rem, calc(100% - 2rem)); max-height: calc(100% - 1rem); overflow: auto; padding: 0.9rem 1rem; border: 1px solid var(--ag-border); border-radius: 0.6875rem; background: var(--ag-panel); box-shadow: 0 16px 40px rgba(0,0,0,.35); }
.ag-main.is-side-hidden .ag-help { right: 0.75rem; }
.ag-help h3 { margin: 0 0 0.5rem; font-size: 0.8125rem; }
.ag-help table { border-collapse: collapse; width: 100%; font-size: 0.8125rem; }
.ag-help td { padding: 0.25rem 0.4rem 0.25rem 0; vertical-align: top; border-top: 1px solid var(--ag-border); }
.ag-help td:first-child { font-family: var(--ag-mono); white-space: nowrap; color: var(--ag-accent); cursor: pointer; }
.ag-help td:first-child:hover { text-decoration: underline; }
.ag-help p { margin: 0.6rem 0 0; color: var(--ag-muted); font-size: 0.75rem; }
@media (max-width: 760px) { .ag-main { grid-template-columns: minmax(0, 1fr); grid-template-rows: minmax(0, 1fr) auto; } .ag-side { border-left: 0; border-top: 1px solid var(--ag-border); max-height: 40%; } .ag-help { right: 0.75rem; } }
`;
+102
View File
@@ -0,0 +1,102 @@
import * as vscode from 'vscode';
import { Decision, DECISION_STATUSES, effectiveStatus, isDecisionFile } from '../model/decisions';
import { ModelIndex, ModelService } from '../model/service';
/** Diagrams (decisions: […]) and decision files (elements: […], diagrams: […], supersedes: […]). */
export const DECISION_SELECTOR: vscode.DocumentSelector = [{ pattern: '**/*.archify' }, { pattern: '**/*.archify-decision' }];
type ListKey = 'decisions' | 'elements' | 'diagrams' | 'supersedes';
/** Which list the cursor is in on a `key: [a, b, …` line, and what has been typed of the current item. */
export function listValueAt(linePrefix: string, fileName: string): { key: ListKey; typed: string } | undefined {
const keys = isDecisionFile(fileName) ? ['elements', 'diagrams', 'supersedes'] : ['decisions'];
const match = new RegExp(`(?:^|[\\s{,])(${keys.join('|')}):\\s*\\[([^\\]]*)$`).exec(linePrefix);
if (match) {
const items = match[2].split(',');
return { key: match[1] as ListKey, typed: items[items.length - 1].replace(/^[\s"']+/, '') };
}
// Block list item under the key: " - 00" (the key is on a line above; the caller checks).
return undefined;
}
/** The list item under a position on a flow-list line, with its range. */
export function listItemAt(line: string, character: number, fileName: string): { key: ListKey; value: string; start: number; end: number } | undefined {
const keys = isDecisionFile(fileName) ? ['elements', 'diagrams', 'supersedes'] : ['decisions'];
const match = new RegExp(`(?:^|[\\s{,])(${keys.join('|')}):\\s*\\[([^\\]]*)\\]?`).exec(line);
if (!match) return undefined;
const listStart = match.index + match[0].indexOf('[') + 1;
const re = /[^,\s"'\]]+/g;
const inner = match[2];
let m: RegExpExecArray | null;
while ((m = re.exec(inner))) {
const start = listStart + m.index;
const end = start + m[0].length;
if (character >= start && character <= end) return { key: match[1] as ListKey, value: m[0], start, end };
}
return undefined;
}
function describeDecision(d: Decision, index: ModelIndex): vscode.MarkdownString {
const md = new vscode.MarkdownString();
const { status, supersededBy } = effectiveStatus(d, index.decisions.decisions);
md.appendMarkdown(`**${d.id}**${d.title ? ` · ${d.title}` : ''} \`${status}\`${supersededBy ? ` by ${supersededBy}` : ''}${d.date ? ` · ${d.date}` : ''}\n\n`);
if (d.decision) md.appendMarkdown(`${d.decision.trim()}\n\n`);
md.appendMarkdown(`*${d.file}*`);
return md;
}
/** Completion, hover and go-to-definition for decision ids in diagrams and for links inside decision files. */
export class DecisionLanguage implements vscode.CompletionItemProvider, vscode.HoverProvider, vscode.DefinitionProvider {
constructor(private readonly models: ModelService) {}
async provideCompletionItems(document: vscode.TextDocument, position: vscode.Position): Promise<vscode.CompletionItem[] | undefined> {
const at = listValueAt(document.lineAt(position.line).text.slice(0, position.character), document.fileName);
if (!at) return undefined;
const index = await this.models.indexFor(document.uri);
if (!index) return undefined;
const range = new vscode.Range(position.translate(0, -at.typed.length), position);
const item = (label: string, description: string | undefined, detail: string, doc?: vscode.MarkdownString) => {
const it = new vscode.CompletionItem({ label, description }, vscode.CompletionItemKind.Reference);
it.detail = detail;
it.documentation = doc;
it.filterText = `${label} ${description ?? ''}`;
it.range = range;
return it;
};
if (at.key === 'decisions' || at.key === 'supersedes') {
return [...index.decisions.decisions.values()].map((d) => item(d.id, d.title, effectiveStatus(d, index.decisions.decisions).status, describeDecision(d, index)));
}
if (at.key === 'elements') {
return [...index.registry.elements.values()].map((e) => item(e.id, e.label, [e.type, e.sublabel].filter(Boolean).join(' · ')));
}
return index.diagrams.map((d) => item(d.relativePath, d.title, d.kind ?? 'diagram'));
}
async provideHover(document: vscode.TextDocument, position: vscode.Position): Promise<vscode.Hover | undefined> {
const hit = listItemAt(document.lineAt(position.line).text, position.character, document.fileName);
if (!hit || (hit.key !== 'decisions' && hit.key !== 'supersedes')) return undefined;
const index = await this.models.indexFor(document.uri);
const range = new vscode.Range(position.line, hit.start, position.line, hit.end);
const d = index?.decisions.decisions.get(hit.value);
if (!index) return new vscode.Hover(`\`${hit.value}\` cannot be resolved: this file is not inside a model.`, range);
if (!d) return new vscode.Hover(`Unknown decision \`${hit.value}\`: no .archify-decision file of this model defines it.`, range);
return new vscode.Hover(describeDecision(d, index), range);
}
async provideDefinition(document: vscode.TextDocument, position: vscode.Position): Promise<vscode.Location | undefined> {
const hit = listItemAt(document.lineAt(position.line).text, position.character, document.fileName);
if (!hit) return undefined;
const index = await this.models.indexFor(document.uri);
if (!index) return undefined;
if (hit.key === 'decisions' || hit.key === 'supersedes') {
const d = index.decisions.decisions.get(hit.value);
return d ? new vscode.Location(vscode.Uri.joinPath(index.root, ...d.file.split('/')), new vscode.Position(d.lines.id, 2)) : undefined;
}
if (hit.key === 'elements') {
const e = index.registry.elements.get(hit.value);
return e ? new vscode.Location(vscode.Uri.joinPath(index.root, ...e.file.split(/[\\/]/)), new vscode.Position(e.line, 2)) : undefined;
}
const diagram = index.diagrams.find((d) => d.relativePath === hit.value);
return diagram ? new vscode.Location(vscode.Uri.joinPath(index.root, ...diagram.relativePath.split('/')), new vscode.Position(0, 0)) : undefined;
}
}
+118 -9
View File
@@ -2,9 +2,15 @@ import { parse, ParseError } from 'jsonc-parser';
import * as vscode from 'vscode'; import * as vscode from 'vscode';
import { ArchifyDiagnostic, isEvidenceError, validate } from '../archify/cli'; import { ArchifyDiagnostic, isEvidenceError, validate } from '../archify/cli';
import { evidenceMode, runtimeFor } from '../archify/runtime'; import { evidenceMode, runtimeFor } from '../archify/runtime';
import { isArchifyFile, readDiagramSource } from '../sources/detect'; import { ModelProblem, isRegistryFile, parseRegistry } from '../model/format';
import { isDecisionFile, parseDecision } from '../model/decisions';
import { prepareDiagram } from '../model/prepare';
import { ModelService } from '../model/service';
import { isArchifyFile } from '../sources/detect';
import { log } from '../util/log'; import { log } from '../util/log';
import path from 'node:path';
import { diagnosticPointer, rangeForPointer, rangeForPointerYaml, yamlSyntaxProblems } from './jsonPointer'; import { diagnosticPointer, rangeForPointer, rangeForPointerYaml, yamlSyntaxProblems } from './jsonPointer';
import { DIAGRAM_SCHEMA, REGISTRY_SCHEMA, SchemaChecker, SchemaProblem, readSchemas } from './schemaCheck';
const JSON_LANGUAGES = new Set(['json', 'jsonc']); const JSON_LANGUAGES = new Set(['json', 'jsonc']);
@@ -28,10 +34,15 @@ export class DiagnosticsController implements vscode.Disposable {
private readonly timers = new Map<string, NodeJS.Timeout>(); private readonly timers = new Map<string, NodeJS.Timeout>();
private readonly sequence = new Map<string, number>(); private readonly sequence = new Map<string, number>();
private readonly disposables: vscode.Disposable[]; private readonly disposables: vscode.Disposable[];
private checker: SchemaChecker | undefined;
constructor(private readonly context: vscode.ExtensionContext) { constructor(
private readonly context: vscode.ExtensionContext,
private readonly models: ModelService,
) {
this.disposables = [ this.disposables = [
this.collection, this.collection,
models.onDidChangeModel(() => this.revalidateAll()),
vscode.workspace.onDidOpenTextDocument((doc) => this.schedule(doc, 0)), vscode.workspace.onDidOpenTextDocument((doc) => this.schedule(doc, 0)),
vscode.workspace.onDidChangeTextDocument((event) => { vscode.workspace.onDidChangeTextDocument((event) => {
if (event.contentChanges.length) this.schedule(event.document, 700); if (event.contentChanges.length) this.schedule(event.document, 700);
@@ -45,6 +56,22 @@ export class DiagnosticsController implements vscode.Disposable {
this.revalidateAll(); this.revalidateAll();
} }
/** Our schemas, compiled on first use. */
private schemas(): SchemaChecker {
this.checker ??= new SchemaChecker(readSchemas(vscode.Uri.joinPath(this.context.extensionUri, 'schemas').fsPath));
return this.checker;
}
private schemaDiagnostic(doc: vscode.TextDocument, problem: SchemaProblem): vscode.Diagnostic {
const diagnostic = new vscode.Diagnostic(
new vscode.Range(doc.positionAt(problem.from), doc.positionAt(problem.to)),
problem.message,
vscode.DiagnosticSeverity.Error,
);
diagnostic.source = 'archify';
return diagnostic;
}
private enabled(uri: vscode.Uri): boolean { private enabled(uri: vscode.Uri): boolean {
return vscode.workspace.getConfiguration('archify', uri).get<boolean>('validation.enabled', true); return vscode.workspace.getConfiguration('archify', uri).get<boolean>('validation.enabled', true);
} }
@@ -62,7 +89,7 @@ export class DiagnosticsController implements vscode.Disposable {
} }
private schedule(doc: vscode.TextDocument, delay: number): void { private schedule(doc: vscode.TextDocument, delay: number): void {
if (!JSON_LANGUAGES.has(doc.languageId) && !isArchifyFile(doc.fileName)) return; if (!JSON_LANGUAGES.has(doc.languageId) && !isArchifyFile(doc.fileName) && !isRegistryFile(doc.fileName) && !isDecisionFile(doc.fileName)) return;
const key = doc.uri.toString(); const key = doc.uri.toString();
clearTimeout(this.timers.get(key)); clearTimeout(this.timers.get(key));
this.timers.set(key, setTimeout(() => void this.validate(doc), delay)); this.timers.set(key, setTimeout(() => void this.validate(doc), delay));
@@ -79,6 +106,14 @@ export class DiagnosticsController implements vscode.Disposable {
this.collection.delete(doc.uri); this.collection.delete(doc.uri);
return; return;
} }
if (isRegistryFile(doc.fileName)) {
await this.validateRegistry(doc, seq);
return;
}
if (isDecisionFile(doc.fileName)) {
await this.validateDecision(doc, seq);
return;
}
if (isArchifyFile(doc.fileName)) { if (isArchifyFile(doc.fileName)) {
// Nothing else reports YAML syntax errors in .archify files, and a file // Nothing else reports YAML syntax errors in .archify files, and a file
// that does not parse has no diagram to validate yet. // that does not parse has no diagram to validate yet.
@@ -99,11 +134,16 @@ export class DiagnosticsController implements vscode.Disposable {
return; return;
} }
} }
const source = readDiagramSource(text, doc.fileName); const prepared = await prepareDiagram(this.models, doc.uri, text);
if (!source) { if (seq !== this.sequence.get(key) || doc.isClosed) return;
if (!prepared) {
this.collection.delete(doc.uri); this.collection.delete(doc.uri);
return; return;
} }
const source = prepared.source;
const modelDiagnostics = prepared.problems
.filter((problem) => !problem.file)
.map((problem) => this.modelDiagnostic(doc, text, source.format, problem));
if (source.format === 'json') { if (source.format === 'json') {
// Leave JSON syntax errors to the JSON language service. // Leave JSON syntax errors to the JSON language service.
const syntax: ParseError[] = []; const syntax: ParseError[] = [];
@@ -114,6 +154,17 @@ export class DiagnosticsController implements vscode.Disposable {
} }
} }
if (isArchifyFile(doc.fileName)) {
// The schema check sees the source as written and answers at once; a
// file that fails it would fail archify validate the same way, so that
// runs only on files the schema accepts.
const schemaProblems = this.schemas().check(text, DIAGRAM_SCHEMA);
if (schemaProblems.length) {
this.collection.set(doc.uri, [...modelDiagnostics, ...schemaProblems.map((problem) => this.schemaDiagnostic(doc, problem))]);
return;
}
}
try { try {
const runtime = await runtimeFor(this.context, doc.uri); const runtime = await runtimeFor(this.context, doc.uri);
const result = await validate(runtime, source.type, source.json); const result = await validate(runtime, source.type, source.json);
@@ -131,9 +182,9 @@ export class DiagnosticsController implements vscode.Disposable {
} }
const downgradeEvidence = evidenceMode(doc.uri) === 'fallback'; const downgradeEvidence = evidenceMode(doc.uri) === 'fallback';
this.collection.set( this.collection.set(doc.uri, [
doc.uri, ...modelDiagnostics,
result.diagnostics.map((item) => { ...result.diagnostics.map((item) => {
const pointer = diagnosticPointer(item); const pointer = diagnosticPointer(item);
const offsets = source.format === 'yaml' ? rangeForPointerYaml(text, pointer) : rangeForPointer(text, pointer); const offsets = source.format === 'yaml' ? rangeForPointerYaml(text, pointer) : rangeForPointer(text, pointer);
const range = new vscode.Range(doc.positionAt(offsets.start), doc.positionAt(offsets.end)); const range = new vscode.Range(doc.positionAt(offsets.start), doc.positionAt(offsets.end));
@@ -147,12 +198,70 @@ export class DiagnosticsController implements vscode.Disposable {
if (item.code) diagnostic.code = item.code; if (item.code) diagnostic.code = item.code;
return diagnostic; return diagnostic;
}), }),
); ]);
} catch (error) { } catch (error) {
log().error(`Validation failed for ${doc.uri.fsPath}: ${error instanceof Error ? error.message : String(error)}`); log().error(`Validation failed for ${doc.uri.fsPath}: ${error instanceof Error ? error.message : String(error)}`);
} }
} }
private modelDiagnostic(doc: vscode.TextDocument, text: string, format: 'yaml' | 'json', problem: ModelProblem): vscode.Diagnostic {
const offsets = format === 'yaml' ? rangeForPointerYaml(text, problem.pointer) : rangeForPointer(text, problem.pointer);
const range = problem.line !== undefined && !problem.pointer ? doc.lineAt(Math.min(problem.line, doc.lineCount - 1)).range : new vscode.Range(doc.positionAt(offsets.start), doc.positionAt(offsets.end));
const diagnostic = new vscode.Diagnostic(range, problem.message, problem.severity === 'warning' ? vscode.DiagnosticSeverity.Warning : vscode.DiagnosticSeverity.Error);
diagnostic.source = 'archify';
return diagnostic;
}
/** A registry file: its own YAML and element problems, plus duplicates across the model. */
private async validateDecision(doc: vscode.TextDocument, seq: number): Promise<void> {
const text = doc.getText();
const root = await this.models.rootOf(doc.uri);
const rel = root ? path.relative(root.fsPath, doc.uri.fsPath).split(path.sep).join('/') : path.basename(doc.uri.fsPath);
const problems: ModelProblem[] = [...parseDecision(text, rel).problems];
if (root) {
try {
const index = await this.models.index(root);
for (const problem of index.decisions.problems) {
if (problem.file === rel && !problems.some((p) => p.message === problem.message)) problems.push(problem);
}
} catch {
// The index reports its own failures when the model page opens.
}
} else {
problems.push({ message: `This decision has lost its model: no main.archify above ${path.basename(doc.uri.fsPath)}, so its elements and diagrams cannot be resolved.`, severity: 'warning', line: 0 });
}
if (seq !== this.sequence.get(doc.uri.toString()) || doc.isClosed) return;
this.collection.set(doc.uri, problems.map((problem) => this.modelDiagnostic(doc, text, 'yaml', problem)));
}
private async validateRegistry(doc: vscode.TextDocument, seq: number): Promise<void> {
const text = doc.getText();
const root = await this.models.rootOf(doc.uri);
const rel = root ? path.relative(root.fsPath, doc.uri.fsPath) : path.basename(doc.uri.fsPath);
const problems: ModelProblem[] = [...parseRegistry(text, rel).problems];
// The schema adds what the parser does not check (types, unknown keys,
// ids); a file the parser already rejects as a whole gets no second opinion.
const shapeless = problems.some((p) => /not valid YAML|must be a mapping|needs an "elements" mapping/.test(p.message));
const schemaProblems = shapeless ? [] : this.schemas().check(text, REGISTRY_SCHEMA);
if (root) {
try {
const index = await this.models.index(root);
for (const problem of index.registry.problems) {
if (problem.file === rel && !problems.some((p) => p.message === problem.message)) problems.push(problem);
}
} catch {
// The index reports its own failures when the model page opens.
}
} else {
problems.push({ message: `This registry is not inside a model: no main.archify above ${path.basename(doc.uri.fsPath)}.`, severity: 'warning', line: 0 });
}
if (seq !== this.sequence.get(doc.uri.toString()) || doc.isClosed) return;
this.collection.set(doc.uri, [
...problems.map((problem) => this.modelDiagnostic(doc, text, 'yaml', problem)),
...schemaProblems.map((problem) => this.schemaDiagnostic(doc, problem)),
]);
}
dispose(): void { dispose(): void {
for (const timer of this.timers.values()) clearTimeout(timer); for (const timer of this.timers.values()) clearTimeout(timer);
for (const disposable of this.disposables.splice(0)) disposable.dispose(); for (const disposable of this.disposables.splice(0)) disposable.dispose();
+85
View File
@@ -0,0 +1,85 @@
import { DIAGRAM_SCHEMA, REGISTRY_SCHEMA } from './schemaCheck';
type Json = null | boolean | number | string | Json[] | { [key: string]: Json };
/**
* Schemas for completion and hover in the Source view. The editor's schema
* library reads one draft-07 document, while ours are 2020-12 files that
* refer to each other; so the referenced files are folded into `$defs` and
* 2020-12 tuples become draft-07 ones. Problems never come from these
* copies (the host checks with the originals), only suggestions.
*/
export class EditorSchemas {
private readonly cache = new Map<string, object>();
constructor(private readonly schemas: Record<string, object>) {}
/** The schema for a file kind; for diagrams the one of its diagram_type. */
forSource(kind: 'diagram' | 'registry' | 'decision', text: string): { key: string; schema: object } | undefined {
if (kind === 'decision') return undefined;
if (kind === 'registry') return this.get(REGISTRY_SCHEMA);
const type = /^diagram_type:\s*["']?([a-z]+)/m.exec(text)?.[1];
const name = type && this.schemas[`${type}.schema.json`] ? `${type}.schema.json` : DIAGRAM_SCHEMA;
return this.get(name);
}
private get(name: string): { key: string; schema: object } | undefined {
if (!this.schemas[name]) return undefined;
if (!this.cache.has(name)) this.cache.set(name, bundleSchema(this.schemas, name));
return { key: name, schema: this.cache.get(name)! };
}
}
const defKey = (file: string) => `file:${file}`;
/** One self-contained draft-07 shaped schema for `root` and every file it refers to. */
export function bundleSchema(schemas: Record<string, object>, root: string): object {
const files = new Set<string>([root]);
const queue = [root];
while (queue.length) {
const file = queue.shift()!;
for (const ref of refsOf(schemas[file] as Json)) {
const target = ref.split('#')[0];
if (target && !files.has(target) && schemas[target]) {
files.add(target);
queue.push(target);
}
}
}
const base = (file: string) => (file === root ? '#' : `#/$defs/${defKey(file)}`);
const rewrite = (node: Json, file: string): Json => {
if (Array.isArray(node)) return node.map((item) => rewrite(item, file));
if (!node || typeof node !== 'object') return node;
const out: { [key: string]: Json } = {};
for (const [key, value] of Object.entries(node)) {
if (key === '$ref' && typeof value === 'string') {
const [target, pointer = ''] = value.split('#');
out.$ref = `${base(target || file)}${pointer}`;
} else if (key !== '$schema' && key !== '$id') {
out[key] = rewrite(value, file);
}
}
if (out.prefixItems) {
if (out.items === false) out.additionalItems = false;
else if (out.items !== undefined) out.additionalItems = out.items;
out.items = out.prefixItems;
delete out.prefixItems;
}
return out;
};
const bundled = rewrite(schemas[root] as Json, root) as { [key: string]: Json };
const defs = { ...((bundled.$defs as { [key: string]: Json } | undefined) ?? {}) };
for (const file of files) if (file !== root) defs[defKey(file)] = rewrite(schemas[file] as Json, file);
return { ...bundled, $defs: defs };
}
function refsOf(node: Json, out: string[] = []): string[] {
if (Array.isArray(node)) node.forEach((item) => refsOf(item, out));
else if (node && typeof node === 'object') {
for (const [key, value] of Object.entries(node)) {
if (key === '$ref' && typeof value === 'string') out.push(value);
else refsOf(value, out);
}
}
return out;
}
+34
View File
@@ -0,0 +1,34 @@
import { parseDocument } from 'yaml';
import { modelIdFromName, titleFromName } from './templates';
/**
* Example models shipped with the extension (templates/models/<folder>).
* "Archify | New Model…" offers them; each is a complete model folder:
* main.archify, registry/*.archify-registry and diagrams by level.
*/
export interface ModelExample {
/** Folder under templates/models and the default name of the new model folder. */
folder: string;
label: string;
description: string;
}
export const MODEL_EXAMPLES: readonly ModelExample[] = [
{ folder: 'c4-standard-web-app', label: 'C4 - Standard Web App', description: 'Single-page app, API, database, cache, file storage, identity provider' },
{ folder: 'c4-e-shop', label: 'C4 - E-Shop', description: 'Web shop, API, worker, queue, payment and email providers' },
{ folder: 'c4-event-based-integration', label: 'C4 - Event-Based Integration', description: 'Event bus, router, dead-letter queue, event store, consumers' },
];
/**
* The example's main.archify for a new model folder. When the folder keeps
* the example's name the file is used as written; otherwise id, name and the
* overview title follow the folder name and the description is kept.
*/
export function mainFromExample(mainText: string, folderName: string, example: ModelExample): string {
if (folderName === example.folder) return mainText;
const doc = parseDocument(mainText);
doc.setIn(['model', 'id'], modelIdFromName(folderName));
doc.setIn(['model', 'name'], titleFromName(folderName));
if (doc.hasIn(['meta', 'title'])) doc.setIn(['meta', 'title'], `${titleFromName(folderName)} — overview`);
return doc.toString({ lineWidth: 0, flowCollectionPadding: false });
}
+72
View File
@@ -0,0 +1,72 @@
import * as vscode from 'vscode';
import { RegistryElement } from '../model/format';
import { ModelService } from '../model/service';
export const REF_SELECTOR: vscode.DocumentSelector = [{ pattern: '**/*.archify' }];
/** `ref: api` or `{ ref: ap` → what has been typed of the value. */
export function refValueAt(linePrefix: string): { typed: string } | undefined {
const match = /(?:^|[\s{,])ref:\s*["']?([\w.-]*)$/.exec(linePrefix);
return match ? { typed: match[1] } : undefined;
}
/** The `ref` value under a position, with its range, or undefined. */
export function refAt(line: string, character: number): { id: string; start: number; end: number } | undefined {
const match = /(?:^|[\s{,])ref:\s*["']?([\w.-]+)/.exec(line);
if (!match) return undefined;
const start = match.index + match[0].length - match[1].length;
const end = start + match[1].length;
return character >= start && character <= end ? { id: match[1], start, end } : undefined;
}
function describe(element: RegistryElement): vscode.MarkdownString {
const md = new vscode.MarkdownString();
md.appendMarkdown(`**${element.label ?? element.id}**${element.sublabel ? ` · ${element.sublabel}` : ''}${element.type ? ` \`${element.type}\`` : ''}\n\n`);
if (element.description) md.appendMarkdown(`${element.description.trim()}\n\n`);
if (element.diagram) md.appendMarkdown(`Opens: \`${element.diagram}\`\n\n`);
md.appendMarkdown(`*Defined in ${element.file}, line ${element.line + 1}*`);
return md;
}
/** Completion, hover and go-to-definition for `ref:` values in diagrams of a model. */
export class RefLanguage implements vscode.CompletionItemProvider, vscode.HoverProvider, vscode.DefinitionProvider {
constructor(private readonly models: ModelService) {}
async provideCompletionItems(document: vscode.TextDocument, position: vscode.Position): Promise<vscode.CompletionItem[] | undefined> {
const value = refValueAt(document.lineAt(position.line).text.slice(0, position.character));
if (!value) return undefined;
const found = await this.models.registryFor(document.uri);
if (!found) return undefined;
const range = new vscode.Range(position.translate(0, -value.typed.length), position);
return [...found.registry.elements.values()].map((element) => {
const item = new vscode.CompletionItem({ label: element.id, description: element.label }, vscode.CompletionItemKind.Reference);
item.detail = [element.label, element.sublabel, element.type].filter(Boolean).join(' · ');
item.documentation = describe(element);
item.filterText = [element.id, element.label ?? '', element.sublabel ?? ''].join(' ');
item.range = range;
return item;
});
}
async provideHover(document: vscode.TextDocument, position: vscode.Position): Promise<vscode.Hover | undefined> {
const ref = refAt(document.lineAt(position.line).text, position.character);
if (!ref) return undefined;
const found = await this.models.registryFor(document.uri);
const element = found?.registry.elements.get(ref.id);
const range = new vscode.Range(position.line, ref.start, position.line, ref.end);
if (!element) {
return new vscode.Hover(found ? `Unknown element \`${ref.id}\`: no registry of this model defines it.` : `\`${ref.id}\` cannot be resolved: this file is not inside a model.`, range);
}
return new vscode.Hover(describe(element), range);
}
async provideDefinition(document: vscode.TextDocument, position: vscode.Position): Promise<vscode.Location | undefined> {
const ref = refAt(document.lineAt(position.line).text, position.character);
if (!ref) return undefined;
const found = await this.models.registryFor(document.uri);
const element = found?.registry.elements.get(ref.id);
if (!found || !element) return undefined;
const file = vscode.Uri.joinPath(found.root, ...element.file.split(/[\\/]/));
return new vscode.Location(file, new vscode.Position(element.line, 2));
}
}
+148
View File
@@ -0,0 +1,148 @@
import fs from 'node:fs';
import path from 'node:path';
import Ajv2020, { ErrorObject, ValidateFunction } from 'ajv/dist/2020';
import { LineCounter, Node, isMap, isScalar, isSeq, parseDocument } from 'yaml';
/** A schema problem placed on the YAML node it is about; offsets into the text. */
export interface SchemaProblem {
from: number;
to: number;
message: string;
/** 'yaml' for a syntax error (only the first is reported), 'schema' otherwise. */
kind: 'yaml' | 'schema';
}
/** Schema file names in schemas/ that a file kind is checked against. */
export const DIAGRAM_SCHEMA = 'archify.schema.json';
export const REGISTRY_SCHEMA = 'archify-registry.schema.json';
/** Reads every *.schema.json of a folder: file name → schema. */
export function readSchemas(folder: string): Record<string, object> {
return Object.fromEntries(
fs
.readdirSync(folder)
.filter((name) => name.endsWith('.schema.json'))
.map((name) => [name, JSON.parse(fs.readFileSync(path.join(folder, name), 'utf8')) as object]),
);
}
/**
* Checks YAML text against our JSON Schemas (draft 2020-12, with ajv), so the
* Source view and the Problems panel see the same problems whether or not a
* YAML extension is installed. Schemas refer to each other by file name.
*/
export class SchemaChecker {
private readonly ajv = new Ajv2020({ allErrors: true, strict: false });
private readonly compiled = new Map<string, ValidateFunction | undefined>();
constructor(schemas: Record<string, object>) {
for (const [name, schema] of Object.entries(schemas)) this.ajv.addSchema(schema, name);
}
private validator(name: string): ValidateFunction | undefined {
if (!this.compiled.has(name)) this.compiled.set(name, this.ajv.getSchema(name));
return this.compiled.get(name);
}
check(text: string, schema: string): SchemaProblem[] {
const doc = parseDocument(text, { lineCounter: new LineCounter(), prettyErrors: false, uniqueKeys: false });
if (doc.errors.length) {
// Later syntax errors are usually echoes of the first.
const error = doc.errors[0];
return [{ from: error.pos[0], to: Math.max(error.pos[1], error.pos[0] + 1), message: `YAML: ${error.message.split('\n')[0]}`, kind: 'yaml' }];
}
const validate = this.validator(schema);
if (!validate || validate(doc.toJS())) return [];
return collapse(validate.errors ?? []).map((error) => {
const [from, to] = rangeFor(doc.contents, error, text.length);
return { from, to, message: describe(error), kind: 'schema' as const };
});
}
}
/** oneOf/anyOf/if produce a cascade; keep the errors a person can act on. */
function collapse(errors: ErrorObject[]): ErrorObject[] {
const seen = new Set<string>();
return errors
.filter((e) => !['if', 'oneOf', 'anyOf', 'allOf'].includes(e.keyword))
.filter((e) => {
const key = `${e.instancePath}|${e.keyword}|${JSON.stringify(e.params)}`;
if (seen.has(key)) return false;
seen.add(key);
return true;
});
}
/** "/connections/4/label" → "connections[4].label". */
export function readablePointer(pointer: string): string {
if (!pointer) return 'the file';
return pointer
.split('/')
.slice(1)
.map((part) => (/^\d+$/.test(part) ? `[${part}]` : `.${part.replace(/~1/g, '/').replace(/~0/g, '~')}`))
.join('')
.replace(/^\./, '');
}
function describe(e: ErrorObject): string {
const where = readablePointer(e.instancePath);
const params = e.params as Record<string, unknown>;
switch (e.keyword) {
case 'additionalProperties':
return `Unknown key "${params.additionalProperty}" in ${where}.`;
case 'required':
return `"${params.missingProperty}" is required in ${where}.`;
case 'enum':
return `${where} must be one of: ${(params.allowedValues as unknown[]).join(', ')}.`;
case 'const':
return `${where} must be ${JSON.stringify(params.allowedValue)}.`;
case 'type': {
const type = String(params.type);
return `${where} must be ${type === 'array' ? 'a list' : type === 'object' ? 'a mapping' : `a ${type}`}.`;
}
case 'minItems':
case 'maxItems': {
const limit = Number(params.limit);
return `${where} needs ${e.keyword === 'minItems' ? 'at least' : 'at most'} ${limit} item${limit === 1 ? '' : 's'}.`;
}
case 'propertyNames':
return `"${params.propertyName}" in ${where} is not a valid id: start with a letter; letters, digits, - and _ after.`;
default:
return `${where} ${e.message ?? 'is not valid'}.`;
}
}
function keyText(key: unknown): string {
return isScalar(key) ? String(key.value) : String(key);
}
/** The node an error is about: the offending key for unknown keys, else the value. */
function rangeFor(root: Node | null, error: ErrorObject, length: number): [number, number] {
const parts = error.instancePath.split('/').slice(1).map((p) => p.replace(/~1/g, '/').replace(/~0/g, '~'));
let node: unknown = root;
let keyNode: Node | null = null;
for (const part of parts) {
if (isMap(node)) {
const pair = node.items.find((p) => keyText(p.key) === part);
if (!pair) break;
keyNode = pair.key as Node;
node = pair.value;
} else if (isSeq(node)) {
keyNode = null;
node = node.items[Number(part)];
} else break;
}
const params = error.params as Record<string, unknown>;
const extra = params.additionalProperty ?? params.propertyName;
if (extra !== undefined && isMap(node)) {
const pair = node.items.find((p) => keyText(p.key) === String(extra));
const range = (pair?.key as Node | undefined)?.range;
if (range) return [range[0], range[1]];
}
if (error.keyword === 'required' && keyNode?.range) return [keyNode.range[0], keyNode.range[1]];
const target = (node as Node | undefined)?.range ? (node as Node) : keyNode;
if (!target?.range) return [0, Math.min(1, length)];
// A block mapping or list spans many lines; mark its first character only.
if ((isMap(target) || isSeq(target)) && !target.flow) return [target.range[0], target.range[0] + 1];
return [target.range[0], Math.max(target.range[1], target.range[0] + 1)];
}
+18
View File
@@ -9,6 +9,8 @@ export interface DiagramTemplate {
description: string; description: string;
/** Suggested name for the new file, without .archify. */ /** Suggested name for the new file, without .archify. */
defaultName: string; defaultName: string;
/** Reserved file name; the user is not asked for one. */
fixedName?: string;
} }
export const TEMPLATES: readonly DiagramTemplate[] = [ export const TEMPLATES: readonly DiagramTemplate[] = [
@@ -18,6 +20,7 @@ export const TEMPLATES: readonly DiagramTemplate[] = [
{ file: 'dataflow.archify', type: 'dataflow', label: 'Data Flow', description: 'Where data comes from and where it goes', defaultName: 'dataflow' }, { file: 'dataflow.archify', type: 'dataflow', label: 'Data Flow', description: 'Where data comes from and where it goes', defaultName: 'dataflow' },
{ file: 'lifecycle.archify', type: 'lifecycle', label: 'Lifecycle', description: 'States something moves through', defaultName: 'lifecycle' }, { file: 'lifecycle.archify', type: 'lifecycle', label: 'Lifecycle', description: 'States something moves through', defaultName: 'lifecycle' },
{ file: 'everyday-plan.archify', type: 'workflow', label: 'Everyday Plan', description: 'A plan or process from daily life', defaultName: 'plan' }, { file: 'everyday-plan.archify', type: 'workflow', label: 'Everyday Plan', description: 'A plan or process from daily life', defaultName: 'plan' },
{ file: 'model.archify', type: 'architecture', label: 'Model (main.archify)', description: 'Entry point of a folder of diagrams that belong together', defaultName: 'main', fixedName: 'main.archify' },
]; ];
/** Strips a typed .archify suffix and surrounding spaces. */ /** Strips a typed .archify suffix and surrounding spaces. */
@@ -40,6 +43,21 @@ export function titleFromName(name: string): string {
return words ? words.charAt(0).toUpperCase() + words.slice(1) : name; return words ? words.charAt(0).toUpperCase() + words.slice(1) : name;
} }
/** "online-shop" → "online-shop"; "My Shop 2" → "my-shop-2": a model id from a folder name. */
export function modelIdFromName(name: string): string {
const id = name.toLowerCase().replace(/[^a-z0-9]+/g, '-').replace(/^-+|-+$/g, '');
return /^[a-z]/.test(id) ? id : `m-${id || 'model'}`;
}
/** The model template with id, name and overview title taken from the folder name. */
export function modelFromTemplate(templateText: string, folderName: string): string {
const doc = parseDocument(templateText);
doc.setIn(['model', 'id'], modelIdFromName(folderName));
doc.setIn(['model', 'name'], titleFromName(folderName));
doc.setIn(['meta', 'title'], `${titleFromName(folderName)} overview`);
return doc.toString({ lineWidth: 0, flowCollectionPadding: false });
}
/** /**
* Template YAML with meta.title and meta.output set for the new file. * Template YAML with meta.title and meta.output set for the new file.
* Works on the YAML document so the template's comments and layout stay. * Works on the YAML document so the template's comments and layout stay.
+185
View File
@@ -0,0 +1,185 @@
import { LineCounter, isMap, isScalar, isSeq, parseDocument } from 'yaml';
import { ModelProblem, Registry } from './format';
/**
* Architecture decisions of a model (see docs/model.md): one
* `*.archify-decision` file per decision, anywhere under the model root.
* Pure functions, no VS Code imports.
*/
export const DECISION_EXT = '.archify-decision';
export const DECISION_STATUSES = ['proposed', 'accepted', 'superseded', 'rejected'] as const;
export type DecisionStatus = (typeof DECISION_STATUSES)[number];
export interface Decision {
id: string;
title?: string;
status?: string;
date?: string;
/** Registry element ids the decision is about. */
elements: string[];
/** Diagram paths (relative to the model root) the decision names. */
diagrams: string[];
/** Ids of older decisions this one replaces. */
supersedes: string[];
context?: string;
decision?: string;
consequences?: string;
/** Decision file relative to the model root, and 0-based lines for diagnostics. */
file: string;
line: number;
lines: { id: number; status: number; elements: number[]; diagrams: number[]; supersedes: number[] };
}
export function isDecisionFile(fileName: string): boolean {
return fileName.endsWith(DECISION_EXT);
}
const str = (v: unknown): string | undefined => (typeof v === 'string' && v.trim().length > 0 ? v : v !== undefined && v !== null && typeof v !== 'object' ? String(v) : undefined);
/** "OpenSearch for product search" → "opensearch-for-product-search". */
export function slugify(title: string): string {
const slug = title.toLowerCase().replace(/[^a-z0-9]+/g, '-').replace(/^-+|-+$/g, '');
return slug || 'decision';
}
/** Parses one decision file. Problems carry 0-based lines. */
export function parseDecision(text: string, file: string): { decision?: Decision; problems: ModelProblem[] } {
const problems: ModelProblem[] = [];
// prettyErrors would put line numbers into the messages; the line counter gives them without.
const lines = new LineCounter();
const doc = parseDocument(text, { prettyErrors: false, uniqueKeys: false, lineCounter: lines });
for (const error of doc.errors) {
problems.push({ message: `Decision is not valid YAML: ${error.message.split('\n')[0]}`, severity: 'error', file, line: lines.linePos(error.pos[0]).line - 1 });
}
if (doc.errors.length) return { problems };
const lineOf = (offset: number | undefined) => (offset === undefined ? 0 : text.slice(0, offset).split('\n').length - 1);
const root = doc.contents;
if (!isMap(root)) {
problems.push({ message: 'A decision file is a mapping with a "decision" block and context, decision and consequences.', severity: 'error', file, line: 0 });
return { problems };
}
const headNode = root.get('decision', true);
if (!isMap(headNode)) {
problems.push({ message: 'A decision needs a "decision" block with id, title and status.', severity: 'error', file, line: 0, pointer: '/decision' });
return { problems };
}
const headPair = root.items.find((pair) => isScalar(pair.key) && pair.key.value === 'decision');
const headLine = headPair && isScalar(headPair.key) ? lineOf(headPair.key.range?.[0]) : 0;
const keyLine = (key: string) => {
const pair = headNode.items.find((p) => isScalar(p.key) && p.key.value === key);
return pair && isScalar(pair.key) ? lineOf(pair.key.range?.[0]) : headLine;
};
const list = (key: string): { values: string[]; lines: number[] } => {
const node = headNode.get(key, true);
const values: string[] = [];
const lines: number[] = [];
if (isSeq(node)) {
for (const item of node.items) {
if (!isScalar(item)) continue;
if (typeof item.value === 'number') {
problems.push({ message: `"${item.value}" in ${key} is a number to YAML. Quote it or use words.`, severity: 'error', file, line: lineOf(item.range?.[0]), pointer: `/decision/${key}` });
continue;
}
if (str(item.value)) {
values.push(String(item.value));
lines.push(lineOf(item.range?.[0]));
}
}
} else if (node !== undefined) {
problems.push({ message: `"${key}" must be a list.`, severity: 'error', file, line: keyLine(key), pointer: `/decision/${key}` });
}
return { values, lines };
};
const head = headNode.toJSON() as Record<string, unknown>;
if (typeof head.id === 'number') {
problems.push({ message: `decision.id ${head.id} is a number to YAML (0001 becomes 1). Quote it ("${head.id}") or use words.`, severity: 'error', file, line: keyLine('id'), pointer: '/decision/id' });
return { problems };
}
const id = str(head.id);
if (!id) {
problems.push({ message: 'decision.id is missing.', severity: 'error', file, line: headLine, pointer: '/decision/id' });
return { problems };
}
const status = str(head.status);
if (status && !(DECISION_STATUSES as readonly string[]).includes(status)) {
problems.push({ message: `Unknown status "${status}"; one of ${DECISION_STATUSES.join(', ')}.`, severity: 'error', file, line: keyLine('status'), pointer: '/decision/status' });
}
const elements = list('elements');
const diagrams = list('diagrams');
const supersedes = list('supersedes');
const body = root.toJSON() as Record<string, unknown>;
return {
problems,
decision: {
id,
title: str(head.title),
status,
date: str(head.date),
elements: elements.values,
diagrams: diagrams.values,
supersedes: supersedes.values,
context: str(body.context),
decision: str(body.decision),
consequences: str(body.consequences),
file,
line: headLine,
lines: { id: keyLine('id'), status: keyLine('status'), elements: elements.lines, diagrams: diagrams.lines, supersedes: supersedes.lines },
},
};
}
export interface DecisionSet {
decisions: Map<string, Decision>;
files: string[];
problems: ModelProblem[];
}
/** Merges parsed decision files; an id used twice is an error on the second file. */
export function mergeDecisions(parts: { file: string; decision?: Decision; problems: ModelProblem[] }[]): DecisionSet {
const decisions = new Map<string, Decision>();
const problems: ModelProblem[] = [];
for (const part of parts) {
problems.push(...part.problems);
if (!part.decision) continue;
const existing = decisions.get(part.decision.id);
if (existing) {
problems.push({ message: `Decision "${part.decision.id}" is defined twice (also in ${existing.file}).`, severity: 'error', file: part.file, line: part.decision.lines.id });
continue;
}
decisions.set(part.decision.id, part.decision);
}
return { decisions, files: parts.map((p) => p.file), problems };
}
/** The status the pages show: a decision another one supersedes is superseded, whatever its file says. */
export function effectiveStatus(decision: Decision, all: Map<string, Decision>): { status: string; supersededBy?: string } {
for (const other of all.values()) {
if (other !== decision && other.supersedes.includes(decision.id) && other.status !== 'rejected') return { status: 'superseded', supersededBy: other.id };
}
return { status: decision.status ?? 'proposed' };
}
/** Link checks across the model: elements, diagrams and supersedes must exist. */
export function validateDecisions(set: DecisionSet, registry: Registry | undefined, diagramPaths: Set<string>): ModelProblem[] {
const problems: ModelProblem[] = [];
for (const d of set.decisions.values()) {
d.elements.forEach((id, i) => {
if (!registry?.elements.has(id)) problems.push({ message: `Unknown element "${id}": no registry of this model defines it.`, severity: 'error', file: d.file, line: d.lines.elements[i], pointer: `/decision/elements/${i}` });
});
d.diagrams.forEach((path, i) => {
if (!diagramPaths.has(path)) problems.push({ message: `Diagram "${path}" does not exist in this model.`, severity: 'error', file: d.file, line: d.lines.diagrams[i], pointer: `/decision/diagrams/${i}` });
});
d.supersedes.forEach((id, i) => {
if (!set.decisions.has(id)) problems.push({ message: `Decision "${id}" (in supersedes) does not exist in this model.`, severity: 'error', file: d.file, line: d.lines.supersedes[i], pointer: `/decision/supersedes/${i}` });
else if (id === d.id) problems.push({ message: 'A decision cannot supersede itself.', severity: 'error', file: d.file, line: d.lines.supersedes[i], pointer: `/decision/supersedes/${i}` });
});
}
return problems;
}
/** Sort for lists: live decisions newest first, superseded and rejected last. */
export function sortDecisions(decisions: Decision[], all: Map<string, Decision>): Decision[] {
const rank = (d: Decision) => (['superseded', 'rejected'].includes(effectiveStatus(d, all).status) ? 1 : 0);
return [...decisions].sort((a, b) => rank(a) - rank(b) || (b.date ?? '').localeCompare(a.date ?? '') || a.id.localeCompare(b.id));
}
+394
View File
@@ -0,0 +1,394 @@
import { LineCounter, isMap, isScalar, parse as parseYaml, parseDocument } from 'yaml';
/**
* The model file formats (see docs/model.md): `main.archify` with a `model`
* block, `*.archify-registry` files with shared elements, and `ref`
* components in diagrams. Pure functions, no VS Code imports, so they run
* in unit tests and can be reused by other tools.
*/
export const MAIN_FILE = 'main.archify';
export const REGISTRY_EXT = '.archify-registry';
/** Component fields copied from a registry element into every diagram that refers to it. */
export const COPIED_FIELDS = ['type', 'label', 'sublabel', 'tag', 'icon', 'brand', 'sources'] as const;
/** The subset a diagram may override on a `ref` component. */
export const OVERRIDABLE_FIELDS = ['label', 'sublabel', 'tag'] as const;
export interface ModelMeta {
id?: string;
name?: string;
description?: string;
}
export interface RegistryElement {
id: string;
type?: string;
label?: string;
sublabel?: string;
tag?: string;
icon?: unknown;
brand?: string;
sources?: unknown;
description?: string;
/** Diagram that explains the element, relative to the model root. */
diagram?: string;
/** Registry file that defines it, and the 0-based line of its key. */
file: string;
line: number;
}
export interface ModelProblem {
message: string;
severity: 'error' | 'warning';
/** File the problem is about; defaults to the diagram being resolved. */
file?: string;
/** JSON pointer into that file's document, when it is a diagram. */
pointer?: string;
/** 0-based line, when known (registry files). */
line?: number;
}
export interface Registry {
elements: Map<string, RegistryElement>;
files: string[];
problems: ModelProblem[];
}
export function isMainFile(fileName: string): boolean {
return (fileName.split(/[\\/]/).pop() ?? '') === MAIN_FILE;
}
export function isRegistryFile(fileName: string): boolean {
return fileName.endsWith(REGISTRY_EXT);
}
type Obj = Record<string, unknown>;
const isObj = (v: unknown): v is Obj => v !== null && typeof v === 'object' && !Array.isArray(v);
const str = (v: unknown): string | undefined => (typeof v === 'string' && v.length > 0 ? v : undefined);
/** The `model` block of a `main.archify` document, if present. */
export function readModelMeta(doc: unknown): ModelMeta | undefined {
if (!isObj(doc) || !isObj(doc.model)) return undefined;
const { id, name, description } = doc.model;
return { id: str(id), name: str(name), description: str(description) };
}
/** True when the document also carries a diagram (a `diagram_type`). */
export function hasDiagramBody(doc: unknown): boolean {
return isObj(doc) && typeof doc.diagram_type === 'string';
}
/** Parses one registry file. Line numbers come from the YAML document. */
export function parseRegistry(text: string, file: string): { elements: RegistryElement[]; problems: ModelProblem[] } {
const problems: ModelProblem[] = [];
const elements: RegistryElement[] = [];
// prettyErrors would put line numbers into the messages; the line counter gives them without.
const lines = new LineCounter();
const doc = parseDocument(text, { prettyErrors: false, uniqueKeys: false, lineCounter: lines });
for (const error of doc.errors) {
problems.push({ message: `Registry is not valid YAML: ${error.message.split('\n')[0]}`, severity: 'error', file, line: lines.linePos(error.pos[0]).line - 1 });
}
if (doc.errors.length) return { elements, problems };
const lineOf = (offset: number | undefined) => (offset === undefined ? 0 : text.slice(0, offset).split('\n').length - 1);
const root = doc.contents;
if (!isMap(root)) {
problems.push({ message: 'A registry must be a mapping with an "elements" key.', severity: 'error', file, line: 0 });
return { elements, problems };
}
const elementsNode = root.get('elements', true);
if (!isMap(elementsNode)) {
problems.push({ message: 'A registry needs an "elements" mapping (id → element).', severity: 'error', file, line: 0 });
return { elements, problems };
}
for (const pair of elementsNode.items) {
const key = pair.key;
const id = isScalar(key) ? String(key.value) : undefined;
const line = isScalar(key) ? lineOf(key.range?.[0]) : 0;
if (!id) continue;
const value = isMap(pair.value) ? (pair.value.toJSON() as Obj) : undefined;
if (!value) {
problems.push({ message: `Element "${id}" must be a mapping (type, label, description, …).`, severity: 'error', file, line });
continue;
}
elements.push({
id,
type: str(value.type),
label: str(value.label),
sublabel: str(value.sublabel),
tag: str(value.tag),
icon: value.icon,
brand: str(value.brand),
sources: value.sources,
description: str(value.description),
diagram: str(value.diagram),
file,
line,
});
}
return { elements, problems };
}
/** Merges parsed registry files; an id defined twice is an error on the second definition. */
export function mergeRegistries(parts: { elements: RegistryElement[]; problems: ModelProblem[]; file: string }[]): Registry {
const elements = new Map<string, RegistryElement>();
const problems: ModelProblem[] = [];
for (const part of parts) {
problems.push(...part.problems);
for (const element of part.elements) {
const existing = elements.get(element.id);
if (existing) {
problems.push({
message: `Element "${element.id}" is defined twice (also in ${existing.file}, line ${existing.line + 1}).`,
severity: 'error',
file: element.file,
line: element.line,
});
continue;
}
elements.set(element.id, element);
}
}
return { elements, files: parts.map((p) => p.file), problems };
}
/** Where a diagram attaches a decision: the diagram itself, a node or an edge. */
export type DecisionAttachment = { kind: 'diagram' } | { kind: 'node'; id: string } | { kind: 'edge'; from: string; to: string; label?: string };
export interface DecisionRef {
id: string;
pointer: string;
attachedTo: DecisionAttachment;
}
/** Collections whose items may carry `decisions` (and `diagram` links), per diagram kind. */
const NODE_COLLECTIONS = ['components', 'nodes', 'participants', 'states'] as const;
const EDGE_COLLECTIONS = ['connections', 'edges', 'flows', 'transitions', 'messages'] as const;
export interface ResolvedDiagram {
/** The diagram as Archify expects it: refs expanded, model block and links removed. */
diagram: Obj;
problems: ModelProblem[];
/** Component index → the registry element it came from. */
refs: Map<number, RegistryElement>;
/** Node id → diagram path (relative to the model root) it links to. */
links: Map<string, string>;
/** Registry element ids used by this diagram. */
used: Set<string>;
/** Node id → registry description, for the Elements panel. */
descriptions: Map<string, string>;
/** Decisions the diagram points at, with where they are attached. */
decisionRefs: DecisionRef[];
}
export interface ResolveOptions {
/** Undefined when the diagram is not inside a model. */
registry?: Registry;
/** Known decision ids of the model; undefined outside a model or when unknown. */
decisions?: Set<string>;
fileName: string;
}
/** Strips `decisions` keys from a diagram and collects what they point at. Mutates `diagram`. */
function takeDecisionRefs(diagram: Obj, options: ResolveOptions, problems: ModelProblem[]): DecisionRef[] {
const refs: DecisionRef[] = [];
const take = (owner: Obj, pointer: string, attachedTo: DecisionAttachment) => {
if (!('decisions' in owner)) return;
const raw = owner.decisions;
delete owner.decisions;
const ids = Array.isArray(raw) ? raw : [raw];
ids.forEach((value, i) => {
const id = value === undefined || value === null ? undefined : String(value);
if (!id) return;
const at = `${pointer}/decisions/${i}`;
if (typeof value === 'number') {
problems.push({ message: `Decision id ${value} is a number to YAML (0001 becomes 1). Quote it ("${value}") or use words.`, severity: 'error', pointer: at });
return;
}
if (!options.registry) {
problems.push({ message: `Decision "${id}" cannot be resolved: ${options.fileName.split(/[\\/]/).pop()} is not inside a model (no ${MAIN_FILE} above it).`, severity: 'error', pointer: at });
} else if (options.decisions && !options.decisions.has(id)) {
problems.push({ message: `Unknown decision "${id}": no .archify-decision file of this model defines it.`, severity: 'error', pointer: at });
}
refs.push({ id, pointer: at, attachedTo });
});
};
take(diagram, '', { kind: 'diagram' });
for (const key of NODE_COLLECTIONS) {
const items = diagram[key];
if (!Array.isArray(items)) continue;
diagram[key] = items.map((item, index) => {
if (!isObj(item)) return item;
const copy = { ...item };
take(copy, `/${key}/${index}`, { kind: 'node', id: str(copy.id) ?? str(copy.ref) ?? String(index) });
return copy;
});
}
for (const key of EDGE_COLLECTIONS) {
const items = diagram[key];
if (!Array.isArray(items)) continue;
diagram[key] = items.map((item, index) => {
if (!isObj(item)) return item;
const copy = { ...item };
take(copy, `/${key}/${index}`, { kind: 'edge', from: str(copy.from) ?? '', to: str(copy.to) ?? '', label: str(copy.label) });
return copy;
});
}
return refs;
}
/**
* Expands `ref` components from the registry and strips what Archify does
* not know. Component order and indexes are kept, so Archify's diagnostics
* (JSON pointers) still point at the right component in the source file.
*/
export function resolveRefs(doc: unknown, options: ResolveOptions): ResolvedDiagram {
const problems: ModelProblem[] = [];
const refs = new Map<number, RegistryElement>();
const links = new Map<string, string>();
const used = new Set<string>();
const descriptions = new Map<string, string>();
if (!isObj(doc)) return { diagram: {}, problems, refs, links, used, descriptions, decisionRefs: [] };
const diagram: Obj = { ...doc };
delete diagram.model;
const decisionRefs = takeDecisionRefs(diagram, options, problems);
const { registry } = options;
const components = Array.isArray(diagram.components) ? diagram.components : undefined;
if (!components) return { diagram, problems, refs, links, used, descriptions, decisionRefs };
diagram.components = components.map((raw, index) => {
if (!isObj(raw)) return raw;
const ref = str(raw.ref);
const linkFromComponent = str(raw.diagram);
if (!ref) {
const { diagram: _link, ...plain } = raw;
const id = str(plain.id);
if (id && linkFromComponent) links.set(id, linkFromComponent);
return plain;
}
const { ref: _ref, diagram: _link, ...own } = raw;
const element = registry?.elements.get(ref);
const id = str(own.id) ?? ref;
if (!element) {
problems.push({
message: registry
? `Unknown element "${ref}": no registry of this model defines it.`
: `"${ref}" cannot be resolved: ${options.fileName.split(/[\\/]/).pop()} is not inside a model (no ${MAIN_FILE} above it).`,
severity: 'error',
pointer: `/components/${index}/ref`,
});
return { type: 'external', label: ref, ...own, id };
}
used.add(ref);
refs.set(index, element);
if (element.description) descriptions.set(id, element.description.trim());
for (const key of Object.keys(own)) {
if ((COPIED_FIELDS as readonly string[]).includes(key) && !(OVERRIDABLE_FIELDS as readonly string[]).includes(key)) {
problems.push({
message: `"${key}" comes from the registry element "${ref}" and cannot be changed in a diagram.`,
severity: 'error',
pointer: `/components/${index}/${key}`,
});
}
}
const merged: Obj = { id };
for (const key of COPIED_FIELDS) if (element[key] !== undefined) merged[key] = element[key];
for (const [key, value] of Object.entries(own)) {
if (key === 'id') continue;
if (!(COPIED_FIELDS as readonly string[]).includes(key) || (OVERRIDABLE_FIELDS as readonly string[]).includes(key)) merged[key] = value;
}
const link = linkFromComponent ?? element.diagram;
if (link) links.set(id, link);
return merged;
});
return { diagram, problems, refs, links, used, descriptions, decisionRefs };
}
/** Group of a diagram inside a model: '' for the root folder, else the folder path with '/' separators. */
export function groupOf(relativePath: string): string {
const parts = relativePath.split(/[\\/]/);
parts.pop();
return parts.join('/');
}
/** A node as a diagram declares it: a `ref` to the registry, or an inline element. */
export interface DiagramNode {
id: string;
ref?: string;
type?: string;
label?: string;
sublabel?: string;
brand?: string;
}
/** A connection, edge, flow, transition or message between two nodes of a diagram. */
export interface DiagramEdge {
from: string;
to: string;
label?: string;
}
export interface DiagramSummary {
relativePath: string;
group: string;
kind?: string;
title?: string;
used: string[];
/** Decisions the diagram points at. */
decisions: DecisionRef[];
/** Every node the diagram draws, shared or inline, in file order. */
nodes: DiagramNode[];
/** Every edge between two of those nodes. */
edges: DiagramEdge[];
parseError?: string;
}
/** What the model page needs to know about one diagram file. */
export function summarizeDiagram(text: string, relativePath: string): DiagramSummary {
let doc: unknown;
try {
doc = parseYaml(text, { prettyErrors: false, uniqueKeys: false });
} catch (error) {
return { relativePath, group: groupOf(relativePath), used: [], decisions: [], nodes: [], edges: [], parseError: error instanceof Error ? error.message.split('\n')[0] : String(error) };
}
const obj = isObj(doc) ? doc : {};
const meta = isObj(obj.meta) ? obj.meta : {};
const components = Array.isArray(obj.components) ? obj.components : [];
const used = [...new Set(components.map((c) => (isObj(c) ? str(c.ref) : undefined)).filter((r): r is string => !!r))];
const decisions = takeDecisionRefs({ ...obj }, { registry: { elements: new Map(), files: [], problems: [] }, fileName: relativePath }, []);
const nodes: DiagramNode[] = [];
const seen = new Set<string>();
for (const key of NODE_COLLECTIONS) {
const items = obj[key];
if (!Array.isArray(items)) continue;
for (const item of items) {
if (!isObj(item)) continue;
const ref = str(item.ref);
const id = str(item.id) ?? ref;
if (!id || seen.has(id)) continue;
seen.add(id);
nodes.push({ id, ref, type: str(item.type), label: str(item.label), sublabel: str(item.sublabel), brand: str(item.brand) });
}
}
const edges: DiagramEdge[] = [];
for (const key of EDGE_COLLECTIONS) {
const items = obj[key];
if (!Array.isArray(items)) continue;
for (const item of items) {
if (!isObj(item)) continue;
const from = str(item.from);
const to = str(item.to);
if (!from || !to || !seen.has(from) || !seen.has(to)) continue;
edges.push({ from, to, label: str(item.label) });
}
}
return { relativePath, group: groupOf(relativePath), kind: str(obj.diagram_type), title: str(meta.title), used, decisions, nodes, edges };
}
/** Groups in display order: the root group first, then folders in path order. */
export function sortedGroups(summaries: DiagramSummary[]): { group: string; diagrams: DiagramSummary[] }[] {
const byGroup = new Map<string, DiagramSummary[]>();
for (const s of summaries) byGroup.set(s.group, [...(byGroup.get(s.group) ?? []), s]);
const groups = [...byGroup.keys()].sort((a, b) => (a === '' ? -1 : b === '' ? 1 : a.localeCompare(b)));
return groups.map((group) => ({ group, diagrams: byGroup.get(group)!.sort((a, b) => a.relativePath.localeCompare(b.relativePath)) }));
}
+196
View File
@@ -0,0 +1,196 @@
import { Decision, DecisionSet, effectiveStatus } from './decisions';
import { DecisionAttachment, DiagramSummary, ModelMeta, Registry } from './format';
/**
* The model as one graph: every element any diagram draws (and every registry
* element, drawn or not), every connection any diagram has between two of
* them, each once. Pure: built from the model index, no VS Code imports, so
* the webview bundle and the unit tests share it.
*/
export type GraphNodeKind = 'element' | 'decision' | 'registry';
export type GraphEdgeKind = 'connection' | 'decides' | 'defines' | 'supersedes';
export interface GraphNode {
id: string;
/** An element of the model, a decision (`decision:<id>`) or a registry file (`registry:<file>`). */
kind: GraphNodeKind;
label: string;
sublabel?: string;
type?: string;
brand?: string;
/** Defined in a registry (true) or inline in one diagram (false). */
shared: boolean;
description?: string;
/** Registry file and 0-based line, for shared elements. */
file?: string;
line?: number;
/** Diagram that explains the element, relative to the model root. */
link?: string;
/** Diagrams that draw it, relative paths in path order. */
diagrams: string[];
/** Decisions about it: named by the decision, or attached to its node in a diagram. */
decisions: string[];
/** Decision nodes: the effective status. */
status?: string;
/** Registry nodes: ids of the elements the file defines. */
elements?: string[];
}
export interface GraphEdge {
/** `from>to`, unique in the graph. */
id: string;
/** A connection drawn by a diagram, or a link to a decision or registry node. */
kind: GraphEdgeKind;
from: string;
to: string;
/** Distinct labels the diagrams give this connection. */
labels: string[];
diagrams: string[];
decisions: string[];
}
export interface GraphDecision {
id: string;
title?: string;
status: string;
file: string;
}
export interface GraphDiagram {
path: string;
title?: string;
kind?: string;
}
export interface ModelGraph {
meta: ModelMeta;
nodes: GraphNode[];
edges: GraphEdge[];
decisions: GraphDecision[];
diagrams: GraphDiagram[];
}
export interface GraphInput {
meta: ModelMeta;
registry: Registry;
diagrams: DiagramSummary[];
decisions: DecisionSet;
decisionUsage: Map<string, { path: string; attachedTo: DecisionAttachment }[]>;
}
export const edgeId = (from: string, to: string): string => `${from}>${to}`;
export const decisionNodeId = (id: string): string => `decision:${id}`;
export const registryNodeId = (file: string): string => `registry:${file}`;
function pushUnique(list: string[], value: string): void {
if (!list.includes(value)) list.push(value);
}
export function buildGraph(input: GraphInput): ModelGraph {
const nodes = new Map<string, GraphNode>();
const edges = new Map<string, GraphEdge>();
// Registry elements first: shared, and present even when no diagram draws them yet.
for (const e of input.registry.elements.values()) {
nodes.set(e.id, {
id: e.id,
kind: 'element',
label: e.label ?? e.id,
sublabel: e.sublabel,
type: e.type,
brand: e.brand,
shared: true,
description: e.description?.trim() || undefined,
file: e.file,
line: e.line,
link: e.diagram,
diagrams: [],
decisions: [],
});
}
const diagrams = [...input.diagrams].filter((d) => !d.parseError).sort((a, b) => a.relativePath.localeCompare(b.relativePath));
for (const d of diagrams) {
for (const n of d.nodes) {
let node = nodes.get(n.id);
if (!node) {
const element = n.ref ? input.registry.elements.get(n.ref) : undefined;
node = element
? { ...nodes.get(element.id)!, id: n.id, label: n.label ?? element.label ?? n.id, sublabel: n.sublabel ?? element.sublabel, diagrams: [], decisions: [] }
: { id: n.id, kind: 'element', label: n.label ?? n.ref ?? n.id, sublabel: n.sublabel, type: n.type, brand: n.brand, shared: false, diagrams: [], decisions: [] };
nodes.set(n.id, node);
}
pushUnique(node.diagrams, d.relativePath);
}
for (const e of d.edges) {
const id = edgeId(e.from, e.to);
let edge = edges.get(id);
if (!edge) {
edge = { id, kind: 'connection', from: e.from, to: e.to, labels: [], diagrams: [], decisions: [] };
edges.set(id, edge);
}
if (e.label) pushUnique(edge.labels, e.label);
pushUnique(edge.diagrams, d.relativePath);
}
}
const all = input.decisions.decisions;
for (const d of all.values()) for (const id of d.elements) nodes.get(id)?.decisions && pushUnique(nodes.get(id)!.decisions, d.id);
for (const [decisionId, uses] of input.decisionUsage) {
if (!all.has(decisionId)) continue;
for (const use of uses) {
if (use.attachedTo.kind === 'node') {
const node = nodes.get(use.attachedTo.id);
if (node) pushUnique(node.decisions, decisionId);
} else if (use.attachedTo.kind === 'edge') {
const edge = edges.get(edgeId(use.attachedTo.from, use.attachedTo.to));
if (edge) pushUnique(edge.decisions, decisionId);
}
}
}
const decisionRow = (d: Decision): GraphDecision => ({ id: d.id, title: d.title, status: effectiveStatus(d, all).status, file: d.file });
// Registry files as nodes, each linked to the elements it defines.
const byFile = new Map<string, string[]>();
for (const e of input.registry.elements.values()) byFile.set(e.file, [...(byFile.get(e.file) ?? []), e.id]);
for (const file of input.registry.files) if (!byFile.has(file)) byFile.set(file, []);
for (const [file, ids] of byFile) {
const id = registryNodeId(file);
nodes.set(id, { id, kind: 'registry', label: file.replace(/\.archify-registry$/, ''), type: 'registry', shared: true, file, diagrams: [], decisions: [], elements: ids });
for (const element of ids) {
const edge = edgeId(id, element);
edges.set(edge, { id: edge, kind: 'defines', from: id, to: element, labels: [], diagrams: [], decisions: [] });
}
}
// Decisions as nodes, linked to the elements and connections they are about, and to what they supersede.
for (const d of all.values()) {
const id = decisionNodeId(d.id);
const row = decisionRow(d);
nodes.set(id, { id, kind: 'decision', label: d.title ?? d.id, sublabel: d.id, type: 'decision', shared: true, description: [d.context, d.decision].filter(Boolean).join('\n\n') || undefined, file: d.file, line: 0, diagrams: [...d.diagrams], decisions: [], status: row.status });
}
for (const node of [...nodes.values()]) {
if (node.kind !== 'element') continue;
for (const decision of node.decisions) {
if (!all.has(decision)) continue;
const edge = edgeId(decisionNodeId(decision), node.id);
edges.set(edge, { id: edge, kind: 'decides', from: decisionNodeId(decision), to: node.id, labels: [], diagrams: [], decisions: [] });
}
}
for (const d of all.values()) {
for (const other of d.supersedes) {
if (!all.has(other)) continue;
const edge = edgeId(decisionNodeId(d.id), decisionNodeId(other));
edges.set(edge, { id: edge, kind: 'supersedes', from: decisionNodeId(d.id), to: decisionNodeId(other), labels: ['supersedes'], diagrams: [], decisions: [] });
}
}
return {
meta: input.meta,
nodes: [...nodes.values()].sort((a, b) => a.id.localeCompare(b.id)),
edges: [...edges.values()].sort((a, b) => a.id.localeCompare(b.id)),
decisions: [...all.values()].map(decisionRow).sort((a, b) => a.id.localeCompare(b.id)),
diagrams: diagrams.map((d) => ({ path: d.relativePath, title: d.title, kind: d.kind })),
};
}
+251
View File
@@ -0,0 +1,251 @@
import { GraphEdge, GraphNode, ModelGraph } from './graph';
/**
* The graph page's query box. A few words, no language to learn: terms are
* ANDed, a leading `-` excludes, `key:value` terms filter by a field or walk
* the graph. Pure, shared by the webview bundle and the unit tests.
*
* database label, id, sublabel, brand or type contain it
* type:backend elements of that type
* diagram:0200-* drawn by a diagram whose path matches (glob)
* decision:<id> what the decision is about or attached to
* uses:api api and its neighbours
* near:api,2 api and everything within two steps
* from:web to:db the shortest path between two elements
* unused registry elements no diagram draws
* shared / -shared registry elements / inline elements
*/
export interface QueryTerm {
key: string;
value: string;
negate: boolean;
}
export interface QueryResult {
/** Ids of the elements that match. Every element when the query is empty. */
nodes: Set<string>;
/** Ids of the connections shown: both ends match, or the path found. */
edges: Set<string>;
/** The path found by `from: to:`, in order. */
path?: string[];
/** Why the result is empty or partial, when it is. */
message?: string;
terms: QueryTerm[];
}
const WALK_KEYS = new Set(['uses', 'near', 'from', 'to']);
const FIELD_KEYS = new Set(['type', 'diagram', 'decision', 'shared', 'unused', 'text']);
export function parseQuery(text: string): QueryTerm[] {
const tokens = text.trim().split(/\s+/).filter(Boolean);
const terms: QueryTerm[] = [];
for (let i = 0; i < tokens.length; i += 1) {
let token = tokens[i];
const negate = token.startsWith('-') && token.length > 1;
if (negate) token = token.slice(1);
const colon = token.indexOf(':');
let key = colon > 0 ? token.slice(0, colon).toLowerCase() : token.toLowerCase();
let value = colon > 0 ? token.slice(colon + 1) : '';
if (colon > 0 && !WALK_KEYS.has(key) && !FIELD_KEYS.has(key)) {
key = 'text';
value = token;
} else if (colon < 0 && key !== 'shared' && key !== 'unused') {
key = 'text';
value = token;
}
// `near:api 2` is also accepted: a bare number after near is the hop count.
if (key === 'near' && !value.includes(',') && /^\d+$/.test(tokens[i + 1] ?? '')) {
value = `${value},${tokens[i + 1]}`;
i += 1;
}
if (!value && key === 'text') continue;
terms.push({ key, value, negate });
}
return terms;
}
const lower = (s: string | undefined) => (s ?? '').toLowerCase();
const isElement = (n: GraphNode) => n.kind === 'element';
const isConnection = (e: GraphEdge) => e.kind === 'connection';
/** An element by id, then by id or label ignoring case. Decision and registry nodes are not walked from. */
export function findNode(graph: ModelGraph, ref: string): GraphNode | undefined {
const elements = graph.nodes.filter(isElement);
const exact = elements.find((n) => n.id === ref);
if (exact) return exact;
const l = ref.toLowerCase();
return elements.find((n) => n.id.toLowerCase() === l) ?? elements.find((n) => n.label.toLowerCase() === l);
}
function globToRegExp(pattern: string): RegExp {
const escaped = pattern.replace(/[.+^${}()|[\]\\]/g, '\\$&').replace(/\*/g, '.*').replace(/\?/g, '.');
return new RegExp(`^${escaped}$`, 'i');
}
function diagramMatches(path: string, pattern: string): boolean {
const bare = path.replace(/\.archify$/, '');
const wanted = pattern.replace(/\.archify$/, '');
if (wanted.includes('*') || wanted.includes('?')) return globToRegExp(wanted).test(bare) || globToRegExp(wanted).test(path);
const l = wanted.toLowerCase();
return bare.toLowerCase() === l || bare.toLowerCase().startsWith(`${l}/`) || bare.toLowerCase().startsWith(l) || bare.toLowerCase().includes(`/${l}`);
}
/** Element-to-element adjacency over the diagrams' connections; decision and registry links do not count as steps. */
function neighbours(graph: ModelGraph): Map<string, Set<string>> {
const map = new Map<string, Set<string>>();
for (const n of graph.nodes) map.set(n.id, new Set());
for (const e of graph.edges.filter(isConnection)) {
map.get(e.from)?.add(e.to);
map.get(e.to)?.add(e.from);
}
return map;
}
function within(graph: ModelGraph, start: string, hops: number): Set<string> {
const adjacency = neighbours(graph);
let frontier = new Set([start]);
const seen = new Set([start]);
for (let i = 0; i < hops; i += 1) {
const next = new Set<string>();
for (const id of frontier) for (const other of adjacency.get(id) ?? []) if (!seen.has(other)) { seen.add(other); next.add(other); }
frontier = next;
if (!frontier.size) break;
}
return seen;
}
/** Shortest path by breadth-first search; directed first, then ignoring direction. */
export function shortestPath(graph: ModelGraph, from: string, to: string): { nodes: string[]; edges: string[] } | undefined {
const attempt = (directed: boolean) => {
const out = new Map<string, { to: string; edge: GraphEdge }[]>();
for (const n of graph.nodes) out.set(n.id, []);
for (const e of graph.edges.filter(isConnection)) {
out.get(e.from)?.push({ to: e.to, edge: e });
if (!directed) out.get(e.to)?.push({ to: e.from, edge: e });
}
const previous = new Map<string, { from: string; edge: GraphEdge }>();
const queue = [from];
const seen = new Set([from]);
while (queue.length) {
const id = queue.shift()!;
if (id === to) break;
for (const step of out.get(id) ?? []) {
if (seen.has(step.to)) continue;
seen.add(step.to);
previous.set(step.to, { from: id, edge: step.edge });
queue.push(step.to);
}
}
if (!seen.has(to)) return undefined;
const nodes = [to];
const edges: string[] = [];
let at = to;
while (at !== from) {
const step = previous.get(at)!;
edges.unshift(step.edge.id);
nodes.unshift(step.from);
at = step.from;
}
return { nodes, edges };
};
if (from === to) return { nodes: [from], edges: [] };
return attempt(true) ?? attempt(false);
}
export function runQuery(graph: ModelGraph, text: string): QueryResult {
const terms = parseQuery(text);
const everything = new Set(graph.nodes.map((n) => n.id));
let result = new Set(everything);
const notes: string[] = [];
let from: string | undefined;
let to: string | undefined;
let pathEdges: Set<string> | undefined;
let path: string[] | undefined;
const matching = (term: QueryTerm): Set<string> | undefined => {
const v = term.value;
switch (term.key) {
case 'text': {
const l = v.toLowerCase();
return new Set(graph.nodes.filter((n) => [n.id, n.label, n.sublabel, n.brand, n.type].some((f) => lower(f).includes(l))).map((n) => n.id));
}
case 'type':
return new Set(graph.nodes.filter((n) => lower(n.type) === v.toLowerCase()).map((n) => n.id));
case 'diagram':
return new Set(graph.nodes.filter((n) => n.diagrams.some((d) => diagramMatches(d, v))).map((n) => n.id));
case 'decision': {
const ids = new Set(graph.nodes.filter((n) => n.decisions.includes(v)).map((n) => n.id));
for (const e of graph.edges) if (e.decisions.includes(v)) { ids.add(e.from); ids.add(e.to); }
if (!graph.decisions.some((d) => d.id === v)) notes.push(`No decision "${v}" in this model.`);
else ids.add(`decision:${v}`);
return ids;
}
case 'shared':
return new Set(graph.nodes.filter((n) => isElement(n) && n.shared).map((n) => n.id));
case 'unused':
return new Set(graph.nodes.filter((n) => isElement(n) && n.shared && n.diagrams.length === 0).map((n) => n.id));
case 'uses':
case 'near': {
const [ref, hopsText] = term.key === 'near' ? v.split(',') : [v, '1'];
const node = findNode(graph, ref);
if (!node) { notes.push(`No element "${ref}".`); return new Set(); }
const hops = Math.max(1, Math.min(Number(hopsText) || 1, 50));
return within(graph, node.id, hops);
}
case 'from':
from = v;
return undefined;
case 'to':
to = v;
return undefined;
}
return undefined;
};
const negated: Set<string>[] = [];
for (const term of terms) {
const ids = matching(term);
if (!ids) continue;
if (term.negate) {
negated.push(ids);
for (const id of ids) result.delete(id);
} else result = new Set([...result].filter((id) => ids.has(id)));
}
// Decisions and registries follow their elements: a matching element brings the nodes attached to it.
if (terms.length) {
for (const e of graph.edges) {
if (isConnection(e)) continue;
if (result.has(e.to) && graph.nodes.some((n) => n.id === e.from && !isElement(n))) result.add(e.from);
}
for (const ids of negated) for (const id of ids) result.delete(id);
}
if (from || to) {
if (!from || !to) notes.push('A path needs both from: and to:.');
else {
const a = findNode(graph, from);
const b = findNode(graph, to);
if (!a || !b) notes.push(`No element "${!a ? from : to}".`);
else {
const found = shortestPath(graph, a.id, b.id);
if (!found) notes.push(`No path from ${a.id} to ${b.id}.`);
else {
path = found.nodes;
pathEdges = new Set(found.edges);
result = new Set(found.nodes.filter((id) => result.has(id)));
}
}
if (!path) result = new Set();
}
}
const edges = new Set<string>();
for (const e of graph.edges) {
if (!result.has(e.from) || !result.has(e.to)) continue;
if (pathEdges && !pathEdges.has(e.id)) continue;
edges.add(e.id);
}
return { nodes: result, edges, path, message: notes[0], terms };
}
+194
View File
@@ -0,0 +1,194 @@
import { Decision, effectiveStatus, sortDecisions } from './decisions';
import { DecisionAttachment, DiagramSummary, RegistryElement } from './format';
import { ModelIndex } from './service';
/** A decision as the lists show it. */
export interface DecisionRow {
id: string;
title?: string;
/** Status shown: superseded when another decision supersedes it. */
status: string;
supersededBy?: string;
date?: string;
file: string;
}
/** A diagram an element is used in, as the pages show it. */
export interface UsedIn {
path: string;
title?: string;
kind?: string;
}
/** A registry element as the model page and the registry page show it. */
export interface ElementCard {
id: string;
label?: string;
sublabel?: string;
type?: string;
brand?: string;
description?: string;
/** Diagram that explains the element, relative to the model root. */
diagram?: string;
/** Registry file (relative to the model root) and 0-based line of the element. */
file: string;
line: number;
usedIn: UsedIn[];
/** Decisions about this element, from the decision files and from diagram attachments. */
decisions: DecisionRow[];
}
/** What the model page shows; serialised into the webview. */
export interface ModelPanel {
meta: { id?: string; name?: string; description?: string };
/** True when main.archify also carries a diagram, shown between metadata and the list. */
hasDiagram: boolean;
groups: { group: string; diagrams: { path: string; title?: string; kind?: string; parseError?: string }[] }[];
registry: ElementCard[];
decisions: DecisionRow[];
problems: string[];
nested: string[];
}
/** What the decision page (one .archify-decision file) shows. */
export interface DecisionPanel {
file: string;
inModel: boolean;
model?: { id?: string; name?: string };
decision?: DecisionRow & { context?: string; decision?: string; consequences?: string; supersedes: DecisionRow[] };
/** Decisions that supersede this one. */
supersededBy: DecisionRow[];
elements: ElementCard[];
/** Diagrams the decision names. */
diagrams: UsedIn[];
/** Diagrams that point at the decision, with where. */
referencedBy: { path: string; title?: string; kind?: string; attachedTo: DecisionAttachment }[];
problems: string[];
}
/** What the registry page (one .archify-registry file) shows. */
export interface RegistryPanel {
/** The registry file, relative to the model root (or its base name outside a model). */
file: string;
inModel: boolean;
model?: { id?: string; name?: string };
elements: ElementCard[];
problems: string[];
}
function usedIn(id: string, usage: Map<string, string[]>, diagrams: DiagramSummary[]): UsedIn[] {
return (usage.get(id) ?? []).map((path) => {
const summary = diagrams.find((d) => d.relativePath === path);
return { path, title: summary?.title, kind: summary?.kind };
});
}
export function decisionRow(d: Decision, all: Map<string, Decision>): DecisionRow {
const { status, supersededBy } = effectiveStatus(d, all);
return { id: d.id, title: d.title, status, supersededBy, date: d.date, file: d.file };
}
/** Decisions about an element: named by the decision, or attached to its node in some diagram. */
function decisionsOfElement(id: string, index: Pick<ModelIndex, 'decisions' | 'decisionUsage'> | undefined): DecisionRow[] {
if (!index) return [];
const all = index.decisions.decisions;
const ids = new Set<string>();
for (const d of all.values()) if (d.elements.includes(id)) ids.add(d.id);
for (const [decisionId, uses] of index.decisionUsage) if (uses.some((u) => u.attachedTo.kind === 'node' && u.attachedTo.id === id) && all.has(decisionId)) ids.add(decisionId);
return sortDecisions([...ids].map((x) => all.get(x)!), all).map((d) => decisionRow(d, all));
}
export function elementCard(e: RegistryElement, usage: Map<string, string[]>, diagrams: DiagramSummary[], index?: Pick<ModelIndex, 'decisions' | 'decisionUsage'>): ElementCard {
return {
id: e.id,
label: e.label,
sublabel: e.sublabel,
type: e.type,
brand: e.brand,
description: e.description,
diagram: e.diagram,
file: e.file,
line: e.line,
usedIn: usedIn(e.id, usage, diagrams),
decisions: decisionsOfElement(e.id, index),
};
}
const byId = (a: { id: string }, b: { id: string }) => a.id.localeCompare(b.id);
export function panelFromIndex(index: ModelIndex): ModelPanel {
const registry = [...index.registry.elements.values()].sort(byId).map((e) => elementCard(e, index.usage, index.diagrams, index));
const all = index.decisions.decisions;
return {
meta: index.meta,
decisions: sortDecisions([...all.values()], all).map((d) => decisionRow(d, all)),
hasDiagram: index.mainHasDiagram,
groups: index.groups.map((g) => ({
group: g.group,
diagrams: g.diagrams.map((d) => ({ path: d.relativePath, title: d.title, kind: d.kind, parseError: d.parseError })),
})),
registry,
problems: [...index.registry.problems, ...index.decisions.problems].map((p) => (p.file ? `${p.file}: ${p.message}` : p.message)),
nested: index.nested,
};
}
/** The registry page of one file inside a model: its elements, in file order, with usage. */
export function registryPanelFromIndex(index: ModelIndex, file: string): RegistryPanel {
const elements = [...index.registry.elements.values()]
.filter((e) => e.file === file)
.sort((a, b) => a.line - b.line)
.map((e) => elementCard(e, index.usage, index.diagrams, index));
return {
file,
inModel: true,
model: { id: index.meta.id, name: index.meta.name },
elements,
problems: index.registry.problems.filter((p) => p.file === file).map((p) => p.message),
};
}
/** The registry page of a file outside a model: elements only, nothing is used anywhere. */
export function registryPanelStandalone(file: string, parsed: { elements: RegistryElement[]; problems: { message: string }[] }): RegistryPanel {
return {
file,
inModel: false,
elements: parsed.elements.map((e) => elementCard(e, new Map(), [])),
problems: parsed.problems.map((p) => p.message),
};
}
/** The decision page of one file inside a model. */
export function decisionPanelFromIndex(index: ModelIndex, file: string): DecisionPanel {
const all = index.decisions.decisions;
const d = [...all.values()].find((x) => x.file === file);
const problems = index.decisions.problems.filter((p) => p.file === file).map((p) => p.message);
const base = { file, inModel: true, model: { id: index.meta.id, name: index.meta.name }, problems };
if (!d) return { ...base, supersededBy: [], elements: [], diagrams: [], referencedBy: [] };
const rows = (ids: string[]) => ids.filter((id) => all.has(id)).map((id) => decisionRow(all.get(id)!, all));
const elements = d.elements.filter((id) => index.registry.elements.has(id)).map((id) => elementCard(index.registry.elements.get(id)!, index.usage, index.diagrams, index));
const summary = (path: string) => index.diagrams.find((x) => x.relativePath === path);
return {
...base,
decision: { ...decisionRow(d, all), context: d.context, decision: d.decision, consequences: d.consequences, supersedes: rows(d.supersedes) },
supersededBy: [...all.values()].filter((x) => x.supersedes.includes(d.id)).map((x) => decisionRow(x, all)),
elements,
diagrams: d.diagrams.map((path) => ({ path, title: summary(path)?.title, kind: summary(path)?.kind })),
referencedBy: (index.decisionUsage.get(d.id) ?? []).map((u) => ({ path: u.path, title: summary(u.path)?.title, kind: summary(u.path)?.kind, attachedTo: u.attachedTo })),
};
}
/** The decision page of a file outside a model: the text only, and a note that it has lost its model. */
export function decisionPanelStandalone(file: string, parsed: { decision?: Decision; problems: { message: string }[] }): DecisionPanel {
const d = parsed.decision;
return {
file,
inModel: false,
decision: d ? { id: d.id, title: d.title, status: d.status ?? 'proposed', date: d.date, file, context: d.context, decision: d.decision, consequences: d.consequences, supersedes: d.supersedes.map((id) => ({ id, status: 'unknown', file: '' })) } : undefined,
supersededBy: [],
elements: [],
diagrams: d ? d.diagrams.map((path) => ({ path })) : [],
referencedBy: [],
problems: parsed.problems.map((p) => p.message),
};
}
+71
View File
@@ -0,0 +1,71 @@
import path from 'node:path';
import * as vscode from 'vscode';
import { DiagramSource, readDiagramSource } from '../sources/detect';
import { DecisionAttachment, ModelProblem, Registry, resolveRefs } from './format';
import { effectiveStatus } from './decisions';
import { ModelService } from './service';
/**
* A diagram ready for Archify: the source as written, plus the resolved JSON
* with registry references expanded, the model problems found on the way,
* and the diagram links the viewer should offer.
*/
export interface PreparedDiagram {
source: DiagramSource;
/** Model root when the file is inside a model. */
root?: vscode.Uri;
registry?: Registry;
problems: ModelProblem[];
/** Node id → diagram path relative to the model root. */
links: Map<string, string>;
/** Node id → registry description. */
descriptions: Map<string, string>;
/** Decisions of this diagram for the Decisions rail panel: pointed at by the diagram, or naming it. */
decisions: DiagramDecision[];
}
export interface DiagramDecision {
id: string;
title?: string;
status: string;
file: string;
attachedTo: DecisionAttachment[];
}
/**
* Reads a diagram and resolves it against its model, if any. Every place
* that hands a diagram to Archify (preview, Problems, render, browser) goes
* through here, so they all see the same resolved diagram.
*/
export async function prepareDiagram(models: ModelService, uri: vscode.Uri, text: string): Promise<PreparedDiagram | undefined> {
const source = readDiagramSource(text, uri.path);
if (!source) return undefined;
const index = await models.indexFor(uri);
const found = index ? { root: index.root, registry: index.registry } : undefined;
const resolved = resolveRefs(source.diagram, { registry: found?.registry, decisions: index ? new Set(index.decisions.decisions.keys()) : undefined, fileName: uri.path });
// Only diagrams that use refs (or carry a model block) need the resolved form.
const changed = resolved.refs.size > 0 || resolved.problems.length > 0 || 'model' in source.diagram || resolved.links.size > 0 || resolved.decisionRefs.length > 0;
const prepared: DiagramSource = changed
? { ...source, diagram: resolved.diagram, json: JSON.stringify(resolved.diagram, null, 2) }
: source;
// Decisions for the rail: the ones this diagram points at, plus the ones that name this diagram.
const decisions: DiagramDecision[] = [];
if (index) {
const rel = path.relative(index.root.fsPath, uri.fsPath).split(path.sep).join('/');
const byId = new Map<string, DiagramDecision>();
const add = (id: string, attachedTo?: DecisionAttachment) => {
const d = index.decisions.decisions.get(id);
if (!d) return;
let row = byId.get(id);
if (!row) {
row = { id, title: d.title, status: effectiveStatus(d, index.decisions.decisions).status, file: d.file, attachedTo: [] };
byId.set(id, row);
decisions.push(row);
}
if (attachedTo && !row.attachedTo.some((a) => JSON.stringify(a) === JSON.stringify(attachedTo))) row.attachedTo.push(attachedTo);
};
for (const ref of resolved.decisionRefs) add(ref.id, ref.attachedTo);
for (const d of index.decisions.decisions.values()) if (d.diagrams.includes(rel)) add(d.id, { kind: 'diagram' });
}
return { source: prepared, root: found?.root, registry: found?.registry, problems: resolved.problems, links: resolved.links, descriptions: resolved.descriptions, decisions };
}
+208
View File
@@ -0,0 +1,208 @@
import path from 'node:path';
import * as vscode from 'vscode';
import { log } from '../util/log';
import {
DecisionAttachment,
DiagramSummary,
MAIN_FILE,
ModelMeta,
REGISTRY_EXT,
Registry,
hasDiagramBody,
isMainFile,
isRegistryFile,
mergeRegistries,
parseRegistry,
readModelMeta,
sortedGroups,
summarizeDiagram,
} from './format';
import { parse as parseYaml } from 'yaml';
import { DECISION_EXT, DecisionSet, isDecisionFile, mergeDecisions, parseDecision, validateDecisions } from './decisions';
/**
* Finds models in the workspace and keeps what they contain. A model is the
* folder tree under a `main.archify`; this service answers "which model is
* this file in?", loads the model's registry, lists its diagrams, and tells
* listeners when any of that changes.
*/
export interface ModelIndex {
root: vscode.Uri;
main: vscode.Uri;
meta: ModelMeta;
/** True when main.archify also carries a diagram. */
mainHasDiagram: boolean;
registry: Registry;
diagrams: DiagramSummary[];
groups: { group: string; diagrams: DiagramSummary[] }[];
/** Element id → diagrams (relative paths) that refer to it. */
usage: Map<string, string[]>;
/** The model's decisions, with link problems already checked. */
decisions: DecisionSet;
/** Decision id → diagrams that point at it, with where. */
decisionUsage: Map<string, { path: string; attachedTo: DecisionAttachment }[]>;
/** Nested main.archify files found below the root; not supported. */
nested: string[];
}
const SKIP = '{**/node_modules/**,**/.git/**}';
async function exists(uri: vscode.Uri): Promise<boolean> {
try {
await vscode.workspace.fs.stat(uri);
return true;
} catch {
return false;
}
}
function text(bytes: Uint8Array): string {
return new TextDecoder('utf-8').decode(bytes);
}
/** Open editor text when the file is open, else the file on disk. */
async function readText(uri: vscode.Uri): Promise<string> {
const open = vscode.workspace.textDocuments.find((doc) => doc.uri.toString() === uri.toString());
if (open) return open.getText();
return text(await vscode.workspace.fs.readFile(uri));
}
export class ModelService implements vscode.Disposable {
private readonly roots = new Map<string, vscode.Uri | null>();
private readonly indexes = new Map<string, Promise<ModelIndex>>();
private readonly changeEmitter = new vscode.EventEmitter<{ root: vscode.Uri; file: vscode.Uri }>();
/** Fires with the model root and the file under it that changed. */
readonly onDidChangeModel = this.changeEmitter.event;
private readonly disposables: vscode.Disposable[];
constructor() {
const watcher = vscode.workspace.createFileSystemWatcher(`**/*{.archify,${REGISTRY_EXT},${DECISION_EXT}}`);
const changed = (uri: vscode.Uri) => void this.onFileChanged(uri);
this.disposables = [
watcher,
watcher.onDidCreate(changed),
watcher.onDidDelete(changed),
watcher.onDidChange(changed),
vscode.workspace.onDidChangeTextDocument((event) => {
// Registry edits in the editor should re-render open diagrams before a save.
if (isRegistryFile(event.document.fileName) || isMainFile(event.document.fileName) || isDecisionFile(event.document.fileName)) changed(event.document.uri);
}),
this.changeEmitter,
];
}
private async onFileChanged(uri: vscode.Uri): Promise<void> {
const name = path.basename(uri.path);
if (name === MAIN_FILE) this.roots.clear(); // a model may have appeared or disappeared
const root = await this.rootOf(uri);
if (!root) return;
this.indexes.delete(root.toString());
this.changeEmitter.fire({ root, file: uri });
}
/** The model root (folder with main.archify) above a file, or undefined. */
async rootOf(uri: vscode.Uri): Promise<vscode.Uri | undefined> {
if (uri.scheme !== 'file') return undefined;
const dirKey = path.dirname(uri.fsPath);
const cached = this.roots.get(dirKey);
if (cached !== undefined) return cached ?? undefined;
let dir = dirKey;
const visited: string[] = [];
let found: vscode.Uri | null = null;
for (;;) {
visited.push(dir);
if (await exists(vscode.Uri.file(path.join(dir, MAIN_FILE)))) {
found = vscode.Uri.file(dir);
break;
}
const parent = path.dirname(dir);
if (parent === dir) break;
dir = parent;
}
for (const d of visited) this.roots.set(d, found);
return found ?? undefined;
}
/** The model index of the model a file belongs to, or undefined outside a model. */
async indexFor(uri: vscode.Uri): Promise<ModelIndex | undefined> {
const root = await this.rootOf(uri);
return root ? this.index(root) : undefined;
}
/** The registry of the model a file belongs to, or undefined outside a model. */
async registryFor(uri: vscode.Uri): Promise<{ root: vscode.Uri; registry: Registry } | undefined> {
const root = await this.rootOf(uri);
if (!root) return undefined;
const index = await this.index(root);
return { root, registry: index.registry };
}
/** Everything known about a model, cached until a file under it changes. */
index(root: vscode.Uri): Promise<ModelIndex> {
const key = root.toString();
let pending = this.indexes.get(key);
if (!pending) {
pending = this.build(root).catch((error) => {
this.indexes.delete(key);
throw error;
});
this.indexes.set(key, pending);
}
return pending;
}
private async build(root: vscode.Uri): Promise<ModelIndex> {
const main = vscode.Uri.joinPath(root, MAIN_FILE);
let meta: ModelMeta = {};
let mainHasDiagram = false;
try {
const doc = parseYaml(await readText(main), { prettyErrors: false, uniqueKeys: false });
meta = readModelMeta(doc) ?? {};
mainHasDiagram = hasDiagramBody(doc);
} catch (error) {
log().warn(`main.archify of ${root.fsPath} does not parse: ${error instanceof Error ? error.message : String(error)}`);
}
const registryFiles = await vscode.workspace.findFiles(new vscode.RelativePattern(root, `**/*${REGISTRY_EXT}`), SKIP);
const parts = await Promise.all(
registryFiles.sort((a, b) => a.fsPath.localeCompare(b.fsPath)).map(async (file) => {
const rel = path.relative(root.fsPath, file.fsPath);
return { file: rel, ...parseRegistry(await readText(file), rel) };
}),
);
const registry = mergeRegistries(parts);
const diagramFiles = await vscode.workspace.findFiles(new vscode.RelativePattern(root, '**/*.archify'), SKIP);
const nested: string[] = [];
const diagrams: DiagramSummary[] = [];
for (const file of diagramFiles) {
const rel = path.relative(root.fsPath, file.fsPath).split(path.sep).join('/');
if (rel === MAIN_FILE) continue;
if (path.basename(file.fsPath) === MAIN_FILE) {
nested.push(rel);
continue;
}
diagrams.push(summarizeDiagram(await readText(file), rel));
}
const usage = new Map<string, string[]>();
for (const d of diagrams) for (const id of d.used) usage.set(id, [...(usage.get(id) ?? []), d.relativePath]);
const decisionFiles = await vscode.workspace.findFiles(new vscode.RelativePattern(root, `**/*${DECISION_EXT}`), SKIP);
const decisionParts = await Promise.all(
decisionFiles.sort((a, b) => a.fsPath.localeCompare(b.fsPath)).map(async (file) => {
const rel = path.relative(root.fsPath, file.fsPath).split(path.sep).join('/');
return { file: rel, ...parseDecision(await readText(file), rel) };
}),
);
const decisions = mergeDecisions(decisionParts);
decisions.problems.push(...validateDecisions(decisions, registry, new Set(diagrams.map((d) => d.relativePath))));
const decisionUsage = new Map<string, { path: string; attachedTo: DecisionAttachment }[]>();
for (const d of diagrams) for (const ref of d.decisions) decisionUsage.set(ref.id, [...(decisionUsage.get(ref.id) ?? []), { path: d.relativePath, attachedTo: ref.attachedTo }]);
return { root, main, meta, mainHasDiagram, registry, diagrams, groups: sortedGroups(diagrams), usage, decisions, decisionUsage, nested };
}
dispose(): void {
for (const d of this.disposables.splice(0)) d.dispose();
}
}
+64
View File
@@ -0,0 +1,64 @@
// Text helpers shared by the host and the Source view in the page. The page's
// editor always works in "\n" text; documents may use "\r\n".
export interface TextChange {
from: number;
to: number;
insert: string;
}
/** The text with "\r\n" turned into "\n". */
export function normalizeEol(text: string): string {
return text.replace(/\r\n/g, '\n');
}
/**
* The smallest single change that turns `before` into `after`: the common
* start and end are kept, so a cursor outside the change stays put.
*/
export function minimalChange(before: string, after: string): TextChange | undefined {
if (before === after) return undefined;
let start = 0;
const max = Math.min(before.length, after.length);
while (start < max && before.charCodeAt(start) === after.charCodeAt(start)) start++;
let endBefore = before.length;
let endAfter = after.length;
while (endBefore > start && endAfter > start && before.charCodeAt(endBefore - 1) === after.charCodeAt(endAfter - 1)) {
endBefore--;
endAfter--;
}
return { from: start, to: endBefore, insert: after.slice(start, endAfter) };
}
/** Line and character of an offset into "\n" text. */
export function positionOf(text: string, offset: number): { line: number; character: number } {
const clamped = Math.max(0, Math.min(offset, text.length));
let line = 0;
let lineStart = 0;
for (let i = text.indexOf('\n'); i !== -1 && i < clamped; i = text.indexOf('\n', i + 1)) {
line++;
lineStart = i + 1;
}
return { line, character: clamped - lineStart };
}
/** Offset into "\n" text of a line and character (clamped to the line). */
export function offsetOf(text: string, line: number, character: number): number {
let start = 0;
for (let l = 0; l < line; l++) {
const next = text.indexOf('\n', start);
if (next === -1) return text.length;
start = next + 1;
}
const end = text.indexOf('\n', start);
return Math.min(start + Math.max(0, character), end === -1 ? text.length : end);
}
/** Applies changes given in the coordinates of `text` (as one editor transaction reports them). */
export function applyChanges(text: string, changes: TextChange[]): string {
let out = text;
for (const change of [...changes].sort((a, b) => b.from - a.from)) {
out = out.slice(0, change.from) + change.insert + out.slice(change.to);
}
return out;
}
+13 -16
View File
@@ -2,6 +2,7 @@ import { layerMarkup, rasterize } from './raster';
import { CameraState, Layers, Stage } from './stage'; import { CameraState, Layers, Stage } from './stage';
import { DiagramModel, readModel } from './svgModel'; import { DiagramModel, readModel } from './svgModel';
import { STYLE } from './style'; import { STYLE } from './style';
import type { ArchifyHost } from '../webview/host';
/** /**
* 3D mode for the Archify viewer. It adds a 2D | 3D switch to Archify's * 3D mode for the Archify viewer. It adds a 2D | 3D switch to Archify's
@@ -12,12 +13,7 @@ import { STYLE } from './style';
* follows Archify's animations as they play. * follows Archify's animations as they play.
*/ */
interface Host { type Host = ArchifyHost;
defaultView: '2d' | '3d';
post(message: unknown): void;
getState(): Record<string, unknown>;
setState(patch: Record<string, unknown>): void;
}
interface SavedView { interface SavedView {
active?: boolean; active?: boolean;
@@ -25,12 +21,6 @@ interface SavedView {
camera?: CameraState; camera?: CameraState;
} }
declare global {
interface Window {
__archifyHost?: Host;
}
}
const REDRAW_MS = 220; const REDRAW_MS = 220;
const MARGIN = 80; const MARGIN = 80;
/** Texture pixels per SVG unit; more costs memory and upload time for little gain. */ /** Texture pixels per SVG unit; more costs memory and upload time for little gain. */
@@ -68,13 +58,20 @@ class Viewer3D {
this.interceptViewerControls(); this.interceptViewerControls();
if (this.saved.active ?? host.defaultView === '3d') this.setActive(true); if (this.saved.active ?? host.defaultView === '3d') this.setActive(true);
else this.syncButtons(); else this.syncButtons();
// The Source view hides the picture; the stage stops drawing meanwhile.
window.addEventListener('archify-source', (event) => {
if (!this.active || !this.stage) return;
if ((event as CustomEvent<{ on: boolean }>).detail.on) this.stage.stop();
else this.stage.start();
});
} }
// -------------------------------------------------------------- chrome // -------------------------------------------------------------- chrome
/** /**
* The 2D | 3D switch: Export's twin in the toolbar. Both states are always * The 2D | 3D switch in the toolbar, left of Diagram | Graph | Source (it
* visible, the filled half is the current one, a click flips it. * says how the picture is drawn, that one what is shown). Both states are
* always visible, the filled half is the current one, a click flips it.
*/ */
private buildSwitch(): HTMLButtonElement { private buildSwitch(): HTMLButtonElement {
const button = document.createElement('button'); const button = document.createElement('button');
@@ -89,8 +86,8 @@ class Viewer3D {
event.stopPropagation(); event.stopPropagation();
this.setActive(!this.active); this.setActive(!this.active);
}); });
const exportWrap = document.querySelector('.toolbar .export-wrap'); const anchor = document.querySelector('.toolbar #archify-mode-switch') ?? document.querySelector('.toolbar .export-wrap');
if (exportWrap?.parentElement) exportWrap.parentElement.insertBefore(button, exportWrap); if (anchor?.parentElement) anchor.parentElement.insertBefore(button, anchor);
else document.querySelector('.toolbar')?.appendChild(button); else document.querySelector('.toolbar')?.appendChild(button);
return button; return button;
} }
+173
View File
@@ -0,0 +1,173 @@
import path from 'node:path';
import * as vscode from 'vscode';
import { isDecisionFile, parseDecision } from '../model/decisions';
import { isMainFile, isRegistryFile } from '../model/format';
import { DecisionPanel, decisionPanelFromIndex, decisionPanelStandalone } from '../model/panel';
import { ModelService } from '../model/service';
import { readText } from '../util/files';
import { log } from '../util/log';
import { sourceScriptUri } from '../webview/viewer3d';
import { SourceSession } from './sourceSession';
import { handleWebviewMessage, WebviewMessage } from '../webview/messages';
import { decisionPage, makeNonce } from '../webview/page';
import { DECISION_VIEW_TYPE, DIAGRAM_EDITOR_VIEW_TYPE, REGISTRY_VIEW_TYPE } from './viewTypes';
export { DECISION_VIEW_TYPE };
class DecisionView implements vscode.Disposable {
private seq = 0;
private timer: NodeJS.Timeout | undefined;
private last: string | undefined;
root: vscode.Uri | undefined;
private readonly disposables: vscode.Disposable[] = [];
/** The Source view; while it shows, a new page waits in `heldHtml`. */
readonly source: SourceSession;
private heldHtml: string | undefined;
constructor(
private readonly context: vscode.ExtensionContext,
private readonly models: ModelService,
readonly panel: vscode.WebviewPanel,
readonly uri: vscode.Uri,
) {
this.source = new SourceSession(context, panel, uri, 'decision', (shown) => {
if (!shown && this.heldHtml !== undefined) {
const html = this.heldHtml;
this.heldHtml = undefined;
this.panel.webview.html = html;
}
});
this.disposables.push(
this.source,
panel.webview.onDidReceiveMessage((message: WebviewMessage) => {
if (this.source.handle(message)) return;
if (message.type === 'openDiagram') return void this.openInModel(message.path, DIAGRAM_EDITOR_VIEW_TYPE);
if (message.type === 'openRegistry') return void this.openRegistryLine(message.file, message.line);
if (message.type === 'openDecision') return void this.openInModel(message.file, DECISION_VIEW_TYPE);
void handleWebviewMessage(message, this.uri, this.panel);
}),
);
void this.update();
}
private async openInModel(relativePath: string, viewType: string): Promise<void> {
if (!this.root) return;
const target = vscode.Uri.joinPath(this.root, ...relativePath.split('/'));
try {
await vscode.workspace.fs.stat(target);
} catch {
vscode.window.showWarningMessage(`Archify: ${relativePath} does not exist in this model.`);
return;
}
await vscode.commands.executeCommand('vscode.openWith', target, viewType, vscode.ViewColumn.Active);
}
private async openRegistryLine(file: string, line?: number): Promise<void> {
if (!this.root) return;
const target = vscode.Uri.joinPath(this.root, ...file.split('/'));
const column = this.panel.viewColumn === vscode.ViewColumn.One ? vscode.ViewColumn.Two : vscode.ViewColumn.One;
const at = Math.max(line ?? 0, 0);
await vscode.window.showTextDocument(target, { viewColumn: column, selection: new vscode.Range(at, 0, at, 0) });
}
scheduleUpdate(): void {
clearTimeout(this.timer);
this.timer = setTimeout(() => void this.update(), 300);
}
async update(): Promise<void> {
clearTimeout(this.timer);
const seq = ++this.seq;
let decision: DecisionPanel;
try {
this.root = await this.models.rootOf(this.uri);
if (this.root) {
const rel = path.relative(this.root.fsPath, this.uri.fsPath).split(path.sep).join('/');
decision = decisionPanelFromIndex(await this.models.index(this.root), rel);
} else {
const name = path.basename(this.uri.path);
decision = decisionPanelStandalone(name, parseDecision(await readText(this.uri), name));
}
} catch (error) {
log().warn(`Decision view failed for ${this.uri.fsPath}: ${error instanceof Error ? error.message : String(error)}`);
return;
}
if (seq !== this.seq) return;
const fingerprint = JSON.stringify(decision);
if (fingerprint === this.last) return;
this.last = fingerprint;
const html = decisionPage(
{ cspSource: this.panel.webview.cspSource, nonce: makeNonce(), source: { scriptUri: sourceScriptUri(this.panel.webview, this.context.extensionUri), left: 'View' } },
decision,
);
if (this.source.shown) this.heldHtml = html;
else this.panel.webview.html = html;
}
dispose(): void {
clearTimeout(this.timer);
for (const d of this.disposables.splice(0)) d.dispose();
}
}
/** Custom editor for .archify-decision files: the decision as a page, with its elements and diagrams. */
export class DecisionViewProvider implements vscode.CustomTextEditorProvider, vscode.Disposable {
private readonly views = new Set<DecisionView>();
private active: DecisionView | undefined;
private readonly disposables: vscode.Disposable[];
constructor(
private readonly context: vscode.ExtensionContext,
private readonly models: ModelService,
) {
this.disposables = [
vscode.window.registerCustomEditorProvider(DECISION_VIEW_TYPE, this, {
webviewOptions: { retainContextWhenHidden: true, enableFindWidget: true },
supportsMultipleEditorsPerDocument: true,
}),
models.onDidChangeModel(({ root }) => {
for (const view of this.views) if (view.root?.toString() === root.toString()) view.scheduleUpdate();
}),
vscode.workspace.onDidChangeTextDocument((event) => {
if (!isDecisionFile(event.document.fileName) && !isRegistryFile(event.document.fileName) && !isMainFile(event.document.fileName)) return;
for (const view of this.views) if (!view.root && view.uri.toString() === event.document.uri.toString()) view.scheduleUpdate();
}),
];
}
/** File shown in the focused decision view, if any. */
get activeUri(): vscode.Uri | undefined {
return this.active?.uri;
}
/** The view of the focused page, if any. */
get activeView(): { source: SourceSession } | undefined {
return this.active;
}
// A text editor provider: the page edits the file's own TextDocument (in
// its Source view), so dirty state, save and undo are VS Code's.
async resolveCustomTextEditor(document: vscode.TextDocument, panel: vscode.WebviewPanel): Promise<void> {
panel.webview.options = { enableScripts: true };
const view = new DecisionView(this.context, this.models, panel, document.uri);
this.views.add(view);
const onViewState = () => {
if (panel.active) this.active = view;
else if (this.active === view) this.active = undefined;
if (panel.active) void vscode.commands.executeCommand('setContext', 'archify.inModel', Boolean(view.root));
};
panel.onDidChangeViewState(onViewState);
onViewState();
panel.onDidDispose(() => {
this.views.delete(view);
if (this.active === view) this.active = undefined;
view.dispose();
});
}
dispose(): void {
for (const view of this.views) view.dispose();
this.views.clear();
for (const d of this.disposables.splice(0)) d.dispose();
}
}
+238 -20
View File
@@ -2,23 +2,39 @@ import path from 'node:path';
import * as vscode from 'vscode'; import * as vscode from 'vscode';
import { renderDiagram } from '../archify/cli'; import { renderDiagram } from '../archify/cli';
import { evidenceMode, runtimeFor } from '../archify/runtime'; import { evidenceMode, runtimeFor } from '../archify/runtime';
import { isArchifyFile, readDiagramSource } from '../sources/detect'; import { MAIN_FILE, isMainFile, isRegistryFile } from '../model/format';
import { buildGraph } from '../model/graph';
import { ModelPanel, panelFromIndex } from '../model/panel';
import { prepareDiagram } from '../model/prepare';
import { ModelService } from '../model/service';
import { isArchifyFile } from '../sources/detect';
import { readText } from '../util/files'; import { readText } from '../util/files';
import { log } from '../util/log'; import { log } from '../util/log';
import { viewerTheme } from '../util/settings'; import { viewerTheme } from '../util/settings';
import { handleWebviewMessage, WebviewMessage } from '../webview/messages'; import { handleWebviewMessage, WebviewMessage } from '../webview/messages';
import { makeNonce, messagePage, prepareDiagramHtml } from '../webview/page'; import { graphPage, makeNonce, messagePage, modelPage, prepareDiagramHtml } from '../webview/page';
import { viewer3dOption, viewerRoots } from '../webview/viewer3d'; import { graphScriptUri, sourceScriptUri, viewer3dOption, viewerRoots } from '../webview/viewer3d';
import { SourceSession } from './sourceSession';
export const PREVIEW_VIEW_TYPE = 'archify.preview'; import { DECISION_VIEW_TYPE, DIAGRAM_EDITOR_VIEW_TYPE, PREVIEW_VIEW_TYPE, REGISTRY_VIEW_TYPE } from './viewTypes';
/** Default editor for .archify files: the rendered diagram. */
export const DIAGRAM_EDITOR_VIEW_TYPE = 'archify.diagram'; export { DIAGRAM_EDITOR_VIEW_TYPE, PREVIEW_VIEW_TYPE };
interface PreviewState { interface PreviewState {
uri: string; uri: string;
hash?: string; hash?: string;
/** main.archify only: the Graph page is shown instead of the model page. */
graph?: boolean;
} }
/** What a preview asks of its manager. */
interface PreviewHost {
/** Opens the Graph page of the model at `root`, with a query to start from. */
openGraph(root: vscode.Uri, query?: string): Promise<void>;
}
const GRAPH_MODE_KEY = 'archify.graphMode';
class DiagramPreview implements vscode.Disposable { class DiagramPreview implements vscode.Disposable {
private seq = 0; private seq = 0;
private hash: string | undefined; private hash: string | undefined;
@@ -28,9 +44,22 @@ class DiagramPreview implements vscode.Disposable {
private readonly disposables: vscode.Disposable[] = []; private readonly disposables: vscode.Disposable[] = [];
private readonly onDisposeEmitter = new vscode.EventEmitter<void>(); private readonly onDisposeEmitter = new vscode.EventEmitter<void>();
readonly onDidDispose = this.onDisposeEmitter.event; readonly onDidDispose = this.onDisposeEmitter.event;
/** Root of the model this file belongs to, once known. */
root: vscode.Uri | undefined;
/** main.archify: show the Graph page instead of the model page. Remembered per file across reloads. */
private graph = false;
private graphQuery: string | undefined;
/** True while the webview shows the Graph page, which takes model updates as messages. */
private graphShown = false;
/** The Source view of a .archify file; while it shows, new HTML waits in `heldHtml`. */
readonly source: SourceSession | undefined;
private heldHtml: string | undefined;
private disposed = false;
constructor( constructor(
private readonly context: vscode.ExtensionContext, private readonly context: vscode.ExtensionContext,
private readonly models: ModelService,
private readonly host: PreviewHost,
readonly panel: vscode.WebviewPanel, readonly panel: vscode.WebviewPanel,
readonly uri: vscode.Uri, readonly uri: vscode.Uri,
state?: PreviewState, state?: PreviewState,
@@ -38,19 +67,54 @@ class DiagramPreview implements vscode.Disposable {
readonly isEditor = false, readonly isEditor = false,
) { ) {
this.hash = state?.hash; this.hash = state?.hash;
this.graph = state?.graph ?? this.graphModes()[uri.toString()] === true;
panel.webview.options = { enableScripts: true, localResourceRoots: viewerRoots(this.context.extensionUri) }; panel.webview.options = { enableScripts: true, localResourceRoots: viewerRoots(this.context.extensionUri) };
if (!isEditor) { if (!isEditor) {
panel.iconPath = vscode.Uri.joinPath(context.extensionUri, 'media', 'preview.svg'); panel.iconPath = vscode.Uri.joinPath(context.extensionUri, 'media', 'preview.svg');
panel.title = `Preview ${path.basename(uri.path)}`; panel.title = `Preview ${path.basename(uri.path)}`;
} }
if (isArchifyFile(uri.path)) {
this.source = new SourceSession(context, panel, uri, 'diagram', (shown) => {
// Back from Source: show what was rendered meanwhile.
if (!shown && this.heldHtml !== undefined) {
const html = this.heldHtml;
this.heldHtml = undefined;
this.panel.webview.html = html;
}
});
this.disposables.push(this.source);
}
this.disposables.push( this.disposables.push(
panel.onDidDispose(() => this.dispose()), panel.onDidDispose(() => this.dispose()),
panel.webview.onDidReceiveMessage((message: WebviewMessage) => { panel.webview.onDidReceiveMessage((message: WebviewMessage) => {
if (this.source?.handle(message)) return;
if (message.type === 'hash') { if (message.type === 'hash') {
this.hash = message.hash; this.hash = message.hash;
return; return;
} }
if (message.type === 'openDiagram') {
void this.openLinked(message.path, DIAGRAM_EDITOR_VIEW_TYPE);
return;
}
if (message.type === 'openRegistry') {
void this.openLinked(message.file, REGISTRY_VIEW_TYPE);
return;
}
if (message.type === 'openDecision') {
void this.openLinked(message.file, DECISION_VIEW_TYPE);
return;
}
if (message.type === 'showGraph') {
if (isMainFile(this.uri.path)) this.setGraph(true, message.query);
else if (this.root) void this.host.openGraph(this.root, message.query);
return;
}
if (message.type === 'showModel') {
this.setGraph(false);
return;
}
void handleWebviewMessage(message, this.uri, this.panel); void handleWebviewMessage(message, this.uri, this.panel);
}), }),
); );
@@ -70,18 +134,99 @@ class DiagramPreview implements vscode.Disposable {
void this.update(); void this.update();
} }
/** Posts to the webview; a panel closed mid-update is not an error. */
private post(message: unknown): void {
Promise.resolve(this.panel.webview.postMessage(message)).catch(() => undefined);
}
/** Replaces the page, unless Source is open in it: then the page waits until it closes. */
private setHtml(html: string): void {
if (this.disposed) return;
if (this.source?.shown) {
this.heldHtml = html;
return;
}
this.heldHtml = undefined;
this.panel.webview.html = html;
}
/** Page option for the Source view, on .archify files. */
private sourceOption(left: 'Model' | 'Diagram'): { scriptUri: string; left: 'Model' | 'Diagram' } | undefined {
return this.source ? { scriptUri: sourceScriptUri(this.panel.webview, this.context.extensionUri), left } : undefined;
}
private state(): PreviewState { private state(): PreviewState {
return { uri: this.uri.toString(), hash: this.hash }; return { uri: this.uri.toString(), hash: this.hash, graph: this.graph };
}
private graphModes(): Record<string, boolean> {
return this.context.workspaceState.get<Record<string, boolean>>(GRAPH_MODE_KEY, {});
}
/** Switches a main.archify editor between its model page and the Graph page. */
setGraph(on: boolean, query?: string): void {
this.graph = on;
this.graphQuery = query;
const modes = this.graphModes();
if (on) modes[this.uri.toString()] = true;
else delete modes[this.uri.toString()];
void this.context.workspaceState.update(GRAPH_MODE_KEY, modes);
this.lastHtml = undefined;
this.rendered = false;
if (!on) this.graphShown = false;
else if (this.graphShown && query !== undefined) this.post({ type: 'query', query });
void this.update(true);
}
/** The Graph page of the model, or an update of it when it is already showing. */
private showGraphPage(index: Awaited<ReturnType<ModelService['index']>>): void {
const graph = buildGraph(index);
const fingerprint = `graph\u0000${JSON.stringify(graph)}`;
if (fingerprint === this.lastHtml && this.graphShown) return;
this.lastHtml = fingerprint;
this.rendered = false;
if (this.graphShown) {
this.post({ type: 'graph', graph });
return;
}
this.graphShown = true;
this.setHtml(graphPage(
{ cspSource: this.panel.webview.cspSource, nonce: makeNonce(), state: this.state() },
{ graph, query: this.graphQuery, scriptUri: graphScriptUri(this.panel.webview, this.context.extensionUri) },
));
this.graphQuery = undefined;
} }
private showMessage(title: string, body: string, detail?: string): void { private showMessage(title: string, body: string, detail?: string): void {
this.lastHtml = undefined; this.lastHtml = undefined;
this.panel.webview.html = messagePage( this.setHtml(messagePage(
{ cspSource: this.panel.webview.cspSource, nonce: makeNonce(), state: this.state() }, { cspSource: this.panel.webview.cspSource, nonce: makeNonce(), state: this.state(), source: this.sourceOption('Diagram') },
title, title,
body, body,
detail, detail,
); ));
}
/** Opens a diagram of the model, given its path relative to the model root. */
private async openLinked(relativePath: string, viewType: string): Promise<void> {
if (!this.root) return;
const target = vscode.Uri.joinPath(this.root, ...relativePath.split('/'));
try {
await vscode.workspace.fs.stat(target);
} catch {
vscode.window.showWarningMessage(`Archify: ${relativePath} does not exist in this model.`);
return;
}
await vscode.commands.executeCommand('vscode.openWith', target, viewType, vscode.ViewColumn.Active);
}
private showModelPage(model: ModelPanel): void {
const fingerprint = `model\u0000${JSON.stringify(model)}`;
if (fingerprint === this.lastHtml) return;
this.lastHtml = fingerprint;
this.rendered = false;
this.graphShown = false;
this.setHtml(modelPage({ cspSource: this.panel.webview.cspSource, nonce: makeNonce(), state: this.state(), source: this.sourceOption('Model') }, model));
} }
scheduleUpdate(): void { scheduleUpdate(): void {
@@ -92,6 +237,7 @@ class DiagramPreview implements vscode.Disposable {
async update(force = false): Promise<void> { async update(force = false): Promise<void> {
clearTimeout(this.timer); clearTimeout(this.timer);
if (this.disposed) return;
const seq = ++this.seq; const seq = ++this.seq;
let text: string; let text: string;
try { try {
@@ -100,14 +246,44 @@ class DiagramPreview implements vscode.Disposable {
this.showMessage('Cannot read diagram', this.uri.fsPath, error instanceof Error ? error.message : String(error)); this.showMessage('Cannot read diagram', this.uri.fsPath, error instanceof Error ? error.message : String(error));
return; return;
} }
const source = readDiagramSource(text, this.uri.path); // main.archify: the model page wraps the diagram, or stands alone.
if (!source) { const main = isMainFile(this.uri.path) && this.uri.scheme === 'file';
let model: ModelPanel | undefined;
if (main) {
this.root = vscode.Uri.file(path.dirname(this.uri.fsPath));
try {
const index = await this.models.index(this.root);
if (seq !== this.seq) return;
if (this.graph) {
this.showGraphPage(index);
return;
}
model = panelFromIndex(index);
} catch (error) {
log().warn(`Model index failed for ${this.root.fsPath}: ${error instanceof Error ? error.message : String(error)}`);
}
}
let prepared;
try {
prepared = await prepareDiagram(this.models, this.uri, text);
} catch (error) {
log().warn(`Could not resolve ${this.uri.fsPath}: ${error instanceof Error ? error.message : String(error)}`);
}
if (seq !== this.seq) return;
if (!main) this.root = prepared?.root;
this.graphShown = false;
if (!prepared) {
if (model) {
this.showModelPage(model);
return;
}
this.showMessage( this.showMessage(
'Nothing to show yet', 'Nothing to show yet',
`Set "diagram_type" to architecture, workflow, sequence, dataflow or lifecycle, and make sure the file is valid ${isArchifyFile(this.uri.path) ? 'YAML' : 'JSON'}.`, `Set "diagram_type" to architecture, workflow, sequence, dataflow or lifecycle, and make sure the file is valid ${isArchifyFile(this.uri.path) ? 'YAML' : 'JSON'}.`,
); );
return; return;
} }
const source = prepared.source;
let result; let result;
try { try {
@@ -121,7 +297,7 @@ class DiagramPreview implements vscode.Disposable {
if (!result.ok || !result.html) { if (!result.ok || !result.html) {
log().warn(`Render failed for ${this.uri.fsPath}: ${result.error}`); log().warn(`Render failed for ${this.uri.fsPath}: ${result.error}`);
if (this.rendered && this.lastHtml) { if (this.rendered && this.lastHtml) {
void this.panel.webview.postMessage({ this.post({
type: 'notice', type: 'notice',
notice: { kind: 'error', text: `Render failed; showing the last successful render.\n${firstLines(result.error)}` }, notice: { kind: 'error', text: `Render failed; showing the last successful render.\n${firstLines(result.error)}` },
}); });
@@ -139,19 +315,29 @@ class DiagramPreview implements vscode.Disposable {
state: this.state(), state: this.state(),
notice: result.evidenceNotice ? { kind: 'warning', text: result.evidenceNotice } : undefined, notice: result.evidenceNotice ? { kind: 'warning', text: result.evidenceNotice } : undefined,
viewer3d: viewer3dOption(this.panel.webview, this.context.extensionUri), viewer3d: viewer3dOption(this.panel.webview, this.context.extensionUri),
links: Object.fromEntries(prepared.links),
descriptions: Object.fromEntries(prepared.descriptions),
decisions: prepared.decisions,
model,
graphSwitch: main ? { left: 'Model' } : prepared.root ? { left: 'Diagram', query: `diagram:${path.relative(prepared.root.fsPath, this.uri.fsPath).split(path.sep).join('/')}` } : undefined,
source: this.sourceOption(main ? 'Model' : 'Diagram'),
}); });
// Nonces differ per render, so compare the renderer output instead. // Nonces differ per render, so compare the renderer output instead.
const fingerprint = `${viewerTheme()}\u0000${result.evidenceNotice ?? ''}\u0000${result.html}`; const fingerprint = `${viewerTheme()}\u0000${result.evidenceNotice ?? ''}\u0000${JSON.stringify([model ?? null, [...prepared.links], [...prepared.descriptions], prepared.decisions])}\u0000${result.html}`;
if (!force && this.rendered && fingerprint === this.lastHtml) { if (!force && this.rendered && fingerprint === this.lastHtml) {
void this.panel.webview.postMessage({ type: 'notice', notice: undefined }); this.post({ type: 'notice', notice: undefined });
return; return;
} }
this.lastHtml = fingerprint; this.lastHtml = fingerprint;
this.rendered = true; this.rendered = true;
this.panel.webview.html = html; this.setHtml(html);
} }
dispose(): void { dispose(): void {
if (this.disposed) return;
this.disposed = true;
// Renders in flight check the sequence after every await; this ends them.
this.seq++;
clearTimeout(this.timer); clearTimeout(this.timer);
this.onDisposeEmitter.fire(); this.onDisposeEmitter.fire();
this.onDisposeEmitter.dispose(); this.onDisposeEmitter.dispose();
@@ -173,8 +359,20 @@ export class DiagramViewManager
private active: DiagramPreview | undefined; private active: DiagramPreview | undefined;
private readonly disposables: vscode.Disposable[] = []; private readonly disposables: vscode.Disposable[] = [];
constructor(private readonly context: vscode.ExtensionContext) { constructor(
private readonly context: vscode.ExtensionContext,
private readonly models: ModelService,
) {
this.disposables.push( this.disposables.push(
// A registry or main.archify change re-renders every diagram of the model;
// any other file change only refreshes the model page's list.
models.onDidChangeModel(({ root, file }) => {
const whole = isRegistryFile(file.path) || isMainFile(file.path);
for (const preview of [...this.previews.values(), ...this.editors]) {
if (preview.root?.toString() !== root.toString()) continue;
if (whole || isMainFile(preview.uri.path)) preview.scheduleUpdate();
}
}),
vscode.window.registerWebviewPanelSerializer(PREVIEW_VIEW_TYPE, this), vscode.window.registerWebviewPanelSerializer(PREVIEW_VIEW_TYPE, this),
vscode.window.registerCustomEditorProvider(DIAGRAM_EDITOR_VIEW_TYPE, this, { vscode.window.registerCustomEditorProvider(DIAGRAM_EDITOR_VIEW_TYPE, this, {
webviewOptions: { retainContextWhenHidden: true, enableFindWidget: true }, webviewOptions: { retainContextWhenHidden: true, enableFindWidget: true },
@@ -207,10 +405,29 @@ export class DiagramViewManager
return [...this.previews.values(), ...this.editors].filter((preview) => preview.uri.toString() === key); return [...this.previews.values(), ...this.editors].filter((preview) => preview.uri.toString() === key);
} }
private readonly host: PreviewHost = { openGraph: (root, query) => this.showGraph(root, query) };
/** Opening a .archify file lands here: the diagram is the editor. */ /** Opening a .archify file lands here: the diagram is the editor. */
async resolveCustomTextEditor(document: vscode.TextDocument, panel: vscode.WebviewPanel): Promise<void> { async resolveCustomTextEditor(document: vscode.TextDocument, panel: vscode.WebviewPanel): Promise<void> {
panel.webview.options = { enableScripts: true, localResourceRoots: viewerRoots(this.context.extensionUri) }; panel.webview.options = { enableScripts: true, localResourceRoots: viewerRoots(this.context.extensionUri) };
this.track(new DiagramPreview(this.context, panel, document.uri, undefined, true)); this.track(new DiagramPreview(this.context, this.models, this.host, panel, document.uri, undefined, true));
}
/** Opens the model's main.archify as its Graph page, with a query to start from. */
async showGraph(root: vscode.Uri, query?: string): Promise<void> {
const main = vscode.Uri.joinPath(root, MAIN_FILE);
await vscode.commands.executeCommand('vscode.openWith', main, DIAGRAM_EDITOR_VIEW_TYPE, vscode.ViewColumn.Active);
const key = main.toString();
const deadline = Date.now() + 5000;
for (;;) {
const editor = [...this.editors].find((e) => e.uri.toString() === key && e.panel.active) ?? [...this.editors].find((e) => e.uri.toString() === key);
if (editor) {
editor.setGraph(true, query);
return;
}
if (Date.now() > deadline) return;
await new Promise((resolve) => setTimeout(resolve, 100));
}
} }
show(uri: vscode.Uri, viewColumn: vscode.ViewColumn, preserveFocus = false): void { show(uri: vscode.Uri, viewColumn: vscode.ViewColumn, preserveFocus = false): void {
@@ -225,7 +442,7 @@ export class DiagramViewManager
{ viewColumn, preserveFocus }, { viewColumn, preserveFocus },
{ enableScripts: true, retainContextWhenHidden: true, enableFindWidget: true, localResourceRoots: viewerRoots(this.context.extensionUri) }, { enableScripts: true, retainContextWhenHidden: true, enableFindWidget: true, localResourceRoots: viewerRoots(this.context.extensionUri) },
); );
this.track(new DiagramPreview(this.context, panel, uri)); this.track(new DiagramPreview(this.context, this.models, this.host, panel, uri));
} }
async deserializeWebviewPanel(panel: vscode.WebviewPanel, state: PreviewState | undefined): Promise<void> { async deserializeWebviewPanel(panel: vscode.WebviewPanel, state: PreviewState | undefined): Promise<void> {
@@ -233,7 +450,7 @@ export class DiagramViewManager
panel.dispose(); panel.dispose();
return; return;
} }
this.track(new DiagramPreview(this.context, panel, vscode.Uri.parse(state.uri), state)); this.track(new DiagramPreview(this.context, this.models, this.host, panel, vscode.Uri.parse(state.uri), state));
} }
private track(preview: DiagramPreview): void { private track(preview: DiagramPreview): void {
@@ -247,6 +464,7 @@ export class DiagramViewManager
if (preview.panel.active) this.active = preview; if (preview.panel.active) this.active = preview;
else if (this.active === preview) this.active = undefined; else if (this.active === preview) this.active = undefined;
void vscode.commands.executeCommand('setContext', 'archifyPreviewFocus', Boolean(this.active)); void vscode.commands.executeCommand('setContext', 'archifyPreviewFocus', Boolean(this.active));
if (preview.panel.active) void vscode.commands.executeCommand('setContext', 'archify.inModel', Boolean(preview.root));
}; };
preview.panel.onDidChangeViewState(onViewState); preview.panel.onDidChangeViewState(onViewState);
onViewState(); onViewState();
+172
View File
@@ -0,0 +1,172 @@
import path from 'node:path';
import * as vscode from 'vscode';
import { isMainFile, isRegistryFile, parseRegistry } from '../model/format';
import { RegistryPanel, registryPanelFromIndex, registryPanelStandalone } from '../model/panel';
import { ModelService } from '../model/service';
import { readText } from '../util/files';
import { log } from '../util/log';
import { sourceScriptUri } from '../webview/viewer3d';
import { SourceSession } from './sourceSession';
import { handleWebviewMessage, WebviewMessage } from '../webview/messages';
import { makeNonce, registryPage } from '../webview/page';
import { DECISION_VIEW_TYPE, DIAGRAM_EDITOR_VIEW_TYPE, REGISTRY_VIEW_TYPE } from './viewTypes';
export { REGISTRY_VIEW_TYPE };
class RegistryView implements vscode.Disposable {
private seq = 0;
private timer: NodeJS.Timeout | undefined;
private last: string | undefined;
root: vscode.Uri | undefined;
private readonly disposables: vscode.Disposable[] = [];
/** The Source view; while it shows, a new page waits in `heldHtml`. */
readonly source: SourceSession;
private heldHtml: string | undefined;
constructor(
private readonly context: vscode.ExtensionContext,
private readonly models: ModelService,
readonly panel: vscode.WebviewPanel,
readonly uri: vscode.Uri,
) {
this.source = new SourceSession(context, panel, uri, 'registry', (shown) => {
if (!shown && this.heldHtml !== undefined) {
const html = this.heldHtml;
this.heldHtml = undefined;
this.panel.webview.html = html;
}
});
this.disposables.push(
this.source,
panel.webview.onDidReceiveMessage((message: WebviewMessage) => {
if (this.source.handle(message)) return;
if (message.type === 'openDiagram') return void this.openInModel(message.path, DIAGRAM_EDITOR_VIEW_TYPE);
if (message.type === 'openRegistry') return void this.openRegistryLine(message.file, message.line);
if (message.type === 'openDecision') return void this.openInModel(message.file, DECISION_VIEW_TYPE);
void handleWebviewMessage(message, this.uri, this.panel);
}),
);
void this.update();
}
private async openInModel(relativePath: string, viewType: string): Promise<void> {
if (!this.root) return;
const target = vscode.Uri.joinPath(this.root, ...relativePath.split('/'));
try {
await vscode.workspace.fs.stat(target);
} catch {
vscode.window.showWarningMessage(`Archify: ${relativePath} does not exist in this model.`);
return;
}
await vscode.commands.executeCommand('vscode.openWith', target, viewType, vscode.ViewColumn.Active);
}
private async openRegistryLine(file: string, line?: number): Promise<void> {
const target = this.root ? vscode.Uri.joinPath(this.root, ...file.split('/')) : this.uri;
const column = this.panel.viewColumn === vscode.ViewColumn.One ? vscode.ViewColumn.Two : vscode.ViewColumn.One;
const at = Math.max(line ?? 0, 0);
await vscode.window.showTextDocument(target, { viewColumn: column, selection: new vscode.Range(at, 0, at, 0) });
}
scheduleUpdate(): void {
clearTimeout(this.timer);
this.timer = setTimeout(() => void this.update(), 300);
}
async update(): Promise<void> {
clearTimeout(this.timer);
const seq = ++this.seq;
let registry: RegistryPanel;
try {
this.root = await this.models.rootOf(this.uri);
if (this.root) {
const rel = path.relative(this.root.fsPath, this.uri.fsPath).split(path.sep).join('/');
registry = registryPanelFromIndex(await this.models.index(this.root), rel);
} else {
const name = path.basename(this.uri.path);
registry = registryPanelStandalone(name, parseRegistry(await readText(this.uri), name));
}
} catch (error) {
log().warn(`Registry view failed for ${this.uri.fsPath}: ${error instanceof Error ? error.message : String(error)}`);
return;
}
if (seq !== this.seq) return;
const fingerprint = JSON.stringify(registry);
if (fingerprint === this.last) return;
this.last = fingerprint;
const html = registryPage(
{ cspSource: this.panel.webview.cspSource, nonce: makeNonce(), source: { scriptUri: sourceScriptUri(this.panel.webview, this.context.extensionUri), left: 'View' } },
registry,
);
if (this.source.shown) this.heldHtml = html;
else this.panel.webview.html = html;
}
dispose(): void {
clearTimeout(this.timer);
for (const d of this.disposables.splice(0)) d.dispose();
}
}
export class RegistryViewProvider implements vscode.CustomTextEditorProvider, vscode.Disposable {
private readonly views = new Set<RegistryView>();
private active: RegistryView | undefined;
private readonly disposables: vscode.Disposable[];
constructor(
private readonly context: vscode.ExtensionContext,
private readonly models: ModelService,
) {
this.disposables = [
vscode.window.registerCustomEditorProvider(REGISTRY_VIEW_TYPE, this, {
webviewOptions: { retainContextWhenHidden: true, enableFindWidget: true },
supportsMultipleEditorsPerDocument: true,
}),
// Any change in the model (a diagram starts or stops using an element, a registry edit) refreshes the page.
models.onDidChangeModel(({ root }) => {
for (const view of this.views) if (view.root?.toString() === root.toString()) view.scheduleUpdate();
}),
vscode.workspace.onDidChangeTextDocument((event) => {
if (!isRegistryFile(event.document.fileName) && !isMainFile(event.document.fileName)) return;
// Outside a model the model service stays quiet; refresh the page of the edited file itself.
for (const view of this.views) if (!view.root && view.uri.toString() === event.document.uri.toString()) view.scheduleUpdate();
}),
];
}
/** File shown in the focused registry view, if any. */
get activeUri(): vscode.Uri | undefined {
return this.active?.uri;
}
/** The view of the focused page, if any. */
get activeView(): { source: SourceSession } | undefined {
return this.active;
}
// A text editor provider: the page edits the file's own TextDocument (in
// its Source view), so dirty state, save and undo are VS Code's.
async resolveCustomTextEditor(document: vscode.TextDocument, panel: vscode.WebviewPanel): Promise<void> {
panel.webview.options = { enableScripts: true };
const view = new RegistryView(this.context, this.models, panel, document.uri);
this.views.add(view);
const onViewState = () => {
if (panel.active) this.active = view;
else if (this.active === view) this.active = undefined;
if (panel.active) void vscode.commands.executeCommand('setContext', 'archify.inModel', Boolean(view.root));
};
panel.onDidChangeViewState(onViewState);
onViewState();
panel.onDidDispose(() => {
this.views.delete(view);
if (this.active === view) this.active = undefined;
view.dispose();
});
}
dispose(): void {
for (const view of this.views) view.dispose();
this.views.clear();
for (const d of this.disposables.splice(0)) d.dispose();
}
}
+196
View File
@@ -0,0 +1,196 @@
import * as vscode from 'vscode';
import { EditorSchemas } from '../language/editorSchemas';
import { readSchemas } from '../language/schemaCheck';
import { log } from '../util/log';
import { TextChange, normalizeEol, offsetOf, positionOf } from '../util/textDiff';
/** Page → host messages of the Source view. */
export type SourceMessage =
| { type: 'sourceReady' }
| { type: 'sourceOpen' }
| { type: 'sourceClose' }
| { type: 'sourceEdit'; base: string; text: string; changes: TextChange[] };
export type SourceKind = 'diagram' | 'registry' | 'decision';
const CHECKS: Record<SourceKind, string> = {
diagram: 'YAML · checked against the Archify schema and the model',
registry: 'YAML · checked against the registry schema and the model',
decision: 'YAML · checked as a decision of the model',
};
let editorSchemas: EditorSchemas | undefined;
function schemasFor(context: vscode.ExtensionContext): EditorSchemas {
editorSchemas ??= new EditorSchemas(readSchemas(vscode.Uri.joinPath(context.extensionUri, 'schemas').fsPath));
return editorSchemas;
}
export function isSourceMessage(message: { type?: string }): message is SourceMessage {
return message.type === 'sourceReady' || message.type === 'sourceOpen' || message.type === 'sourceClose' || message.type === 'sourceEdit';
}
/**
* The host half of a page's Source view. The document stays VS Code's: page
* edits become WorkspaceEdits (so dirty state, save, undo and Git work as
* for any file), and changes from anywhere else (undo, the text editor, git)
* go back to the page. Problems are whatever the Problems panel holds for the
* file, sent as offsets; the page shows their count on the Source switch even
* while the picture is shown.
*/
export class SourceSession implements vscode.Disposable {
/** True while the page shows Source; the view must not replace its HTML then. */
shown = false;
/** Texts our own edits will produce, oldest first; their change events are not echoed. */
private readonly expected: string[] = [];
private queue: Promise<void> = Promise.resolve();
private schemaKey: string | undefined;
private readonly disposables: vscode.Disposable[];
constructor(
private readonly context: vscode.ExtensionContext,
private readonly panel: vscode.WebviewPanel,
readonly uri: vscode.Uri,
readonly kind: SourceKind,
/** Called when Source opens or closes, so the view can hold or apply its HTML. */
private readonly onShown: (shown: boolean) => void,
) {
const same = (uri: vscode.Uri) => uri.toString() === this.uri.toString();
this.disposables = [
vscode.languages.onDidChangeDiagnostics((event) => {
if (event.uris.some(same)) void this.postDiagnostics();
}),
vscode.workspace.onDidChangeTextDocument((event) => {
if (!same(event.document.uri) || !event.contentChanges.length) return;
this.post({ type: 'sourceDirty', dirty: event.document.isDirty });
if (this.shown) this.syncFrom(event.document);
}),
vscode.workspace.onDidSaveTextDocument((doc) => {
if (same(doc.uri)) this.post({ type: 'sourceDirty', dirty: false });
}),
];
}
/** Asks the page to show its Source view (Archify | Show Source). */
reveal(): void {
this.post({ type: 'setView', view: 'source' });
}
/** Handles a Source message from the page; false for any other message. */
handle(message: { type?: string }): boolean {
if (!isSourceMessage(message)) return false;
switch (message.type) {
case 'sourceReady':
void this.postDiagnostics();
break;
case 'sourceOpen':
this.setShown(true);
void this.sendText(true);
break;
case 'sourceClose':
this.setShown(false);
break;
case 'sourceEdit':
this.edit(message);
break;
}
return true;
}
private setShown(shown: boolean): void {
if (this.shown === shown) return;
this.shown = shown;
this.onShown(shown);
}
private post(message: unknown): void {
Promise.resolve(this.panel.webview.postMessage(message)).catch(() => undefined);
}
private document(): Promise<vscode.TextDocument> {
return Promise.resolve(vscode.workspace.openTextDocument(this.uri));
}
private async sendText(withDiagnostics: boolean): Promise<void> {
const doc = await this.document();
const text = normalizeEol(doc.getText());
this.expected.length = 0;
this.schemaKey = undefined;
this.post({ type: 'sourceText', text, schema: this.schemaChange(text), checks: CHECKS[this.kind] });
this.post({ type: 'sourceDirty', dirty: doc.isDirty });
if (withDiagnostics) await this.postDiagnostics();
}
/** The editor schema when it differs from the one the page has (a diagram's type may change), else undefined. */
private schemaChange(text: string): { key: string; schema: object } | null | undefined {
const next = schemasFor(this.context).forSource(this.kind, text);
const key = next?.key ?? '';
if (key === this.schemaKey) return undefined;
this.schemaKey = key;
return next ?? null;
}
private syncFrom(doc: vscode.TextDocument): void {
const text = normalizeEol(doc.getText());
const index = this.expected.indexOf(text);
if (index !== -1) {
// Our own edit coming back; anything older is settled too.
this.expected.splice(0, index + 1);
return;
}
this.post({ type: 'sourceText', text, schema: this.schemaChange(text), checks: CHECKS[this.kind] });
}
private edit(message: Extract<SourceMessage, { type: 'sourceEdit' }>): void {
this.expected.push(message.text);
const schema = this.schemaChange(message.text);
if (schema !== undefined) this.post({ type: 'sourceSchema', schema });
this.queue = this.queue.then(async () => {
try {
const doc = await this.document();
const current = normalizeEol(doc.getText());
if (current === message.text) return;
const edit = new vscode.WorkspaceEdit();
// Positions come from "\n" text; VS Code turns inserted text into the document's line endings.
const at = (text: string, offset: number) => {
const { line, character } = positionOf(text, offset);
return new vscode.Position(line, character);
};
if (current === message.base) {
for (const change of message.changes) edit.replace(this.uri, new vscode.Range(at(current, change.from), at(current, change.to)), change.insert);
} else {
// The document moved on under the page (rare): the page's text wins.
edit.replace(this.uri, new vscode.Range(at(current, 0), at(current, current.length)), message.text);
}
if (!(await vscode.workspace.applyEdit(edit))) {
log().warn(`Source edit was not applied to ${this.uri.fsPath}`);
void this.sendText(false);
}
} catch (error) {
log().error(`Source edit failed for ${this.uri.fsPath}: ${error instanceof Error ? error.message : String(error)}`);
}
});
}
/** Problems of the file as offsets into its "\n" text, and their count for the switch. */
async postDiagnostics(): Promise<void> {
const diagnostics = vscode.languages.getDiagnostics(this.uri);
let items: unknown[] = [];
if (this.shown && diagnostics.length) {
const text = normalizeEol((await this.document()).getText());
items = diagnostics.map((d) => ({
from: offsetOf(text, d.range.start.line, d.range.start.character),
to: offsetOf(text, d.range.end.line, d.range.end.character),
severity: d.severity === vscode.DiagnosticSeverity.Error ? 'error' : d.severity === vscode.DiagnosticSeverity.Warning ? 'warning' : 'info',
message: d.message,
source: d.source,
}));
}
const count = diagnostics.filter((d) => d.severity === vscode.DiagnosticSeverity.Error || d.severity === vscode.DiagnosticSeverity.Warning).length;
this.post({ type: 'sourceDiagnostics', items, count });
}
dispose(): void {
for (const d of this.disposables.splice(0)) d.dispose();
}
}
+8
View File
@@ -0,0 +1,8 @@
/** Custom editor view types, in one place so views can refer to each other without importing each other. */
export const PREVIEW_VIEW_TYPE = 'archify.preview';
/** Default editor for .archify files: the rendered diagram. */
export const DIAGRAM_EDITOR_VIEW_TYPE = 'archify.diagram';
/** Default editor for .archify-registry files: the elements as cards. */
export const REGISTRY_VIEW_TYPE = 'archify.registry';
/** Default editor for .archify-decision files: the decision as a page. */
export const DECISION_VIEW_TYPE = 'archify.decision';
+20
View File
@@ -0,0 +1,20 @@
import type { ModelGraph } from '../model/graph';
/**
* What the bridge script (page.ts) exposes to the bundled page scripts as
* `window.__archifyHost`: they cannot call acquireVsCodeApi a second time.
*/
export interface ArchifyHost {
defaultView: '2d' | '3d';
post(message: unknown): void;
getState(): Record<string, unknown>;
setState(patch: Record<string, unknown>): void;
/** The Graph page's data, present on that page only. */
graph?: { graph: ModelGraph; query?: string };
}
declare global {
interface Window {
__archifyHost?: ArchifyHost;
}
}
+9
View File
@@ -9,6 +9,11 @@ export type WebviewMessage =
| { type: 'openExternal'; href: string } | { type: 'openExternal'; href: string }
| { type: 'openRelative'; href: string } | { type: 'openRelative'; href: string }
| { type: 'openSource'; path: string; line?: number; endLine?: number; href?: string } | { type: 'openSource'; path: string; line?: number; endLine?: number; href?: string }
| { type: 'openDiagram'; path: string }
| { type: 'openRegistry'; file: string; line?: number }
| { type: 'openDecision'; file: string }
| { type: 'showGraph'; query?: string }
| { type: 'showModel' }
| { type: 'error'; message: string }; | { type: 'error'; message: string };
/** Column for opening files next to a webview without covering it. */ /** Column for opening files next to a webview without covering it. */
@@ -92,6 +97,10 @@ export async function handleWebviewMessage(
vscode.window.showErrorMessage(`Archify: ${message.message}`); vscode.window.showErrorMessage(`Archify: ${message.message}`);
break; break;
case 'hash': case 'hash':
case 'openDiagram':
case 'showGraph':
case 'showModel':
// Handled by the view, which knows the model root.
break; break;
} }
} catch (error) { } catch (error) {
+846 -10
View File
@@ -14,8 +14,30 @@ export interface PageOptions {
notice?: { text: string; kind: 'info' | 'warning' | 'error' }; notice?: { text: string; kind: 'info' | 'warning' | 'error' };
/** The 3D viewer script (a webview URI), added to Archify pages. */ /** The 3D viewer script (a webview URI), added to Archify pages. */
viewer3d?: { scriptUri: string; defaultView: '2d' | '3d' }; viewer3d?: { scriptUri: string; defaultView: '2d' | '3d' };
/** Node id → diagram path (relative to the model root); double-click opens it. */
links?: Record<string, string>;
/** The model page: metadata above the diagram, the diagram list and registry below. */
model?: ModelPanel;
/** Node id → registry description, shown as tooltips in the Elements panel. */
descriptions?: Record<string, string>;
/** Registry page: the elements of one .archify-registry file. */
registry?: RegistryPanel;
/** Decision page: one .archify-decision file. */
decision?: DecisionPanel;
/** Diagram page: decisions of this diagram, for the Decisions rail panel. */
decisions?: DiagramDecision[];
/** Pages inside a model get a switch to the model's Graph page; `left` names the page they are on. */
graphSwitch?: { left: 'Model' | 'Diagram'; query?: string };
/** Pages of a file that can be edited in place: the Source view's script, and the name of the page's own view. */
source?: { scriptUri: string; left: 'Model' | 'Diagram' | 'View' };
/** The Graph page: the model as one graph, the bundled script that draws it, and the query to start with. */
graph?: { graph: ModelGraph; query?: string; scriptUri: string };
} }
import type { ModelGraph } from '../model/graph';
import type { DecisionPanel, ModelPanel, RegistryPanel } from '../model/panel';
import type { DiagramDecision } from '../model/prepare';
export function makeNonce(): string { export function makeNonce(): string {
const chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'; const chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
let nonce = ''; let nonce = '';
@@ -66,6 +88,15 @@ function bridgeScript(options: PageOptions): string {
state: options.state, state: options.state,
notice: options.notice, notice: options.notice,
defaultView: options.viewer3d?.defaultView, defaultView: options.viewer3d?.defaultView,
links: options.links ?? {},
model: options.model,
registry: options.registry,
decision: options.decision,
decisions: options.decisions || [],
descriptions: options.descriptions || {},
graphSwitch: options.graphSwitch,
source: options.source,
graph: options.graph ? { graph: options.graph.graph, query: options.graph.query } : undefined,
}; };
return `(function () { return `(function () {
var config = ${scriptJson(config)}; var config = ${scriptJson(config)};
@@ -89,7 +120,8 @@ function bridgeScript(options: PageOptions): string {
defaultView: config.defaultView || '2d', defaultView: config.defaultView || '2d',
post: post, post: post,
getState: function () { return vscode.getState() || {}; }, getState: function () { return vscode.getState() || {}; },
setState: function (patch) { vscode.setState(Object.assign({}, vscode.getState() || {}, patch)); } setState: function (patch) { vscode.setState(Object.assign({}, vscode.getState() || {}, patch)); },
graph: config.graph
}; };
function saveBlobUrl(url, filename) { function saveBlobUrl(url, filename) {
@@ -162,10 +194,599 @@ function bridgeScript(options: PageOptions): string {
(document.body || document.documentElement).appendChild(bar); (document.body || document.documentElement).appendChild(bar);
} }
// A node that links to another diagram opens it on double-click.
document.addEventListener('dblclick', function (event) {
var target = event.target;
var node = target && target.closest ? target.closest('[data-node-id]') : null;
if (!node) return;
var id = node.getAttribute('data-node-id');
if (id && config.links[id]) {
event.preventDefault();
event.stopPropagation();
post({ type: 'openDiagram', path: config.links[id] });
}
}, true);
// Collapsible panels of the model page; open/closed is kept in the webview state.
function panelStates() { return (vscode.getState() || {}).modelPanels || {}; }
function panel(key, className, title, count, defaultOpen) {
// count: a number or a short text such as "3 files".
var details = el('details', 'archify-model-panel ' + className);
var saved = panelStates()[key];
details.open = saved === undefined ? defaultOpen : saved;
var summary = el('summary', 'archify-model-summary');
summary.appendChild(el('span', 'archify-model-chevron'));
summary.appendChild(el('span', 'archify-model-summary-title', title));
if (count !== undefined) summary.appendChild(el('span', 'archify-model-count', String(count)));
details.appendChild(summary);
details.addEventListener('toggle', function () {
var states = panelStates();
states[key] = details.open;
vscode.setState(Object.assign({}, vscode.getState() || {}, { modelPanels: states }));
});
return details;
}
// One registry element as an Archify card. Clicking the card opens the
// usage modal; the chips open the diagram directly.
function elementCard(element) {
var card = el('div', 'card archify-model-card');
card.setAttribute('role', 'button');
card.tabIndex = 0;
card.title = 'Show where ' + (element.label || element.id) + ' is used';
var header = el('div', 'card-header');
header.appendChild(el('div', 'card-dot ' + dotForType(element.type)));
header.appendChild(el('h3', '', element.label || element.id));
card.appendChild(header);
var list = el('ul');
list.appendChild(el('li', 'archify-model-card-id', element.id + (element.type ? ' · ' + element.type : '') + (element.sublabel ? ' · ' + element.sublabel : '')));
if (element.description) list.appendChild(el('li', '', element.description.trim()));
var used = el('li', 'archify-model-card-used');
if (element.usedIn.length) {
element.usedIn.forEach(function (use) {
var link = el('button', 'archify-model-used-link', use.path.replace(/\.archify$/, ''));
link.type = 'button';
link.title = 'Open ' + use.path;
link.addEventListener('click', function (event) { event.stopPropagation(); post({ type: 'openDiagram', path: use.path }); });
used.appendChild(link);
});
} else used.appendChild(el('span', 'archify-model-item-meta', 'not used yet'));
list.appendChild(used);
if (element.decisions && element.decisions.length) {
var decided = el('li', 'archify-model-card-used');
element.decisions.forEach(function (row) { decided.appendChild(decisionChip(row)); });
list.appendChild(decided);
}
card.appendChild(list);
card.addEventListener('click', function () { openElementModal(element); });
card.addEventListener('keydown', function (event) { if (event.key === 'Enter' || event.key === ' ') { event.preventDefault(); openElementModal(element); } });
return card;
}
// A decision as a chip (id, title, status) that opens its page.
function decisionChip(row) {
var chip = el('button', 'archify-model-used-link archify-decision-chip is-' + row.status, '');
chip.type = 'button';
chip.appendChild(el('span', 'archify-decision-dot'));
chip.appendChild(document.createTextNode(row.id + (row.title ? ' · ' + row.title : '')));
chip.title = 'Decision ' + row.id + (row.title ? ': ' + row.title : '') + ' (' + row.status + ')';
chip.addEventListener('click', function (event) { event.stopPropagation(); if (row.file) post({ type: 'openDecision', file: row.file }); });
return chip;
}
function statusBadge(row) {
var badge = el('span', 'archify-decision-status is-' + row.status, row.status + (row.supersededBy ? ' by ' + row.supersededBy : ''));
return badge;
}
// A decision as a row in a list: id, title, status, date; click opens it.
function decisionRowItem(row) {
var item = el('li', 'archify-model-item archify-decision-item is-' + row.status);
var button = el('button', 'archify-model-open archify-decision-open');
button.type = 'button';
button.title = row.file || row.id;
var line = el('span', 'archify-decision-line');
line.appendChild(el('span', 'archify-decision-id', row.id));
line.appendChild(el('span', 'archify-model-item-title', row.title || ''));
line.appendChild(statusBadge(row));
if (row.date) line.appendChild(el('span', 'archify-model-item-meta', row.date));
button.appendChild(line);
button.addEventListener('click', function () { if (row.file) post({ type: 'openDecision', file: row.file }); });
item.appendChild(button);
return item;
}
// Modal: one element, where it is defined and the diagrams that use it.
function openElementModal(element) {
closeElementModal();
var backdrop = el('div', 'archify-modal-backdrop');
backdrop.id = 'archify-element-modal';
var modal = el('div', 'archify-modal archify-model');
modal.setAttribute('role', 'dialog');
modal.setAttribute('aria-modal', 'true');
var head = el('div', 'archify-modal-head');
head.appendChild(el('span', 'card-dot ' + dotForType(element.type)));
var titles = el('div', 'archify-modal-titles');
titles.appendChild(el('h2', 'archify-modal-title', element.label || element.id));
titles.appendChild(el('div', 'archify-model-card-id', element.id + (element.type ? ' · ' + element.type : '') + (element.sublabel ? ' · ' + element.sublabel : '')));
head.appendChild(titles);
var close = el('button', 'archify-modal-close', '\u00d7');
close.type = 'button';
close.title = 'Close (Esc)';
close.addEventListener('click', closeElementModal);
head.appendChild(close);
modal.appendChild(head);
if (element.description) modal.appendChild(el('p', 'archify-modal-description', element.description.trim()));
var defined = el('p', 'archify-modal-defined');
defined.appendChild(document.createTextNode('Defined in '));
var source = el('button', 'archify-model-used-link', element.file + ':' + (element.line + 1));
source.type = 'button';
source.title = 'Open the registry at this line';
source.addEventListener('click', function () { post({ type: 'openRegistry', file: element.file, line: element.line }); });
defined.appendChild(source);
if (element.diagram) {
defined.appendChild(document.createTextNode(' · explained by '));
var explained = el('button', 'archify-model-used-link', element.diagram.replace(/\.archify$/, ''));
explained.type = 'button';
explained.addEventListener('click', function () { post({ type: 'openDiagram', path: element.diagram }); });
defined.appendChild(explained);
}
modal.appendChild(defined);
modal.appendChild(el('h3', 'archify-model-title', element.usedIn.length ? 'Used in ' + element.usedIn.length + (element.usedIn.length === 1 ? ' diagram' : ' diagrams') : 'Not used in any diagram yet'));
if (element.usedIn.length) {
var list = el('ul', 'archify-model-list');
element.usedIn.forEach(function (use) {
var item = el('li', 'archify-model-item');
var button = el('button', 'archify-model-open');
button.type = 'button';
button.title = use.path;
button.appendChild(el('span', 'archify-model-item-title', use.title || use.path.split('/').pop()));
button.appendChild(el('span', 'archify-model-item-meta', (use.kind || 'diagram') + ' · ' + use.path));
button.addEventListener('click', function () { post({ type: 'openDiagram', path: use.path }); });
item.appendChild(button);
list.appendChild(item);
});
modal.appendChild(list);
}
if (element.decisions && element.decisions.length) {
modal.appendChild(el('h3', 'archify-model-title', 'Decisions · ' + element.decisions.length));
var decisions = el('ul', 'archify-model-list archify-decision-list');
element.decisions.forEach(function (row) { decisions.appendChild(decisionRowItem(row)); });
modal.appendChild(decisions);
}
backdrop.appendChild(modal);
backdrop.addEventListener('click', function (event) { if (event.target === backdrop) closeElementModal(); });
document.body.appendChild(backdrop);
close.focus();
}
function closeElementModal() {
var existing = document.getElementById('archify-element-modal');
if (existing) existing.remove();
}
document.addEventListener('keydown', function (event) {
if (event.key === 'Escape' && document.getElementById('archify-element-modal')) { event.stopPropagation(); closeElementModal(); }
}, true);
// The registry page: one .archify-registry file, its elements as cards.
function renderRegistry(registry) {
if (!registry) return;
var head = el('section', 'archify-model archify-model-head');
head.appendChild(el('div', 'archify-model-kicker', 'Registry' + (registry.model && registry.model.id ? ' · ' + registry.model.id : '')));
head.appendChild(el('h1', 'archify-model-name', registry.file));
if (registry.model && registry.model.name) head.appendChild(el('p', 'archify-model-description', 'Shared elements of ' + registry.model.name + '. Click an element to see where it is used.'));
if (!registry.inModel) head.appendChild(el('p', 'archify-model-problem', 'This registry is not inside a model (no main.archify in a folder above it), so nothing can refer to its elements yet.'));
registry.problems.forEach(function (problem) { head.appendChild(el('p', 'archify-model-problem', problem)); });
document.body.appendChild(head);
var body = el('section', 'archify-model archify-model-body');
var elementsPanel = panel('elements', 'archify-model-registry', 'Elements', registry.elements.length, true);
body.appendChild(elementsPanel);
if (!registry.elements.length) elementsPanel.appendChild(el('p', 'archify-model-empty', 'No elements yet. Add them under "elements:" with a type, a label and a description.'));
var cards = el('div', 'cards archify-model-cards');
registry.elements.forEach(function (element) { cards.appendChild(elementCard(element)); });
elementsPanel.appendChild(cards);
document.body.appendChild(body);
}
// The decision page: one .archify-decision file.
function renderDecision(page) {
if (!page) return;
var d = page.decision;
var head = el('section', 'archify-model archify-model-head');
head.appendChild(el('div', 'archify-model-kicker', 'Decision' + (page.model && page.model.id ? ' · ' + page.model.id : '') + (d ? ' · ' + d.id : '')));
head.appendChild(el('h1', 'archify-model-name', d && d.title ? d.title : page.file));
if (d) {
var meta = el('p', 'archify-decision-meta');
meta.appendChild(statusBadge(d));
if (d.date) meta.appendChild(el('span', 'archify-model-item-meta', d.date));
meta.appendChild(el('span', 'archify-model-item-meta', page.file));
head.appendChild(meta);
}
if (!page.inModel) head.appendChild(el('p', 'archify-model-problem', 'This decision has lost its model: there is no main.archify in a folder above it, so its elements and diagrams cannot be resolved.'));
page.problems.forEach(function (problem) { head.appendChild(el('p', 'archify-model-problem', problem)); });
document.body.appendChild(head);
var body = el('section', 'archify-model archify-model-body');
if (d) {
[['Context', d.context], ['Decision', d.decision], ['Consequences', d.consequences]].forEach(function (pair) {
if (!pair[1]) return;
var section = el('section', 'archify-decision-section');
section.appendChild(el('h2', 'archify-model-title', pair[0]));
section.appendChild(el('p', 'archify-decision-text', pair[1].trim()));
body.appendChild(section);
});
if (d.supersedes.length || page.supersededBy.length) {
var rel = el('section', 'archify-decision-section');
rel.appendChild(el('h2', 'archify-model-title', 'Related decisions'));
var relList = el('ul', 'archify-model-list archify-decision-list');
d.supersedes.forEach(function (row) { var item = decisionRowItem(row); item.firstChild.insertBefore(el('span', 'archify-model-item-meta', 'supersedes'), item.firstChild.firstChild); relList.appendChild(item); });
page.supersededBy.forEach(function (row) { var item = decisionRowItem(row); item.firstChild.insertBefore(el('span', 'archify-model-item-meta', 'superseded by'), item.firstChild.firstChild); relList.appendChild(item); });
rel.appendChild(relList);
body.appendChild(rel);
}
}
if (page.elements.length) {
var elementsPanel = panel('decision:elements', 'archify-model-registry', 'Elements', page.elements.length, true);
var cards = el('div', 'cards archify-model-cards');
page.elements.forEach(function (element) { cards.appendChild(elementCard(element)); });
elementsPanel.appendChild(cards);
body.appendChild(elementsPanel);
}
var diagramRows = [];
page.diagrams.forEach(function (use) { diagramRows.push({ path: use.path, title: use.title, kind: use.kind, how: 'named by the decision' }); });
page.referencedBy.forEach(function (use) {
var how = use.attachedTo.kind === 'node' ? 'on ' + use.attachedTo.id : use.attachedTo.kind === 'edge' ? 'on ' + use.attachedTo.from + ' \u2192 ' + use.attachedTo.to : 'on the diagram';
var existing = diagramRows.filter(function (r) { return r.path === use.path; })[0];
if (existing) existing.how += ', ' + how; else diagramRows.push({ path: use.path, title: use.title, kind: use.kind, how: how });
});
if (diagramRows.length) {
var diagramsPanel = panel('decision:diagrams', 'archify-model-diagrams', 'Diagrams', diagramRows.length, true);
var list = el('ul', 'archify-model-list');
diagramRows.forEach(function (row) {
var item = el('li', 'archify-model-item');
var button = el('button', 'archify-model-open');
button.type = 'button';
button.title = row.path;
button.appendChild(el('span', 'archify-model-item-title', row.title || row.path.split('/').pop()));
button.appendChild(el('span', 'archify-model-item-meta', (row.kind || 'diagram') + ' \u00b7 ' + row.path + ' \u00b7 ' + row.how));
button.addEventListener('click', function () { if (page.inModel) post({ type: 'openDiagram', path: row.path }); });
item.appendChild(button);
list.appendChild(item);
});
diagramsPanel.appendChild(list);
body.appendChild(diagramsPanel);
}
document.body.appendChild(body);
}
// Decisions rail panel on a diagram page: the decisions this diagram points
// at or that name it. Hover lights up what the decision is attached to.
function renderDecisionsRail() {
var rows = config.decisions || [];
var outline = document.getElementById('node-outline');
var svg = document.querySelector('.diagram-container > svg');
if (!rows.length || !outline || !svg || document.getElementById('archify-decisions')) return;
var nav = el('nav', 'node-outline no-print archify-connectors archify-decisions');
nav.id = 'archify-decisions';
var head = el('div', 'node-outline-head');
head.appendChild(el('strong', '', 'Decisions'));
head.appendChild(el('span', 'node-outline-count', String(rows.length)));
nav.appendChild(head);
var list = el('ol', 'node-outline-list');
var group = el('li', 'node-outline-group');
var items = el('ul');
function targets(row) {
var found = [];
row.attachedTo.forEach(function (a) {
if (a.kind === 'node') Array.prototype.push.apply(found, svg.querySelectorAll('[data-node-id="' + a.id + '"]'));
if (a.kind === 'edge') Array.prototype.push.apply(found, svg.querySelectorAll('[data-edge-from="' + a.from + '"][data-edge-to="' + a.to + '"]'));
});
return found;
}
function mark(row, on) { targets(row).forEach(function (t) { if (on) t.setAttribute('data-archify-hit', ''); else t.removeAttribute('data-archify-hit'); }); }
rows.forEach(function (row) {
var item = el('li');
var button = el('button', 'node-outline-item archify-decision-rail-item is-' + row.status);
button.type = 'button';
button.style.setProperty('--outline-tone', 'var(--text-muted)');
var where = row.attachedTo.map(function (a) { return a.kind === 'node' ? a.id : a.kind === 'edge' ? a.from + ' \u2192 ' + a.to : 'diagram'; }).join(', ');
button.title = row.id + (row.title ? ': ' + row.title : '') + ' (' + row.status + ')' + (where ? ' \u00b7 ' + where : '');
var dot = el('span', 'node-outline-dot');
dot.setAttribute('aria-hidden', 'true');
button.appendChild(dot);
button.appendChild(el('strong', '', row.id + (row.title ? ' \u00b7 ' + row.title : '')));
button.appendChild(el('small', '', row.status + (where ? ' \u00b7 ' + where : '')));
button.addEventListener('pointerenter', function () { mark(row, true); });
button.addEventListener('pointerleave', function () { mark(row, false); });
button.addEventListener('focus', function () { mark(row, true); });
button.addEventListener('blur', function () { mark(row, false); });
button.addEventListener('click', function () { post({ type: 'openDecision', file: row.file }); });
item.appendChild(button);
items.appendChild(item);
});
group.appendChild(items);
list.appendChild(group);
nav.appendChild(list);
var connectors = document.getElementById('archify-connectors');
(connectors || outline).insertAdjacentElement('afterend', nav);
var archify = window.Archify;
if (archify && archify.readerLayout && typeof archify.readerLayout.schedule === 'function') archify.readerLayout.schedule();
}
// Elements: registry descriptions as tooltips on Archify's node index rows.
function describeElements() {
var items = document.querySelectorAll('#node-outline .node-outline-item[data-outline-node]');
Array.prototype.forEach.call(items, function (item) {
var text = config.descriptions[item.getAttribute('data-outline-node')];
if (text) item.title = text;
});
}
// Connectors: a rail panel next to Archify's Elements index, read from the
// SVG's edges. Hover highlights the connector, click keeps it highlighted.
function renderConnectors() {
var svg = document.querySelector('.diagram-container > svg');
var outline = document.getElementById('node-outline');
if (!svg || !outline || document.getElementById('archify-connectors')) return;
var labels = {};
Array.prototype.forEach.call(svg.querySelectorAll('[data-node-id][data-node-label]'), function (node) {
labels[node.getAttribute('data-node-id')] = node.getAttribute('data-node-label');
});
var edges = [];
var byKey = {};
Array.prototype.forEach.call(svg.querySelectorAll('[data-edge-key]'), function (fragment) {
var key = fragment.getAttribute('data-edge-key');
if (!byKey[key]) {
byKey[key] = { key: key, from: fragment.getAttribute('data-edge-from') || '', to: fragment.getAttribute('data-edge-to') || '', label: fragment.getAttribute('data-edge-label') || '', fragments: [] };
edges.push(byKey[key]);
}
byKey[key].fragments.push(fragment);
});
if (!edges.length) return;
var nav = el('nav', 'node-outline no-print archify-connectors');
nav.id = 'archify-connectors';
nav.setAttribute('aria-labelledby', 'archify-connectors-title');
var head = el('div', 'node-outline-head');
var title = el('strong', '', 'Connectors');
title.id = 'archify-connectors-title';
head.appendChild(title);
head.appendChild(el('span', 'node-outline-count', String(edges.length)));
nav.appendChild(head);
var list = el('ol', 'node-outline-list');
var group = el('li', 'node-outline-group');
var items = el('ul');
var selected = null;
function mark(edge, attr, on) {
edge.fragments.forEach(function (fragment) { if (on) fragment.setAttribute(attr, ''); else fragment.removeAttribute(attr); });
}
function select(edge, button) {
if (selected) { mark(selected.edge, 'data-archify-selected', false); selected.button.removeAttribute('aria-current'); }
if (selected && selected.edge === edge) { selected = null; return; }
selected = { edge: edge, button: button };
mark(edge, 'data-archify-selected', true);
button.setAttribute('aria-current', 'true');
var first = edge.fragments[0];
if (first && typeof first.scrollIntoView === 'function') first.scrollIntoView({ block: 'center', inline: 'center', behavior: 'smooth' });
}
edges.forEach(function (edge) {
var item = el('li');
var button = el('button', 'node-outline-item');
button.type = 'button';
button.style.setProperty('--outline-tone', 'var(--text-muted)');
button.title = (labels[edge.from] || edge.from) + ' \u2192 ' + (labels[edge.to] || edge.to) + (edge.label ? ' \u00b7 ' + edge.label : '');
var dot = el('span', 'node-outline-dot');
dot.setAttribute('aria-hidden', 'true');
button.appendChild(dot);
button.appendChild(el('strong', '', (labels[edge.from] || edge.from) + ' \u2192 ' + (labels[edge.to] || edge.to)));
if (edge.label) button.appendChild(el('small', '', edge.label));
button.addEventListener('pointerenter', function () { mark(edge, 'data-archify-hit', true); });
button.addEventListener('pointerleave', function () { mark(edge, 'data-archify-hit', false); });
button.addEventListener('focus', function () { mark(edge, 'data-archify-hit', true); });
button.addEventListener('blur', function () { mark(edge, 'data-archify-hit', false); });
button.addEventListener('click', function () { select(edge, button); });
item.appendChild(button);
items.appendChild(item);
});
group.appendChild(items);
list.appendChild(group);
nav.appendChild(list);
outline.insertAdjacentElement('afterend', nav);
document.addEventListener('keydown', function (event) {
if (event.key === 'Escape' && selected) select(selected.edge, selected.button);
});
var archify = window.Archify;
if (archify && archify.readerLayout && typeof archify.readerLayout.schedule === 'function') archify.readerLayout.schedule();
}
var DOT_BY_TYPE = { frontend: 'cyan', backend: 'emerald', database: 'violet', cloud: 'amber', security: 'rose', messagebus: 'orange', external: 'slate' };
function dotForType(type) { return DOT_BY_TYPE[type || ''] || 'slate'; }
function el(tag, className, text) {
var node = document.createElement(tag);
if (className) node.className = className;
if (text !== undefined) node.textContent = text;
return node;
}
// The model page: metadata first, the diagram (if any) where Archify put
// it, then the diagrams of the model and the registry.
function renderModel(model) {
if (!model) return;
var anchor = document.querySelector('.container');
var head = el('section', 'archify-model archify-model-head');
head.appendChild(el('div', 'archify-model-kicker', 'Model' + (model.meta.id ? ' · ' + model.meta.id : '')));
head.appendChild(el('h1', 'archify-model-name', model.meta.name || model.meta.id || 'Untitled model'));
if (model.meta.description) head.appendChild(el('p', 'archify-model-description', model.meta.description.trim()));
if (model.nested.length) head.appendChild(el('p', 'archify-model-problem', 'Nested main.archify files are not supported and were ignored: ' + model.nested.join(', ')));
model.problems.forEach(function (problem) { head.appendChild(el('p', 'archify-model-problem', problem)); });
if (anchor && anchor.parentNode) anchor.parentNode.insertBefore(head, anchor); else document.body.appendChild(head);
var body = el('section', 'archify-model archify-model-body');
var count = model.groups.reduce(function (n, g) { return n + g.diagrams.length; }, 0);
var diagramsPanel = panel('diagrams', 'archify-model-diagrams', 'Diagrams', count, true);
body.appendChild(diagramsPanel);
if (!count) diagramsPanel.appendChild(el('p', 'archify-model-empty', 'No diagrams yet. Add .archify files next to main.archify or in subfolders.'));
model.groups.forEach(function (group) {
// Each folder is its own collapsible header; diagrams next to main.archify are listed directly.
var holder = diagramsPanel;
if (group.group) {
holder = panel('folder:' + group.group, 'archify-model-folder', group.group, group.diagrams.length, true);
diagramsPanel.appendChild(holder);
}
var list = el('ul', 'archify-model-list');
group.diagrams.forEach(function (diagram) {
var item = el('li', 'archify-model-item' + (diagram.parseError ? ' is-broken' : ''));
var button = el('button', 'archify-model-open');
button.type = 'button';
button.title = diagram.path;
button.appendChild(el('span', 'archify-model-item-title', diagram.title || diagram.path.split('/').pop()));
button.appendChild(el('span', 'archify-model-item-meta', diagram.parseError ? 'does not parse: ' + diagram.parseError : (diagram.kind || 'diagram') + ' · ' + diagram.path));
button.addEventListener('click', function () { post({ type: 'openDiagram', path: diagram.path }); });
item.appendChild(button);
list.appendChild(item);
});
holder.appendChild(list);
});
// Registry: one collapsible header per registry file, its elements as cards inside.
if (model.registry.length) {
var files = [];
var byFile = {};
model.registry.forEach(function (element) {
if (!byFile[element.file]) { byFile[element.file] = []; files.push(element.file); }
byFile[element.file].push(element);
});
files.sort();
var registryPanel = panel('registry', 'archify-model-registry', 'Registries', files.length + (files.length === 1 ? ' file' : ' files'), true);
body.appendChild(registryPanel);
files.forEach(function (file) {
var elements = byFile[file].slice().sort(function (a, b) { return a.line - b.line; });
var filePanel = panel('registry:' + file, 'archify-model-folder archify-model-registry-file', file.replace(/\.archify-registry$/, ''), elements.length + (elements.length === 1 ? ' element' : ' elements'), false);
var open = el('button', 'archify-model-used-link archify-model-open-file', 'Open');
open.type = 'button';
open.title = 'Open ' + file;
open.addEventListener('click', function (event) { event.preventDefault(); event.stopPropagation(); post({ type: 'openRegistry', file: file, line: 0 }); });
filePanel.firstChild.appendChild(open);
var cards = el('div', 'cards archify-model-cards');
elements.forEach(function (element) { cards.appendChild(elementCard(element)); });
filePanel.appendChild(cards);
registryPanel.appendChild(filePanel);
});
}
// Decisions: one list, live ones first, superseded and rejected dimmed and last.
if (model.decisions && model.decisions.length) {
var decisionsPanel = panel('decisions', 'archify-model-decisions', 'Decisions', model.decisions.length, true);
body.appendChild(decisionsPanel);
var decisionList = el('ul', 'archify-model-list archify-decision-list');
model.decisions.forEach(function (row) { decisionList.appendChild(decisionRowItem(row)); });
decisionsPanel.appendChild(decisionList);
}
if (anchor && anchor.parentNode) anchor.parentNode.insertBefore(body, anchor.nextSibling); else document.body.appendChild(body);
}
// What the page shows: Diagram | Graph | Source (Model | Graph | Source on
// main.archify, View | Source on registry and decision pages). It sits
// left of Export in Archify's toolbar, after 2D | 3D, which only says how
// the picture is drawn; on our own pages it sits top right. Graph opens the
// model's Graph page; Source puts the file's YAML in place of the picture.
var sourceOn = false;
var syncModeSwitch = function () {};
function renderModeSwitch() {
var sw = config.graphSwitch;
var src = config.source;
if ((!sw && !src) || document.getElementById('archify-mode-switch')) return;
var group = el('div', 'archify-mode-switch');
group.id = 'archify-mode-switch';
group.setAttribute('role', 'group');
group.setAttribute('aria-label', 'View');
function segment(label, title, action) {
var button = el('button', 'archify-mode-seg', label);
button.type = 'button';
button.title = title;
button.addEventListener('click', function (event) { event.stopPropagation(); action(); });
group.appendChild(button);
return button;
}
var name = (src && src.left) || sw.left;
var left = segment(name, name === 'View' ? 'Show the page' : 'Show the ' + name.toLowerCase(), function () { setSource(false); });
if (sw) segment('Graph', 'Open the model as one graph, with a query box', function () { post({ type: 'showGraph', query: sw.query }); });
var source = src ? segment('Source', 'Edit the YAML of this file, checked as you type', function () { setSource(true); }) : null;
if (source) {
var badge = el('span', 'archify-source-badge');
badge.id = 'archify-source-badge';
badge.hidden = true;
source.appendChild(badge);
}
syncModeSwitch = function () {
left.classList.toggle('on', !sourceOn);
left.setAttribute('aria-pressed', String(!sourceOn));
if (source) {
source.classList.toggle('on', sourceOn);
source.setAttribute('aria-pressed', String(sourceOn));
}
};
syncModeSwitch();
var exportWrap = document.querySelector('.toolbar .export-wrap');
var head = document.querySelector('.archify-model-head');
if (exportWrap && exportWrap.parentNode) exportWrap.parentNode.insertBefore(group, exportWrap);
else {
var row = el('div', 'archify-model-switch-row');
row.appendChild(group);
if (head) head.insertBefore(row, head.firstChild);
else document.body.insertBefore(row, document.body.firstChild);
}
}
// The Source view lives in dist/source.js, loaded the first time it is chosen.
function setSource(on) {
if (!config.source || on === sourceOn) return;
sourceOn = on;
vscode.setState(Object.assign({}, vscode.getState() || {}, { sourceView: on }));
syncModeSwitch();
if (!on) {
if (window.__archifySource) window.__archifySource.close();
return;
}
if (window.__archifySource) {
window.__archifySource.open();
return;
}
var script = document.createElement('script');
script.src = config.source.scriptUri;
script.onload = function () { if (sourceOn && window.__archifySource) window.__archifySource.open(); };
script.onerror = function () {
sourceOn = false;
syncModeSwitch();
post({ type: 'error', message: 'The Source view could not be loaded.' });
};
document.head.appendChild(script);
}
function showProblemCount(count) {
var badge = document.getElementById('archify-source-badge');
if (!badge) return;
badge.hidden = !count;
badge.textContent = count ? String(count) : '';
badge.title = count ? count + (count === 1 ? ' problem' : ' problems') + ' in the source' : '';
}
window.addEventListener('message', function (event) { window.addEventListener('message', function (event) {
var message = event.data || {}; var message = event.data || {};
if (message.type === 'notice') showNotice(message.notice); if (message.type === 'notice') showNotice(message.notice);
if (message.type === 'sourceDiagnostics') showProblemCount(message.count);
if (message.type === 'setView') setSource(message.view === 'source');
}); });
function onReady(fn) {
if (document.readyState === 'loading') document.addEventListener('DOMContentLoaded', fn);
else fn();
}
if (config.model) onReady(function () { renderModel(config.model); });
if (config.registry) onReady(function () { renderRegistry(config.registry); });
if (config.decision) onReady(function () { renderDecision(config.decision); });
onReady(renderConnectors);
onReady(renderDecisionsRail);
onReady(describeElements);
onReady(renderModeSwitch);
if (config.source) {
// The host answers with the problem count for the Source badge.
post({ type: 'sourceReady' });
if ((vscode.getState() || {}).sourceView) onReady(function () { setSource(true); });
}
if (config.notice) { if (config.notice) {
if (document.readyState === 'loading') { if (document.readyState === 'loading') {
document.addEventListener('DOMContentLoaded', function () { showNotice(config.notice); }); document.addEventListener('DOMContentLoaded', function () { showNotice(config.notice); });
@@ -176,6 +797,132 @@ function bridgeScript(options: PageOptions): string {
})();`; })();`;
} }
const MODEL_STYLE = `
.archify-model { --m-text: var(--text, var(--vscode-foreground, CanvasText)); --m-muted: var(--text-muted, var(--vscode-descriptionForeground, GrayText)); --m-panel: var(--panel, var(--vscode-editorWidget-background, Canvas)); --m-border: var(--panel-border, var(--vscode-editorWidget-border, rgba(128,128,128,.35))); --m-accent: var(--frontend-stroke, var(--vscode-textLink-foreground));
max-width: 1400px; margin: 0 auto; padding: 1.25rem 2rem; color: var(--m-text); font-family: var(--vscode-font-family, system-ui, sans-serif); }
.archify-model-head { padding-top: 1.5rem; }
/* Under Archify's fixed toolbar (diagram pages of main.archify), start below it. */
.toolbar ~ .archify-model-head { padding-top: 4.25rem; }
.archify-model-kicker { font-size: 0.6875rem; font-weight: 700; letter-spacing: 0.12em; text-transform: uppercase; color: var(--m-accent); }
.archify-model-name { margin: 0.25rem 0 0.5rem; font-size: 1.5rem; font-weight: 700; letter-spacing: -0.02em; }
.archify-model-description { margin: 0; max-width: 72ch; font-size: 0.9375rem; line-height: 1.55; color: var(--m-muted); white-space: pre-line; }
.archify-model-problem { margin: 0.75rem 0 0; padding: 0.5rem 0.75rem; border-radius: 0.5rem; border: 1px solid var(--vscode-inputValidation-errorBorder, #be1100); color: var(--m-text); font-size: 0.8125rem; }
/* Collapsible panels: Diagrams and Registry, and one per folder inside Diagrams. */
.archify-model-panel { margin: 1rem 0 0; border: 1px solid var(--m-border); border-radius: 0.75rem; background: var(--m-panel); }
.archify-model-panel[open] { padding-bottom: 0.85rem; }
.archify-model-summary { display: flex; align-items: center; gap: 0.6rem; padding: 0.75rem 0.9rem; cursor: pointer; list-style: none; user-select: none; font-size: 0.875rem; font-weight: 600; letter-spacing: 0.02em; color: var(--m-text); }
.archify-model-summary::-webkit-details-marker { display: none; }
.archify-model-summary:hover { color: var(--m-accent); }
.archify-model-summary:focus-visible { outline: 2px solid var(--m-accent); outline-offset: -2px; border-radius: 0.75rem; }
.archify-model-chevron { flex: none; width: 0.5rem; height: 0.5rem; border-right: 2px solid currentColor; border-bottom: 2px solid currentColor; transform: rotate(-45deg); transition: transform 0.15s; opacity: 0.7; margin-left: 0.1rem; }
.archify-model-panel[open] > .archify-model-summary > .archify-model-chevron { transform: rotate(45deg); }
.archify-model-count { margin-left: auto; font-size: 0.75rem; font-weight: 500; color: var(--m-muted); font-family: ui-monospace, Menlo, monospace; padding: 0.05rem 0.5rem; border: 1px solid var(--m-border); border-radius: 999px; }
.archify-model-panel > .archify-model-list, .archify-model-panel > .archify-model-cards, .archify-model-panel > .archify-model-empty { margin: 0 0.9rem; }
.archify-model-folder { margin: 0.35rem 0.9rem 0; background: transparent; border-radius: 0.6rem; }
.archify-model-folder[open] { padding-bottom: 0.7rem; }
.archify-model-folder > .archify-model-summary { padding: 0.55rem 0.75rem; font-size: 0.6875rem; font-weight: 700; letter-spacing: 0.1em; text-transform: uppercase; color: var(--m-muted); font-family: ui-monospace, Menlo, monospace; }
.archify-model-folder > .archify-model-summary:hover { color: var(--m-accent); }
.archify-model-folder > .archify-model-list { margin: 0 0.75rem; }
.archify-model-registry-file > .archify-model-summary { text-transform: none; letter-spacing: 0; font-size: 0.8125rem; }
.archify-model-registry-file > .archify-model-cards { margin: 0.25rem 0.75rem 0; }
.archify-model-open-file { margin-left: 0.5rem; text-transform: none; letter-spacing: 0; font-family: inherit; }
.archify-model-open-file:hover { color: var(--m-accent); }
.archify-model-diagrams > .archify-model-list { margin-top: 0.25rem; }
.archify-model-list { list-style: none; margin: 0; padding: 0; display: grid; grid-template-columns: repeat(auto-fill, minmax(260px, 1fr)); gap: 0.5rem; }
.archify-model-open { display: flex; flex-direction: column; gap: 0.2rem; width: 100%; padding: 0.7rem 0.85rem; text-align: left; cursor: pointer; font: inherit; color: var(--m-text); background: var(--m-panel); border: 1px solid var(--m-border); border-radius: 0.6rem; transition: border-color 0.15s, transform 0.15s; }
.archify-model-open:hover { border-color: var(--m-accent); transform: translateY(-1px); }
.archify-model-open:focus-visible { outline: 2px solid var(--m-accent); outline-offset: 2px; }
.archify-model-item.is-broken .archify-model-open { border-style: dashed; }
.archify-model-item-title { font-weight: 600; font-size: 0.9375rem; }
.archify-model-item-meta { font-size: 0.75rem; color: var(--m-muted); font-family: ui-monospace, Menlo, monospace; }
.archify-model-empty { color: var(--m-muted); }
/* Element modal: where one element is defined and used. */
.archify-modal-backdrop { position: fixed; inset: 0; z-index: 1000; display: flex; align-items: flex-start; justify-content: center; padding: 6vh 1rem; background: rgba(0, 0, 0, 0.45); overflow: auto; }
.archify-modal { width: min(44rem, 100%); max-height: 88vh; overflow: auto; padding: 1.25rem 1.5rem 1.5rem; border-radius: 0.9rem; border: 1px solid var(--m-border); background: var(--m-panel); color: var(--m-text); box-shadow: 0 24px 60px rgba(0, 0, 0, 0.35); }
.archify-modal-head { display: flex; align-items: flex-start; gap: 0.75rem; }
.archify-modal-head .card-dot { flex: none; width: 12px; height: 12px; border-radius: 50%; margin-top: 0.45rem; }
.archify-modal-titles { flex: 1 1 auto; min-width: 0; }
.archify-modal-title { margin: 0; font-size: 1.25rem; font-weight: 700; letter-spacing: -0.01em; }
.archify-modal-close { flex: none; font: inherit; font-size: 1.25rem; line-height: 1; width: 2rem; height: 2rem; border-radius: 0.5rem; border: 1px solid var(--m-border); background: transparent; color: var(--m-muted); cursor: pointer; }
.archify-modal-close:hover { color: var(--m-text); border-color: var(--m-accent); }
.archify-modal-description { margin: 0.9rem 0 0; font-size: 0.9375rem; line-height: 1.55; color: var(--m-text); white-space: pre-line; }
.archify-modal-defined { margin: 0.75rem 0 0; font-size: 0.8125rem; color: var(--m-muted); display: flex; flex-wrap: wrap; align-items: center; gap: 0.35rem; }
.archify-modal .archify-model-title { margin: 1.25rem 0 0.6rem; }
.archify-modal .archify-model-list { grid-template-columns: repeat(auto-fill, minmax(220px, 1fr)); }
/* Decisions: rows, chips and status badges. */
.archify-decision-list { grid-template-columns: 1fr; gap: 0.35rem; }
.archify-decision-open { padding: 0.55rem 0.85rem; }
.archify-decision-line { display: flex; flex-wrap: wrap; align-items: baseline; gap: 0.5rem; }
.archify-decision-id { font-family: ui-monospace, Menlo, monospace; font-size: 0.8125rem; color: var(--m-muted); }
.archify-decision-status { font-size: 0.6875rem; font-weight: 600; letter-spacing: 0.04em; text-transform: uppercase; padding: 0.05rem 0.45rem; border-radius: 999px; border: 1px solid var(--m-border); color: var(--m-muted); }
.archify-decision-status.is-accepted { color: var(--m-backend); border-color: var(--m-backend); }
.archify-decision-status.is-proposed { color: var(--m-cloud); border-color: var(--m-cloud); }
.archify-decision-status.is-rejected { color: var(--m-security); border-color: var(--m-security); }
.archify-decision-item.is-superseded .archify-model-open, .archify-decision-item.is-rejected .archify-model-open { opacity: 0.6; }
.archify-decision-chip { display: inline-flex; align-items: center; gap: 0.35rem; font-family: inherit; }
.archify-decision-dot { width: 0.4rem; height: 0.4rem; border-radius: 50%; background: var(--m-muted); }
.archify-decision-chip.is-accepted .archify-decision-dot { background: var(--m-backend); }
.archify-decision-chip.is-proposed .archify-decision-dot { background: var(--m-cloud); }
.archify-decision-chip.is-rejected .archify-decision-dot { background: var(--m-security); }
.archify-decision-meta { display: flex; flex-wrap: wrap; align-items: center; gap: 0.6rem; margin: 0.4rem 0 0; }
.archify-decision-section { margin-top: 0.5rem; }
.archify-decision-text { margin: 0; max-width: 72ch; font-size: 0.9375rem; line-height: 1.6; color: var(--m-text); white-space: pre-line; }
/* Registry cards: Archify's own .card look, with fallbacks for the page without a diagram. */
.archify-model { --m-frontend: var(--frontend-stroke, #22d3ee); --m-backend: var(--backend-stroke, #34d399); --m-database: var(--database-stroke, #a78bfa); --m-cloud: var(--cloud-stroke, #fbbf24); --m-security: var(--security-stroke, #fb7185); --m-messagebus: var(--messagebus-stroke, #fb923c); --m-external: var(--external-stroke, #94a3b8); }
.archify-model-cards { display: grid; grid-template-columns: repeat(auto-fit, minmax(min(15rem, 100%), 1fr)); gap: 1rem; margin-top: 0.25rem; }
.archify-model-card { background: var(--m-panel); border: 1px solid var(--m-border); border-radius: 0.75rem; padding: 1.125rem 1.25rem; }
.archify-model-card .card-header { display: flex; align-items: center; gap: 0.6rem; margin-bottom: 0.6rem; }
.archify-model-card .card-dot { flex: none; width: 10px; height: 10px; border-radius: 50%; }
.archify-model-card .card-dot.cyan { background: var(--m-frontend); } .archify-model-card .card-dot.emerald { background: var(--m-backend); } .archify-model-card .card-dot.violet { background: var(--m-database); } .archify-model-card .card-dot.amber { background: var(--m-cloud); } .archify-model-card .card-dot.rose { background: var(--m-security); } .archify-model-card .card-dot.orange { background: var(--m-messagebus); } .archify-model-card .card-dot.slate { background: var(--m-external); }
.archify-model-card h3 { margin: 0; font-size: 0.9375rem; font-weight: 600; line-height: 1.4; color: var(--m-text); }
.archify-model-card ul { list-style: none; margin: 0; padding: 0; color: var(--m-muted); font-size: 0.8125rem; line-height: 1.6; }
.archify-model-card li { margin-bottom: 0.3rem; }
.archify-model-card li.archify-model-card-id, .archify-model-card li.archify-model-card-used { padding-left: 0; }
.archify-model-card li.archify-model-card-id::before, .archify-model-card li.archify-model-card-used::before { display: none; }
.archify-model-card-id { font-family: ui-monospace, Menlo, monospace; font-size: 0.75rem; }
.archify-model-card-used { display: flex; flex-wrap: wrap; gap: 0.3rem; margin-top: 0.5rem; }
.archify-model-used-link { font: inherit; font-size: 0.75rem; padding: 0.15rem 0.5rem; border-radius: 999px; border: 1px solid var(--m-border); background: transparent; color: var(--m-text); cursor: pointer; font-family: ui-monospace, Menlo, monospace; }
.archify-model-used-link:hover { border-color: var(--m-accent); }
`;
/* The Model | Graph switch: in Archify's toolbar it is the 2D | 3D switch's twin; on the model page it sits top right. */
const SWITCH_STYLE = `
.archify-mode-switch { display: inline-flex; align-items: center; padding: 0 0.25rem; gap: 0; color: var(--text-muted, var(--vscode-descriptionForeground)); position: relative; }
.toolbar .archify-mode-switch::before { content: ""; position: absolute; inset: 0.25rem 0; border-radius: 0.6875rem; background: color-mix(in srgb, var(--panel) 78%, transparent); box-shadow: inset 0 0 0 1px color-mix(in srgb, var(--panel-border) 85%, transparent), 0 1px 2px rgba(15, 23, 42, 0.04); backdrop-filter: blur(12px); }
.toolbar .archify-mode-switch:hover::before { box-shadow: inset 0 0 0 1px color-mix(in srgb, var(--text) 22%, transparent), 0 1px 2px rgba(15, 23, 42, 0.04); }
/* Anchored on the id: Archify's .toolbar button rules (one of them with :not(#btn-theme)) would win otherwise. */
#archify-mode-switch .archify-mode-seg { position: relative; display: inline-flex; align-items: center; height: 1.75rem; padding: 0 0.7rem; border: 0; border-radius: 0.5rem; background: transparent; color: inherit; font: inherit; font-weight: 550; font-size: 0.8125rem; cursor: pointer; transition: background 0.15s, color 0.15s; }
#archify-mode-switch .archify-mode-seg.on[aria-pressed="true"] { color: var(--bg, var(--vscode-editor-background)); background: var(--text, var(--vscode-foreground)); box-shadow: 0 1px 2px rgba(15, 23, 42, 0.12), 0 6px 16px -8px rgba(15, 23, 42, 0.4); }
#archify-mode-switch .archify-mode-seg:hover:not(.on) { color: var(--text, var(--vscode-foreground)); }
#archify-mode-switch .archify-mode-seg:focus-visible { outline: 2px solid var(--frontend-stroke, var(--vscode-focusBorder)); outline-offset: 1px; }
.archify-source-badge { display: inline-block; min-width: 1rem; margin-left: 0.35rem; padding: 0 0.3rem; border-radius: 999px; background: var(--security-stroke, var(--vscode-editorError-foreground, #f14c4c)); color: var(--bg, #fff); font-size: 0.6875rem; font-weight: 700; line-height: 1rem; text-align: center; }
.archify-source-badge[hidden] { display: none; }
.archify-model-switch-row { float: right; margin: 1.5rem 0 0 1rem; }
body > .archify-model-switch-row { position: relative; z-index: 2; margin: 1rem 1.25rem 0 1rem; }
.archify-model-switch-row .archify-mode-switch { border: 1px solid var(--m-border, var(--vscode-editorWidget-border, rgba(128,128,128,.35))); border-radius: 0.75rem; background: var(--m-panel, var(--vscode-editorWidget-background)); padding: 0.1rem 0.25rem; }
`;
/* Connectors rail panel: highlight of the hovered or selected edge in the SVG. */
const CONNECTOR_STYLE = `
.diagram-container svg [data-edge-key][data-archify-hit] path, .diagram-container svg [data-edge-key][data-archify-selected] path { stroke-width: 3px; filter: drop-shadow(0 0 3px currentColor); }
.diagram-container svg [data-edge-key][data-archify-selected] text { font-weight: 700; }
.archify-connectors .node-outline-item strong { font-weight: 600; }
.diagram-container svg [data-node-id][data-archify-hit] { filter: drop-shadow(0 0 6px var(--frontend-stroke)); }
/* Bottom rail with a Decisions panel: three columns. */
html[data-reader-rail="bottom"] .reader-rail:has(> #archify-decisions) { grid-template-areas: "cards cards cards" "index connectors decisions"; grid-template-columns: repeat(3, minmax(0, 1fr)); }
html[data-reader-rail="bottom"] .reader-rail:has(> #archify-decisions):has(> #node-outline[hidden]) { grid-template-areas: "cards cards" "connectors decisions"; grid-template-columns: repeat(2, minmax(0, 1fr)); }
html[data-reader-rail="bottom"] .reader-rail > #archify-decisions { display: block; grid-area: decisions; padding: 0 1.25rem 0.75rem; border: 1px solid var(--panel-border); border-radius: 0.75rem; background: var(--panel); }
html[data-reader-rail="bottom"] .reader-rail > #archify-decisions .node-outline-head { padding: 1rem 0.25rem 0.375rem; }
html[data-reader-rail="bottom"] .reader-rail > #archify-decisions .node-outline-list { columns: 15rem; column-gap: 1.75rem; padding: 0; overflow: visible; -webkit-mask-image: none; mask-image: none; }
.archify-decision-rail-item.is-superseded, .archify-decision-rail-item.is-rejected { opacity: 0.6; }
/* Bottom rail: Elements and Connectors side by side; Connectors alone when Archify hides its index. */
html[data-reader-rail="bottom"] .reader-rail:has(> .archify-connectors) { grid-template-areas: "cards cards" "index connectors"; grid-template-columns: minmax(0, 1fr) minmax(0, 1fr); column-gap: 1rem; }
html[data-reader-rail="bottom"] .reader-rail:has(> .archify-connectors):has(> #node-outline[hidden]) { grid-template-areas: "cards" "connectors"; grid-template-columns: minmax(0, 1fr); }
html[data-reader-rail="bottom"] .reader-rail > #archify-connectors { display: block; grid-area: connectors; padding: 0 1.25rem 0.75rem; border: 1px solid var(--panel-border); border-radius: 0.75rem; background: var(--panel); }
html[data-reader-rail="bottom"] .reader-rail > #archify-connectors .node-outline-head { padding: 1rem 0.25rem 0.375rem; }
html[data-reader-rail="bottom"] .reader-rail > #archify-connectors .node-outline-list { columns: 15rem; column-gap: 1.75rem; padding: 0; overflow: visible; -webkit-mask-image: none; mask-image: none; }
`;
const NOTICE_STYLE = ` const NOTICE_STYLE = `
.archify-vscode-notice { .archify-vscode-notice {
position: fixed; left: 12px; right: 12px; bottom: 12px; z-index: 2147483647; position: fixed; left: 12px; right: 12px; bottom: 12px; z-index: 2147483647;
@@ -197,9 +944,12 @@ export function prepareDiagramHtml(html: string, options: PageOptions): string {
const head = const head =
`<meta http-equiv="Content-Security-Policy" content="${escapeHtml(contentSecurityPolicy(options.cspSource, options.nonce))}">\n` + `<meta http-equiv="Content-Security-Policy" content="${escapeHtml(contentSecurityPolicy(options.cspSource, options.nonce))}">\n` +
`<script nonce="${options.nonce}">${bridgeScript(options)}</script>\n` + `<script nonce="${options.nonce}">${bridgeScript(options)}</script>\n` +
`<style>${NOTICE_STYLE}</style>\n`; `<style>${NOTICE_STYLE}${CONNECTOR_STYLE}${SWITCH_STYLE}${options.model ? MODEL_STYLE : ''}</style>\n`;
let page = html let page = html
// Archify calls its node rail "Node index"; next to the registry it reads better as Elements.
.replace(/(id="node-outline-title">)Node index(<)/, '$1Elements$2')
.replace(/("viewer\.outline\.title":")Node index(")/, '$1Elements$2')
// Drop any CSP the file brings along; ours is the one that applies. // Drop any CSP the file brings along; ours is the one that applies.
.replace(/<meta\s+http-equiv=["']Content-Security-Policy["'][^>]*>/gi, '') .replace(/<meta\s+http-equiv=["']Content-Security-Policy["'][^>]*>/gi, '')
// Allow the page's own inline scripts to run under the nonce policy. // Allow the page's own inline scripts to run under the nonce policy.
@@ -220,22 +970,108 @@ export function prepareDiagramHtml(html: string, options: PageOptions): string {
return page; return page;
} }
/** A small VS Code-styled page for loading and error states. */ /** The model page for a main.archify without a diagram of its own. */
export function messagePage( export function modelPage(options: Pick<PageOptions, 'cspSource' | 'nonce' | 'state' | 'source'>, model: ModelPanel): string {
options: Pick<PageOptions, 'cspSource' | 'nonce' | 'state'>, const bridge = bridgeScript({ cspSource: options.cspSource, nonce: options.nonce, theme: undefined, state: options.state, model, links: {}, graphSwitch: { left: 'Model' }, source: options.source });
title: string,
body: string,
detail?: string,
): string {
return `<!DOCTYPE html> return `<!DOCTYPE html>
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="UTF-8"> <meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="Content-Security-Policy" content="${escapeHtml(contentSecurityPolicy(options.cspSource, options.nonce))}"> <meta http-equiv="Content-Security-Policy" content="${escapeHtml(contentSecurityPolicy(options.cspSource, options.nonce))}">
<script nonce="${options.nonce}">(function () { var vscode = acquireVsCodeApi(); var state = ${scriptJson(options.state)}; if (state) vscode.setState(state); })();</script> <script nonce="${options.nonce}">${bridge}</script>
<style>
body { margin: 0; color: var(--vscode-foreground); background: var(--vscode-editor-background); }
${MODEL_STYLE}
${SWITCH_STYLE}
</style>
</head>
<body></body>
</html>`;
}
/** The Graph page of a model: the bundled script builds everything from the host's graph data. */
export function graphPage(options: Pick<PageOptions, 'cspSource' | 'nonce' | 'state'>, graph: NonNullable<PageOptions['graph']>): string {
const bridge = bridgeScript({ cspSource: options.cspSource, nonce: options.nonce, theme: undefined, state: options.state, links: {}, graph });
return `<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="Content-Security-Policy" content="${escapeHtml(contentSecurityPolicy(options.cspSource, options.nonce))}">
<script nonce="${options.nonce}">${bridge}</script>
<script nonce="${options.nonce}" defer src="${escapeHtml(graph.scriptUri)}"></script>
<style>
html, body { margin: 0; height: 100%; color: var(--vscode-foreground); background: var(--vscode-editor-background); }
${NOTICE_STYLE}
</style>
</head>
<body></body>
</html>`;
}
/** The registry page for one .archify-registry file. */
export function registryPage(options: Pick<PageOptions, 'cspSource' | 'nonce' | 'state' | 'source'>, registry: RegistryPanel): string {
const bridge = bridgeScript({ cspSource: options.cspSource, nonce: options.nonce, theme: undefined, state: options.state, registry, links: {}, source: options.source });
return `<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="Content-Security-Policy" content="${escapeHtml(contentSecurityPolicy(options.cspSource, options.nonce))}">
<script nonce="${options.nonce}">${bridge}</script>
<style>
body { margin: 0; color: var(--vscode-foreground); background: var(--vscode-editor-background); }
${MODEL_STYLE}
${SWITCH_STYLE}
${NOTICE_STYLE}
</style>
</head>
<body></body>
</html>`;
}
/** The decision page for one .archify-decision file. */
export function decisionPage(options: Pick<PageOptions, 'cspSource' | 'nonce' | 'state' | 'source'>, decision: DecisionPanel): string {
const bridge = bridgeScript({ cspSource: options.cspSource, nonce: options.nonce, theme: undefined, state: options.state, decision, links: {}, source: options.source });
return `<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="Content-Security-Policy" content="${escapeHtml(contentSecurityPolicy(options.cspSource, options.nonce))}">
<script nonce="${options.nonce}">${bridge}</script>
<style>
body { margin: 0; color: var(--vscode-foreground); background: var(--vscode-editor-background); }
${MODEL_STYLE}
${SWITCH_STYLE}
${NOTICE_STYLE}
</style>
</head>
<body></body>
</html>`;
}
/** A small VS Code-styled page for loading and error states; with `source`, the YAML can be fixed in place. */
export function messagePage(
options: Pick<PageOptions, 'cspSource' | 'nonce' | 'state' | 'source'>,
title: string,
body: string,
detail?: string,
): string {
const script = options.source
? bridgeScript({ cspSource: options.cspSource, nonce: options.nonce, theme: undefined, state: options.state, links: {}, source: options.source })
: `(function () { var vscode = acquireVsCodeApi(); var state = ${scriptJson(options.state)}; if (state) vscode.setState(state); })();`;
return `<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="Content-Security-Policy" content="${escapeHtml(contentSecurityPolicy(options.cspSource, options.nonce))}">
<script nonce="${options.nonce}">${script}</script>
<style> <style>
body { font-family: var(--vscode-font-family); color: var(--vscode-foreground); background: var(--vscode-editor-background); padding: 24px 28px; } body { font-family: var(--vscode-font-family); color: var(--vscode-foreground); background: var(--vscode-editor-background); padding: 24px 28px; }
${options.source ? SWITCH_STYLE + NOTICE_STYLE : ''}
h2 { font-weight: 600; font-size: 15px; margin: 0 0 8px; } h2 { font-weight: 600; font-size: 15px; margin: 0 0 8px; }
p { margin: 0 0 12px; color: var(--vscode-descriptionForeground); } p { margin: 0 0 12px; color: var(--vscode-descriptionForeground); }
pre { font-family: var(--vscode-editor-font-family); font-size: 12px; white-space: pre-wrap; word-break: break-word; pre { font-family: var(--vscode-editor-font-family); font-size: 12px; white-space: pre-wrap; word-break: break-word;
+5
View File
@@ -0,0 +1,5 @@
// The package's "./yaml" export needs "bundler" module resolution; this
// repository resolves like Node 10, so point at its types directly.
declare module 'codemirror-json-schema/yaml' {
export * from 'codemirror-json-schema/dist/yaml/index';
}
+157
View File
@@ -0,0 +1,157 @@
import { autocompletion, closeBrackets, closeBracketsKeymap, completionKeymap } from '@codemirror/autocomplete';
import { defaultKeymap, history, historyKeymap, indentWithTab } from '@codemirror/commands';
import { yaml, yamlLanguage } from '@codemirror/lang-yaml';
import { HighlightStyle, bracketMatching, foldGutter, foldKeymap, indentOnInput, indentUnit, syntaxHighlighting } from '@codemirror/language';
import { lintGutter, lintKeymap, nextDiagnostic, setDiagnostics } from '@codemirror/lint';
import { Annotation, EditorState, Transaction } from '@codemirror/state';
import {
EditorView,
drawSelection,
dropCursor,
highlightActiveLine,
highlightActiveLineGutter,
highlightSpecialChars,
hoverTooltip,
keymap,
lineNumbers,
rectangularSelection,
} from '@codemirror/view';
import { tags as t } from '@lezer/highlight';
import { stateExtensions, updateSchema } from 'codemirror-json-schema';
import { yamlCompletion, yamlSchemaHover } from 'codemirror-json-schema/yaml';
import type { TextChange } from '../../util/textDiff';
/** A problem from the host, as offsets into the "\n" text it checked. */
export interface SourceDiagnostic {
from: number;
to: number;
severity: 'error' | 'warning' | 'info';
message: string;
source?: string;
}
/** Marks transactions that carry text from the host, so they are not sent back. */
const fromHost = Annotation.define<boolean>();
// The page's own variables (Archify's, or ours on model pages), so the
// editor follows the page theme, light or dark.
const theme = EditorView.theme({
'&': { height: '100%', color: 'var(--text, var(--vscode-editor-foreground))', backgroundColor: 'transparent', fontSize: '12.5px' },
'.cm-scroller': { fontFamily: 'var(--vscode-editor-font-family, ui-monospace, Menlo, "SF Mono", monospace)', lineHeight: '1.6' },
'.cm-content': { caretColor: 'var(--frontend-stroke, var(--vscode-editorCursor-foreground))' },
'.cm-cursor, .cm-dropCursor': { borderLeftColor: 'var(--frontend-stroke, var(--vscode-editorCursor-foreground))' },
'.cm-gutters': { backgroundColor: 'transparent', color: 'var(--text-muted, var(--vscode-editorLineNumber-foreground))', border: 'none' },
'.cm-activeLine, .cm-activeLineGutter': { backgroundColor: 'color-mix(in srgb, var(--text, var(--vscode-editor-foreground)) 5%, transparent)' },
'&.cm-focused .cm-selectionBackground, .cm-selectionBackground, .cm-content ::selection': {
backgroundColor: 'color-mix(in srgb, var(--frontend-stroke, var(--vscode-editor-selectionBackground)) 28%, transparent) !important',
},
'&.cm-focused': { outline: 'none' },
'.cm-tooltip': {
backgroundColor: 'var(--panel, var(--vscode-editorHoverWidget-background))',
color: 'var(--text, var(--vscode-editorHoverWidget-foreground))',
border: '1px solid var(--panel-border, var(--vscode-editorHoverWidget-border))',
borderRadius: '8px',
maxWidth: '440px',
},
'.cm-tooltip code': { fontFamily: 'var(--vscode-editor-font-family, ui-monospace, Menlo, monospace)', color: 'var(--frontend-stroke, var(--vscode-textPreformat-foreground))' },
'.cm-tooltip-autocomplete ul li[aria-selected]': { backgroundColor: 'var(--frontend-stroke, var(--vscode-list-activeSelectionBackground))', color: 'var(--bg, var(--vscode-list-activeSelectionForeground))' },
'.cm-diagnostic': { padding: '4px 8px' },
'.cm-foldPlaceholder': { backgroundColor: 'transparent', border: '1px solid var(--panel-border, var(--vscode-editorWidget-border))', color: 'inherit' },
});
const highlight = HighlightStyle.define([
{ tag: [t.propertyName, t.definition(t.propertyName)], color: 'var(--frontend-stroke, var(--vscode-symbolIcon-propertyForeground, #22d3ee))' },
{ tag: [t.number, t.bool, t.null, t.atom], color: 'var(--cloud-stroke, var(--vscode-debugTokenExpression-number, #fbbf24))' },
{ tag: [t.comment, t.lineComment], color: 'var(--text-muted, var(--vscode-descriptionForeground))', fontStyle: 'italic' },
{ tag: [t.punctuation, t.separator, t.squareBracket, t.brace], color: 'var(--text-muted, var(--vscode-descriptionForeground))' },
{ tag: [t.keyword, t.typeName, t.labelName, t.meta], color: 'var(--database-stroke, var(--vscode-symbolIcon-keywordForeground, #a78bfa))' },
]);
export class SourceEditor {
readonly view: EditorView;
private schemaKey: string | undefined;
constructor(parent: HTMLElement, text: string, onEdit: (changes: TextChange[], text: string) => void) {
this.view = new EditorView({
parent,
state: EditorState.create({
doc: text,
extensions: [
// Undo and redo are the editor's own: VS Code sends ⌘Z in a focused
// webview to the webview, not to the document. Every step still
// reaches the document as an edit. Save and find stay VS Code's
// (no search panel here).
history(),
lineNumbers(),
highlightActiveLineGutter(),
highlightSpecialChars(),
foldGutter(),
drawSelection(),
dropCursor(),
EditorState.allowMultipleSelections.of(true),
indentOnInput(),
bracketMatching(),
closeBrackets(),
autocompletion(),
rectangularSelection(),
highlightActiveLine(),
keymap.of([...closeBracketsKeymap, ...defaultKeymap, ...historyKeymap, ...foldKeymap, ...completionKeymap, ...lintKeymap, indentWithTab]),
EditorState.tabSize.of(2),
indentUnit.of(' '),
yaml(),
theme,
syntaxHighlighting(highlight),
lintGutter(),
stateExtensions(undefined as never),
yamlLanguage.data.of({ autocomplete: yamlCompletion() }),
hoverTooltip(yamlSchemaHover()),
EditorView.updateListener.of((update) => {
if (!update.docChanged || update.transactions.some((tr) => tr.annotation(fromHost))) return;
const changes: TextChange[] = [];
update.changes.iterChanges((fromA, toA, _fromB, _toB, inserted) => changes.push({ from: fromA, to: toA, insert: inserted.toString() }));
onEdit(changes, update.state.doc.toString());
}),
],
}),
});
}
get text(): string {
return this.view.state.doc.toString();
}
/** Text from the host (an edit elsewhere, git): one change, cursor kept, not undoable here. */
applyFromHost(change: TextChange): void {
this.view.dispatch({ changes: change, annotations: [fromHost.of(true), Transaction.addToHistory.of(false)] });
}
/** The schema that completion and hover read; `undefined` turns them off. */
setSchema(key: string | undefined, schema: object | undefined): void {
if (key === this.schemaKey) return;
this.schemaKey = key;
updateSchema(this.view, schema as never);
}
/** The host's problems for the text it checked; the editor maps them through later typing. */
setDiagnostics(items: SourceDiagnostic[]): void {
const length = this.view.state.doc.length;
const diagnostics = items
.filter((d) => d.from <= length)
.map((d) => ({ from: d.from, to: Math.min(Math.max(d.to, d.from), length), severity: d.severity, message: d.message, source: d.source }));
this.view.dispatch(setDiagnostics(this.view.state, diagnostics));
}
/** Moves the cursor to the next problem and opens its message. */
nextProblem(): void {
this.view.focus();
nextDiagnostic(this.view);
}
focus(): void {
this.view.focus();
}
requestMeasure(): void {
this.view.requestMeasure();
}
}
+195
View File
@@ -0,0 +1,195 @@
import type { ArchifyHost } from '../host';
import { TextChange, minimalChange } from '../../util/textDiff';
import { SourceDiagnostic, SourceEditor } from './editor';
/**
* The Source view of an Archify page: the file's YAML in an editor, in the
* page under its toolbar and heading, in place of the picture. The bridge
* script (page.ts) loads this file the first time Source is chosen and calls
* window.__archifySource.open(); the document itself stays in the host, which
* applies every edit to it and sends back problems and outside changes.
*/
/** Host → page. */
type HostMessage =
| { type: 'sourceText'; text: string; schema?: { key: string; schema: object } | null; checks: string }
| { type: 'sourceDiagnostics'; items: SourceDiagnostic[]; count: number }
| { type: 'sourceSchema'; schema: { key: string; schema: object } | null }
| { type: 'sourceDirty'; dirty: boolean };
const STYLE = `
html.archify-source-on .container > :not(.header):not(#archify-source),
html.archify-source-on body > :not(.toolbar):not(.container):not(.archify-model-head):not(.archify-model-switch-row):not(#archify-source):not(script):not(style):not(.archify-modal-backdrop),
html.archify-source-on #btn-3d,
html.archify-source-on .archify-vscode-notice { display: none !important; }
.archify-source { display: flex; flex-direction: column; box-sizing: border-box; min-height: 260px; margin: 0.75rem 0 1rem; }
body > .archify-source { max-width: 1400px; margin: 0.75rem auto 1rem; padding: 0 2rem; }
.archify-source-editor { flex: 1; min-height: 0; overflow: hidden; border: 1px solid var(--panel-border, var(--vscode-editorWidget-border, rgba(128,128,128,.35))); border-radius: 0.75rem;
background: color-mix(in srgb, var(--panel, var(--vscode-editor-background)) 70%, transparent); }
.archify-source-editor .cm-editor { height: 100%; }
.archify-source-strip { display: flex; flex-wrap: wrap; gap: 0.35rem 1rem; align-items: center; padding: 0.45rem 0.25rem 0; font-size: 0.75rem;
color: var(--text-muted, var(--vscode-descriptionForeground)); font-family: var(--vscode-font-family, system-ui, sans-serif); }
.archify-source-strip .is-ok { color: var(--backend-stroke, var(--vscode-testing-iconPassed, #34d399)); }
.archify-source-strip .is-bad { color: var(--security-stroke, var(--vscode-editorError-foreground, #fb7185)); }
.archify-source-strip button { font: inherit; color: inherit; background: none; border: 0; padding: 0; cursor: pointer; }
.archify-source-strip button:hover { text-decoration: underline; }
.archify-source-strip .archify-source-hint { margin-left: auto; }
.archify-source-strip kbd { font: inherit; font-size: 0.6875rem; padding: 0 0.3rem; border: 1px solid currentColor; border-radius: 0.25rem; opacity: 0.8; }
`;
const MAC = /Mac|iPhone|iPad/.test(navigator.platform);
function isUndoRedo(event: KeyboardEvent): boolean {
const key = event.key.toLowerCase();
return (event.metaKey || event.ctrlKey) && !event.altKey && (key === 'z' || key === 'y');
}
class SourcePane {
private root: HTMLElement | undefined;
private editorHost!: HTMLElement;
private stateEl!: HTMLElement;
private countEl!: HTMLButtonElement;
private checksEl!: HTMLElement;
private editor: SourceEditor | undefined;
/** The text the host last knew the page to have; edits are sent against it. */
private text = '';
private diagnostics: SourceDiagnostic[] = [];
private shown = false;
constructor(private readonly host: ArchifyHost) {
window.addEventListener('message', (event) => this.onMessage(event.data as HostMessage));
window.addEventListener('resize', () => this.fit());
}
open(): void {
this.build();
this.shown = true;
document.documentElement.classList.add('archify-source-on');
window.dispatchEvent(new CustomEvent('archify-source', { detail: { on: true } }));
this.fit();
this.host.post({ type: 'sourceOpen' });
this.editor?.focus();
}
close(): void {
this.shown = false;
document.documentElement.classList.remove('archify-source-on');
window.dispatchEvent(new CustomEvent('archify-source', { detail: { on: false } }));
this.host.post({ type: 'sourceClose' });
}
private build(): void {
if (this.root) return;
const style = document.createElement('style');
style.textContent = STYLE;
document.head.appendChild(style);
const root = document.createElement('section');
root.id = 'archify-source';
root.className = 'archify-source';
root.setAttribute('aria-label', 'Source');
this.editorHost = document.createElement('div');
this.editorHost.className = 'archify-source-editor';
const strip = document.createElement('div');
strip.className = 'archify-source-strip';
this.stateEl = document.createElement('span');
this.countEl = document.createElement('button');
this.countEl.type = 'button';
this.countEl.title = 'Go to the next problem';
this.countEl.addEventListener('click', () => this.editor?.nextProblem());
this.checksEl = document.createElement('span');
const hint = document.createElement('span');
hint.className = 'archify-source-hint';
hint.innerHTML = 'Completion as you type, or <kbd>Ctrl</kbd>+<kbd>Space</kbd> · hover a key for its description';
strip.append(this.stateEl, this.countEl, this.checksEl, hint);
root.append(this.editorHost, strip);
this.renderState(false);
this.renderCount();
// Archify's page has single-key shortcuts; typing here must not reach
// them. Keys with ⌘ or Ctrl go on to VS Code (save, find, quick open),
// except undo and redo, which the editor has handled already.
for (const type of ['keydown', 'keypress', 'keyup'] as const) {
root.addEventListener(type, (event) => {
if (!event.metaKey && !event.ctrlKey) event.stopPropagation();
else if (isUndoRedo(event)) event.stopPropagation();
});
}
const header = document.querySelector('.container > .header');
const modelHead = document.querySelector('.archify-model-head');
if (header?.parentElement) header.parentElement.insertBefore(root, header.nextSibling);
else if (modelHead?.parentElement) modelHead.parentElement.insertBefore(root, modelHead.nextSibling);
else document.body.appendChild(root);
this.root = root;
}
/** The editor fills the window below where it starts. */
private fit(): void {
if (!this.root || !this.shown) return;
const top = this.root.getBoundingClientRect().top;
this.root.style.height = `${Math.max(260, window.innerHeight - Math.max(top, 0) - 12)}px`;
this.editor?.requestMeasure();
}
private onMessage(message: HostMessage): void {
if (!message || typeof message !== 'object') return;
switch (message.type) {
case 'sourceText':
this.build();
if (!this.editor) {
this.text = message.text;
this.editor = new SourceEditor(this.editorHost, message.text, (changes, text) => this.onEdit(changes, text));
this.editor.setDiagnostics(this.diagnostics);
this.fit();
if (this.shown) this.editor.focus();
} else {
const change = minimalChange(this.editor.text, message.text);
if (change) this.editor.applyFromHost(change);
this.text = message.text;
}
if (message.schema !== undefined) this.editor.setSchema(message.schema?.key, message.schema?.schema);
this.checksEl.textContent = message.checks;
return;
case 'sourceDiagnostics':
this.diagnostics = message.items;
this.editor?.setDiagnostics(message.items);
this.renderCount();
return;
case 'sourceSchema':
this.editor?.setSchema(message.schema?.key, message.schema?.schema);
return;
case 'sourceDirty':
this.renderState(message.dirty);
return;
}
}
private onEdit(changes: TextChange[], text: string): void {
const base = this.text;
this.text = text;
this.host.post({ type: 'sourceEdit', base, text, changes });
}
private renderState(dirty: boolean): void {
if (!this.stateEl) return;
this.stateEl.innerHTML = dirty ? `● Unsaved · <kbd>${MAC ? '⌘' : 'Ctrl+'}S</kbd> saves` : 'Saved';
}
private renderCount(): void {
if (!this.countEl) return;
const problems = this.diagnostics.filter((d) => d.severity !== 'info').length;
this.countEl.className = problems ? 'is-bad' : 'is-ok';
this.countEl.textContent = problems ? `✕ ${problems} problem${problems === 1 ? '' : 's'}` : '✓ No problems';
this.countEl.disabled = !problems;
}
}
declare global {
interface Window {
__archifySource?: { open(): void; close(): void };
}
}
const host = window.__archifyHost;
if (host) window.__archifySource = new SourcePane(host);
+10
View File
@@ -0,0 +1,10 @@
// Stands in for codemirror-json-schema's utils/markdown, which brings
// markdown-it and shiki (about 400 KB) to format schema descriptions. Ours
// only use `code` spans: escape the text and keep those. esbuild.mjs swaps
// this file in.
const escape = (s: string) => s.replace(/[&<>"]/g, (c) => ({ '&': '&amp;', '<': '&lt;', '>': '&gt;', '"': '&quot;' })[c]!);
export function renderMarkdown(markdown: string, inline = true): string {
const html = escape(String(markdown)).replace(/`([^`]+)`/g, '<code>$1</code>');
return inline ? html : `<p>${html.replace(/\n{2,}/g, '</p><p>')}</p>`;
}
+10
View File
@@ -13,3 +13,13 @@ export function viewer3dOption(webview: vscode.Webview, extensionUri: vscode.Uri
defaultView, defaultView,
}; };
} }
/** The Graph page script (a webview URI). */
export function graphScriptUri(webview: vscode.Webview, extensionUri: vscode.Uri): string {
return webview.asWebviewUri(vscode.Uri.joinPath(extensionUri, 'dist', 'graph.js')).toString();
}
/** The Source view script (a webview URI), loaded by the page the first time Source is chosen. */
export function sourceScriptUri(webview: vscode.Webview, extensionUri: vscode.Uri): string {
return webview.asWebviewUri(vscode.Uri.joinPath(extensionUri, 'dist', 'source.js')).toString();
}
+17
View File
@@ -0,0 +1,17 @@
# An architecture decision of this model. The id is unique in the model;
# elements are registry ids, diagrams are paths from the model root.
schema_version: 1
decision:
id: __ID__
title: __TITLE__
status: proposed # proposed | accepted | superseded | rejected
date: __DATE__
elements: []
diagrams: []
supersedes: []
context: >
What was the situation, and what forced a decision.
decision: >
What was decided, in one or two sentences.
consequences: >
What becomes easier, what becomes harder, what must change.
+27
View File
@@ -0,0 +1,27 @@
# main.archify: the entry point of a model, a folder of diagrams that belong
# together. The folder that holds this file is the model's root. Diagrams
# below it may refer to shared elements from *.archify-registry files.
schema_version: 1
model:
id: my-model
name: My Model
description: >
What this model covers, in a sentence or two.
# Optional: a diagram of your own for the model page (an overview).
diagram_type: architecture
meta:
title: Overview
output: main.html
components:
- id: users
type: external
label: Users
pos: [40, 160]
size: [130, 60]
- id: system
type: cloud
label: The system
pos: [250, 160]
size: [150, 60]
connections:
- { from: users, to: system, label: use }
@@ -0,0 +1,26 @@
schema_version: 1
diagram_type: architecture
meta:
title: System context
output: context.html
components:
- ref: customer
pos: [40, 60]
size: [130, 60]
- ref: support
pos: [40, 260]
size: [130, 60]
- ref: shop
pos: [280, 160]
size: [150, 60]
- ref: psp
pos: [520, 60]
size: [150, 60]
- ref: email
pos: [520, 260]
size: [150, 60]
connections:
- { from: customer, to: shop, label: buys, variant: emphasis }
- { from: support, to: shop, label: manages orders }
- { from: shop, to: psp, label: charges, variant: security }
- { from: shop, to: email, label: sends mail }
@@ -0,0 +1,41 @@
schema_version: 1
diagram_type: architecture
meta:
title: Containers
output: containers.html
decisions: [postgres-as-source-of-truth]
components:
- ref: customer
pos: [40, 160]
size: [130, 60]
- ref: web
pos: [250, 160]
size: [130, 60]
- ref: api
pos: [460, 160]
size: [130, 60]
- ref: cache
pos: [670, 60]
size: [130, 60]
- ref: db
pos: [670, 260]
size: [130, 60]
- ref: queue
pos: [460, 360]
size: [130, 60]
decisions: [queue-between-api-and-worker]
- ref: worker
pos: [670, 460]
size: [130, 60]
boundaries:
- kind: region
label: Online Shop
wraps: [web, api, cache, db, queue, worker]
connections:
- { from: customer, to: web, label: HTTPS, variant: emphasis }
- { from: web, to: api, label: JSON }
- { from: api, to: cache, label: read }
- { from: api, to: db, label: SQL }
- { from: api, to: queue, label: enqueue, labelAt: [560, 290], decisions: [queue-between-api-and-worker] }
- { from: queue, to: worker, label: poll }
- { from: worker, to: db, label: SQL, labelAt: [735, 420] }
@@ -0,0 +1,42 @@
schema_version: 1
diagram_type: architecture
meta:
title: API components
output: api.html
components:
- ref: web
pos: [40, 160]
size: [130, 60]
- id: auth
type: security
label: Auth
sublabel: sessions, OIDC
pos: [250, 60]
size: [130, 60]
- id: orders
type: backend
label: Orders
pos: [250, 160]
size: [130, 60]
- id: catalogue
type: backend
label: Catalogue
pos: [250, 260]
size: [130, 60]
- ref: db
pos: [460, 160]
size: [130, 60]
- ref: queue
pos: [460, 310]
size: [130, 60]
boundaries:
- kind: region
label: API
wraps: [auth, orders, catalogue]
connections:
- { from: web, to: auth, label: sign in, variant: security }
- { from: web, to: orders, label: place order }
- { from: web, to: catalogue, label: browse }
- { from: orders, to: db, label: SQL }
- { from: catalogue, to: db, label: SQL }
- { from: orders, to: queue, label: enqueue }
@@ -0,0 +1,20 @@
schema_version: 1
decision:
id: postgres-as-source-of-truth
title: PostgreSQL as the single source of truth
status: accepted
date: 2026-09-02
elements: [db, api, worker]
diagrams: [0200-containers/online-shop.archify]
context: >
Orders, customers and the catalogue were spread over the
shop database and two spreadsheets kept by support.
Refunds were reconciled by hand every Monday.
decision: >
One PostgreSQL database owns orders, customers and the
catalogue. The API is the only writer. Everything else
(cache, search, reports) is derived and may be rebuilt.
consequences: >
Support loses the spreadsheets and gets the admin console.
Any new store must be declared derived or get its own
decision. Backups and migrations are the API team's job.
@@ -0,0 +1,20 @@
schema_version: 1
decision:
id: queue-between-api-and-worker
title: A queue between the API and the worker
status: accepted
date: 2026-09-16
elements: [api, queue, worker]
diagrams: [0200-containers/online-shop.archify]
context: >
Order confirmation emails and invoices were sent inside
the checkout request. A slow mail provider made checkout
slow; a failing one made checkout fail.
decision: >
The API enqueues a job per side effect on SQS. One worker
service consumes the queue and does the slow work.
Checkout returns as soon as the order is stored.
consequences: >
Emails arrive seconds later, not instantly. Jobs must be
idempotent because SQS delivers at least once. The worker
is the second place that writes to the database.
@@ -0,0 +1,20 @@
schema_version: 1
decision:
id: opensearch-for-product-search
title: OpenSearch for product search
status: proposed
date: 2026-10-19
elements: [api, worker, db]
diagrams: [0200-containers/online-shop.archify]
context: >
Catalogue search runs as SQL LIKE queries on the
database. Typos find nothing and the catalogue page is
the slowest page in the shop.
decision: >
Add a dedicated search service on OpenSearch. The API
queries it; the worker rebuilds the index from the
database after every catalogue change.
consequences: >
The index is derived data under decision 0001 and may be
rebuilt at any time. One more service to run. Search
results can lag the database by the rebuild interval.
+24
View File
@@ -0,0 +1,24 @@
schema_version: 1
model:
id: e-shop
name: E-Shop
description: >
The web shop, its API and workers, and the stores behind them.
Context, containers and components, C4 style.
diagram_type: architecture
meta:
title: E-Shop — overview
output: main.html
components:
- ref: customer
pos: [40, 160]
size: [130, 60]
- ref: shop
pos: [250, 160]
size: [150, 60]
- ref: psp
pos: [480, 160]
size: [150, 60]
connections:
- { from: customer, to: shop, label: buys, variant: emphasis }
- { from: shop, to: psp, label: charges }
@@ -0,0 +1,37 @@
schema_version: 1
elements:
web:
type: frontend
label: Web App
sublabel: React
brand: react
description: The shop as customers see it; talks only to the API.
api:
type: backend
label: API
sublabel: Node.js
brand: node-js
description: Owns authentication, orders and the catalogue.
diagram: 0300-components/api.archify
worker:
type: backend
label: Worker
sublabel: async jobs
description: Picks jobs from the queue; emails, invoices, exports.
queue:
type: messagebus
label: Queue
sublabel: SQS
description: Job queue between the API and the workers.
db:
type: database
label: Database
sublabel: PostgreSQL
brand: postgresql
description: Orders, customers and catalogue; the source of truth.
cache:
type: database
label: Cache
sublabel: Redis
brand: redis
description: Sessions and catalogue cache; nothing here is the source of truth.
@@ -0,0 +1,12 @@
schema_version: 1
elements:
customer:
type: external
label: Customer
sublabel: web and mobile
description: Buys products; signs in with email or a social account.
support:
type: external
label: Support agent
sublabel: back office
description: Handles refunds and order problems in the admin console.
@@ -0,0 +1,19 @@
schema_version: 1
elements:
shop:
type: cloud
label: Online Shop
sublabel: the system
description: Everything we build and run; web app, API, workers and stores.
diagram: 0200-containers/online-shop.archify
psp:
type: external
label: Payment provider
sublabel: Stripe
brand: stripe
description: Charges cards and pays out; we never see card numbers.
email:
type: external
label: Email service
sublabel: transactional mail
description: Sends order confirmations and password resets.
@@ -0,0 +1,26 @@
schema_version: 1
diagram_type: architecture
meta:
title: System context
output: context.html
components:
- ref: crm
pos: [40, 60]
size: [130, 60]
- ref: erp
pos: [40, 260]
size: [130, 60]
- ref: platform
pos: [280, 160]
size: [170, 60]
- ref: warehouse
pos: [540, 60]
size: [150, 60]
- ref: ops
pos: [540, 260]
size: [150, 60]
connections:
- { from: crm, to: platform, label: customer events, variant: emphasis }
- { from: erp, to: platform, label: order events, variant: emphasis }
- { from: platform, to: warehouse, label: pick lists }
- { from: ops, to: platform, label: replays, variant: dashed }
@@ -0,0 +1,46 @@
schema_version: 1
diagram_type: architecture
meta:
title: Containers
output: containers.html
components:
- ref: crm
pos: [40, 60]
size: [130, 60]
- ref: erp
pos: [40, 260]
size: [130, 60]
- ref: ingest
pos: [250, 160]
size: [140, 60]
- ref: bus
pos: [470, 160]
size: [140, 60]
- ref: router
pos: [690, 160]
size: [150, 60]
- ref: dlq
pos: [690, 320]
size: [150, 60]
- ref: store
pos: [920, 60]
size: [140, 60]
- ref: notifier
pos: [920, 160]
size: [140, 60]
- ref: analytics
pos: [920, 260]
size: [140, 60]
boundaries:
- kind: region
label: Integration platform
wraps: [ingest, bus, router, dlq, store, notifier, analytics]
connections:
- { from: crm, to: ingest, label: HTTPS, variant: emphasis }
- { from: erp, to: ingest, label: HTTPS, variant: emphasis }
- { from: ingest, to: bus, label: publish }
- { from: bus, to: router, label: consume }
- { from: router, to: store, label: append }
- { from: router, to: notifier, label: notify }
- { from: router, to: analytics, label: flatten }
- { from: router, to: dlq, label: failed, variant: dashed, labelDy: 24, decisions: [dead-letter-queue] }
@@ -0,0 +1,46 @@
schema_version: 1
diagram_type: architecture
meta:
title: Event router components
output: router.html
components:
- ref: bus
pos: [40, 160]
size: [140, 60]
- id: validate
type: security
label: Validate
sublabel: schema check
pos: [270, 160]
size: [130, 60]
- id: enrich
type: backend
label: Enrich
sublabel: reference data
pos: [480, 160]
size: [130, 60]
- id: dispatch
type: backend
label: Dispatch
pos: [690, 160]
size: [130, 60]
- ref: store
pos: [920, 60]
size: [140, 60]
- ref: notifier
pos: [920, 160]
size: [140, 60]
- ref: dlq
pos: [270, 320]
size: [150, 60]
boundaries:
- kind: region
label: Event router
wraps: [validate, enrich, dispatch]
connections:
- { from: bus, to: validate, label: event }
- { from: validate, to: enrich, label: valid }
- { from: enrich, to: dispatch, label: enriched }
- { from: dispatch, to: store, label: append }
- { from: dispatch, to: notifier, label: notify }
- { from: validate, to: dlq, label: invalid, variant: dashed, labelDy: 24 }
@@ -0,0 +1,18 @@
schema_version: 1
decision:
id: dead-letter-queue
title: Failed events go to a dead-letter queue, never dropped
status: accepted
date: 2026-09-24
elements: [router, dlq, ops]
diagrams: [0200-containers/platform.archify, 0300-components/router.archify]
context: >
Events that failed schema validation were logged and lost.
Nobody noticed until a customer asked where an order went.
decision: >
The router moves every event it cannot process to a
dead-letter queue with the reason. Operations replays
them after the cause is fixed.
consequences: >
Nothing is lost silently. Someone has to watch the queue;
that is an on-call duty for operations.
@@ -0,0 +1,29 @@
schema_version: 1
model:
id: event-based-integration
name: Event-Based Integration
description: >
Systems that never call each other directly; events go through a bus,
a router validates and enriches them, consumers react. Context,
containers, the router's components and one flow, C4 style.
diagram_type: architecture
meta:
title: Event-Based Integration — overview
output: main.html
components:
- ref: crm
pos: [40, 60]
size: [130, 60]
- ref: erp
pos: [40, 260]
size: [130, 60]
- ref: platform
pos: [280, 160]
size: [170, 60]
- ref: warehouse
pos: [540, 160]
size: [150, 60]
connections:
- { from: crm, to: platform, label: customer events, variant: emphasis }
- { from: erp, to: platform, label: order events, variant: emphasis }
- { from: platform, to: warehouse, label: pick lists }
@@ -0,0 +1,40 @@
schema_version: 1
elements:
ingest:
type: backend
label: Ingest API
sublabel: HTTPS in, events out
description: Accepts events from systems that cannot publish to the bus themselves.
bus:
type: messagebus
label: Event bus
sublabel: Kafka
brand: apache-kafka
description: One topic per event type; retained for seven days.
router:
type: backend
label: Event router
sublabel: validate, enrich, dispatch
description: Checks each event against its schema, adds reference data, hands it to the consumers.
diagram: 0300-components/router.archify
dlq:
type: messagebus
label: Dead-letter queue
sublabel: failed events
description: Events the router could not process; replayed by operations.
store:
type: database
label: Event store
sublabel: PostgreSQL
brand: postgresql
description: Every accepted event, for audit and replay.
notifier:
type: backend
label: Notifier
sublabel: email, chat
description: Turns selected events into messages to people.
analytics:
type: database
label: Analytics
sublabel: warehouse tables
description: Flattened events for reporting.
@@ -0,0 +1,7 @@
schema_version: 1
elements:
ops:
type: external
label: Operations
sublabel: on-call
description: Watches the dead-letter queue and replays failed events.
@@ -0,0 +1,23 @@
schema_version: 1
elements:
platform:
type: cloud
label: Integration platform
sublabel: the system
description: Receives events from the business systems, routes them, keeps a record.
diagram: 0200-containers/platform.archify
crm:
type: external
label: CRM
sublabel: customers
description: Source of customer events; created, updated, merged.
erp:
type: external
label: ERP
sublabel: orders and stock
description: Source of order events and the target of stock updates.
warehouse:
type: external
label: Warehouse system
sublabel: fulfilment
description: Receives pick lists; reports shipments back as events.
@@ -0,0 +1,26 @@
schema_version: 1
diagram_type: architecture
meta:
title: System context
output: context.html
components:
- ref: user
pos: [40, 60]
size: [130, 60]
- ref: admin
pos: [40, 260]
size: [130, 60]
- ref: webapp
pos: [280, 160]
size: [160, 60]
- ref: idp
pos: [530, 60]
size: [150, 60]
- ref: email
pos: [530, 260]
size: [150, 60]
connections:
- { from: user, to: webapp, label: uses, variant: emphasis }
- { from: admin, to: webapp, label: administers }
- { from: webapp, to: idp, label: signs in via, variant: security }
- { from: webapp, to: email, label: sends mail }
@@ -0,0 +1,38 @@
schema_version: 1
diagram_type: architecture
meta:
title: Containers
output: containers.html
components:
- ref: user
pos: [40, 160]
size: [130, 60]
- ref: spa
pos: [250, 160]
size: [150, 60]
- ref: api
pos: [480, 160]
size: [130, 60]
- ref: idp
pos: [480, 20]
size: [130, 60]
- ref: cache
pos: [690, 60]
size: [130, 60]
- ref: db
pos: [690, 160]
size: [130, 60]
- ref: storage
pos: [690, 260]
size: [130, 60]
boundaries:
- kind: region
label: Web Application
wraps: [spa, api, cache, db, storage]
connections:
- { from: user, to: spa, label: HTTPS, variant: emphasis }
- { from: spa, to: api, label: JSON }
- { from: api, to: idp, label: verify token, variant: security, labelAt: [531, 110], decisions: [external-identity-provider] }
- { from: api, to: cache, label: read }
- { from: api, to: db, label: SQL }
- { from: api, to: storage, label: files }
@@ -0,0 +1,42 @@
schema_version: 1
diagram_type: architecture
meta:
title: API components
output: api.html
components:
- ref: spa
pos: [40, 160]
size: [150, 60]
- id: auth
type: security
label: Auth
sublabel: token check
pos: [270, 40]
size: [130, 60]
- id: accounts
type: backend
label: Accounts
pos: [270, 160]
size: [130, 60]
- id: content
type: backend
label: Content
pos: [270, 280]
size: [130, 60]
- ref: db
pos: [500, 160]
size: [130, 60]
- ref: storage
pos: [500, 280]
size: [130, 60]
boundaries:
- kind: region
label: API
wraps: [auth, accounts, content]
connections:
- { from: spa, to: auth, label: token, variant: security }
- { from: spa, to: accounts, label: profile }
- { from: spa, to: content, label: pages }
- { from: accounts, to: db, label: SQL }
- { from: content, to: db, label: SQL }
- { from: content, to: storage, label: files }
@@ -0,0 +1,17 @@
schema_version: 1
decision:
id: external-identity-provider
title: Sign in through an identity provider, never store passwords
status: accepted
date: 2026-09-10
elements: [idp, api, spa]
diagrams: [0200-containers/web-app.archify]
context: >
The first version kept password hashes in the database and
had to handle resets, lockouts and two-factor codes itself.
decision: >
Users sign in through an OpenID Connect identity provider.
The single-page app gets a token; the API only verifies it.
consequences: >
No password tables, no reset flows. The identity provider
is a hard dependency: when it is down, nobody can sign in.
@@ -0,0 +1,29 @@
schema_version: 1
model:
id: standard-web-app
name: Standard Web App
description: >
A classic web application; a single-page app, an API, a database,
a cache and file storage, with sign-in through an identity provider.
Context, containers and the API's components, C4 style.
diagram_type: architecture
meta:
title: Standard Web App — overview
output: main.html
components:
- ref: user
pos: [40, 160]
size: [130, 60]
- ref: webapp
pos: [250, 160]
size: [160, 60]
- ref: idp
pos: [490, 60]
size: [150, 60]
- ref: email
pos: [490, 260]
size: [150, 60]
connections:
- { from: user, to: webapp, label: uses, variant: emphasis }
- { from: webapp, to: idp, label: signs in via, variant: security }
- { from: webapp, to: email, label: sends mail }
@@ -0,0 +1,32 @@
schema_version: 1
elements:
spa:
type: frontend
label: Single-page app
sublabel: React
brand: react
description: The user interface; talks only to the API.
api:
type: backend
label: API
sublabel: Node.js
brand: node-js
description: Owns accounts, content and files; checks tokens from the identity provider.
diagram: 0300-components/api.archify
db:
type: database
label: Database
sublabel: PostgreSQL
brand: postgresql
description: Accounts and content; the source of truth.
cache:
type: database
label: Cache
sublabel: Redis
brand: redis
description: Sessions and hot content; safe to lose.
storage:
type: cloud
label: Object storage
sublabel: uploaded files
description: User uploads and generated exports.
@@ -0,0 +1,12 @@
schema_version: 1
elements:
user:
type: external
label: User
sublabel: browser
description: Anyone with an account; uses the application from a browser.
admin:
type: external
label: Administrator
sublabel: back office
description: Manages users and content from the same application with extra rights.
@@ -0,0 +1,18 @@
schema_version: 1
elements:
webapp:
type: cloud
label: Web Application
sublabel: the system
description: Everything we build and run; the single-page app, the API and its stores.
diagram: 0200-containers/web-app.archify
idp:
type: external
label: Identity provider
sublabel: OpenID Connect
description: Signs users in and issues tokens; we never store passwords.
email:
type: external
label: Email service
sublabel: transactional mail
description: Sends sign-up confirmations and notifications.
+18
View File
@@ -0,0 +1,18 @@
# Shared elements of the model: one name for one thing. A diagram refers to
# an element with `ref: <id>` and adds only its position and size.
schema_version: 1
elements:
api:
type: backend
label: API
sublabel: REST service
description: >
What this thing is and does, in one place. Shown on hover and on the
model page wherever the element is used.
# diagram: 0300-components/api.archify # the diagram that explains it
db:
type: database
label: Database
sublabel: PostgreSQL
brand: postgresql
description: The source of truth.
+95
View File
@@ -0,0 +1,95 @@
import assert from 'node:assert/strict';
import fs from 'node:fs';
import path from 'node:path';
import { test } from 'node:test';
import { parse } from 'yaml';
import { effectiveStatus, mergeDecisions, parseDecision, slugify, sortDecisions, validateDecisions } from '../src/model/decisions';
import { mergeRegistries, parseRegistry, resolveRefs, summarizeDiagram } from '../src/model/format';
const model = path.resolve(__dirname, '..', '..', 'test', 'fixtures', 'model');
const read = (rel: string) => fs.readFileSync(path.join(model, rel), 'utf8');
const DECISION_FILES = ['decisions/0001-postgres-as-source-of-truth.archify-decision', 'decisions/0002-queue-between-api-and-worker.archify-decision', 'decisions/0003-opensearch-for-product-search.archify-decision'];
function registryOfModel() {
const files = ['registry/people.archify-registry', 'registry/systems.archify-registry', 'registry/containers.archify-registry'];
return mergeRegistries(files.map((file) => ({ file, ...parseRegistry(read(file), file) })));
}
function decisionsOfModel() {
return mergeDecisions(DECISION_FILES.map((file) => ({ file, ...parseDecision(read(file), file) })));
}
test('decision files parse with lines for every linked id', () => {
const { decision, problems } = parseDecision(read(DECISION_FILES[1]), 'd2');
assert.deepEqual(problems, []);
assert.ok(decision);
assert.equal(decision.id, 'queue-between-api-and-worker');
assert.equal(decision.title, 'A queue between the API and the worker');
assert.equal(decision.status, 'accepted');
assert.deepEqual(decision.elements, ['api', 'queue', 'worker']);
assert.deepEqual(decision.diagrams, ['0200-containers/online-shop.archify']);
assert.equal(decision.lines.elements.length, 3);
assert.ok(decision.context && decision.decision && decision.consequences);
});
test('decision files: broken YAML, missing block, unknown status', () => {
assert.equal(parseDecision('decision: {\n', 'x').problems[0].severity, 'error');
assert.match(parseDecision('context: only text\n', 'x').problems[0].message, /"decision" block/);
const bad = parseDecision('decision:\n id: a\n title: A\n status: maybe\n elements: api\n', 'x');
assert.deepEqual(bad.problems.map((p) => p.message.split(';')[0]), ['Unknown status "maybe"', '"elements" must be a list.']);
assert.equal(bad.problems[0].line, 3);
});
test('decisions merge, validate links, and the superseded rule applies', () => {
const set = decisionsOfModel();
assert.deepEqual(set.problems, []);
assert.equal(set.decisions.size, 3);
const registry = registryOfModel();
const diagrams = new Set(['0100-context/online-shop.archify', '0200-containers/online-shop.archify', '0300-components/api.archify']);
assert.deepEqual(validateDecisions(set, registry, diagrams), []);
// Duplicate id, unknown element, missing diagram, dangling supersedes.
const extra = parseDecision('decision:\n id: queue-between-api-and-worker\n title: Dup\n elements: [ghost]\n diagrams: [0900/x.archify]\n supersedes: [nope]\n', 'dup');
const merged = mergeDecisions([...DECISION_FILES.map((file) => ({ file, ...parseDecision(read(file), file) })), { file: 'dup', ...extra }]);
assert.match(merged.problems[0].message, /defined twice/);
const newer = parseDecision('decision:\n id: one-database\n title: Replace the first\n status: accepted\n supersedes: [postgres-as-source-of-truth]\n', 'd4');
const withNewer = mergeDecisions([...DECISION_FILES.map((file) => ({ file, ...parseDecision(read(file), file) })), { file: 'd4', ...newer }]);
const problems = validateDecisions(mergeDecisions([{ file: 'dup', ...extra }]), registry, diagrams);
assert.deepEqual(problems.map((p) => p.message.split(':')[0]), ['Unknown element "ghost"', 'Diagram "0900/x.archify" does not exist in this model.', 'Decision "nope" (in supersedes) does not exist in this model.']);
assert.deepEqual(effectiveStatus(withNewer.decisions.get('postgres-as-source-of-truth')!, withNewer.decisions), { status: 'superseded', supersededBy: 'one-database' });
assert.deepEqual(effectiveStatus(withNewer.decisions.get('queue-between-api-and-worker')!, withNewer.decisions), { status: 'accepted' });
const order = sortDecisions([...withNewer.decisions.values()], withNewer.decisions).map((d) => d.id);
assert.equal(order[order.length - 1], 'postgres-as-source-of-truth', 'superseded sorts last');
assert.equal(slugify('OpenSearch for product search!'), 'opensearch-for-product-search');
// Numeric ids are a YAML trap and are refused on both sides.
assert.match(parseDecision('decision:\n id: 0001\n title: N\n', 'n').problems[0].message, /is a number to YAML/);
assert.match(parseDecision('decision:\n id: ok\n title: N\n supersedes: [0001]\n', 'n').problems[0].message, /is a number to YAML/);
});
test('diagrams: decisions keys are stripped, collected and checked', () => {
const registry = registryOfModel();
const known = new Set(decisionsOfModel().decisions.keys());
const doc = parse(read('0200-containers/online-shop.archify'));
const r = resolveRefs(doc, { registry, decisions: known, fileName: 'c.archify' });
assert.deepEqual(r.problems, []);
assert.ok(!('decisions' in r.diagram));
const components = r.diagram.components as Record<string, unknown>[];
const connections = r.diagram.connections as Record<string, unknown>[];
assert.ok(components.every((c) => !('decisions' in c)) && connections.every((c) => !('decisions' in c)));
assert.deepEqual(r.decisionRefs.map((d) => [d.id, d.attachedTo.kind, d.pointer]), [
['postgres-as-source-of-truth', 'diagram', '/decisions/0'],
['queue-between-api-and-worker', 'node', '/components/5/decisions/0'],
['queue-between-api-and-worker', 'edge', '/connections/4/decisions/0'],
]);
const numeric = resolveRefs({ decisions: [1], components: [] }, { registry, decisions: known, fileName: 'x.archify' });
assert.match(numeric.problems[0].message, /is a number to YAML/);
const unknown = resolveRefs({ components: [{ id: 'a', type: 'backend', label: 'A', pos: [0, 0], decisions: ['nope'] }] }, { registry, decisions: known, fileName: 'x.archify' });
assert.equal(unknown.problems[0].pointer, '/components/0/decisions/0');
assert.match(unknown.problems[0].message, /Unknown decision "nope"/);
const outside = resolveRefs({ decisions: ['postgres-as-source-of-truth'], components: [] }, { fileName: '/w/loose.archify' });
assert.match(outside.problems[0].message, /not inside a model/);
// Other kinds: nodes and edges carry the key too.
const workflow = resolveRefs({ nodes: [{ id: 'n', type: 'process', label: 'N', decisions: ['postgres-as-source-of-truth'] }], edges: [{ from: 'n', to: 'n', decisions: ['queue-between-api-and-worker'] }] }, { registry, decisions: known, fileName: 'w.archify' });
assert.deepEqual(workflow.decisionRefs.map((d) => d.attachedTo.kind), ['node', 'edge']);
assert.ok(!('decisions' in (workflow.diagram.nodes as Record<string, unknown>[])[0]));
const summary = summarizeDiagram(read('0200-containers/online-shop.archify'), '0200-containers/online-shop.archify');
assert.deepEqual(summary.decisions.map((d) => d.id), ['postgres-as-source-of-truth', 'queue-between-api-and-worker', 'queue-between-api-and-worker']);
});
+53
View File
@@ -0,0 +1,53 @@
import assert from 'node:assert/strict';
import path from 'node:path';
import { test } from 'node:test';
import { EditorSchemas, bundleSchema } from '../src/language/editorSchemas';
import { readSchemas } from '../src/language/schemaCheck';
const schemas = readSchemas(path.resolve(__dirname, '..', '..', 'schemas'));
/** Every "$ref" in a bundled schema must point inside it. */
function resolveAll(schema: object): void {
const visit = (node: unknown): void => {
if (Array.isArray(node)) return node.forEach(visit);
if (!node || typeof node !== 'object') return;
for (const [key, value] of Object.entries(node)) {
if (key === '$ref') {
assert.match(String(value), /^#/, `local ref: ${value}`);
let target: unknown = schema;
for (const part of String(value).slice(1).split('/').filter(Boolean)) {
target = (target as Record<string, unknown>)[part.replace(/~1/g, '/').replace(/~0/g, '~')];
assert.ok(target !== undefined, `${value} resolves`);
}
} else visit(value);
}
};
visit(schema);
}
test('each schema bundles into one self-contained document', () => {
for (const name of Object.keys(schemas)) {
const bundled = bundleSchema(schemas, name);
resolveAll(bundled);
const text = JSON.stringify(bundled);
assert.ok(!text.includes('"prefixItems"'), `${name}: no prefixItems`);
assert.ok(!text.includes('"$schema"'), `${name}: no $schema`);
}
});
test('points become draft-07 tuples', () => {
const architecture = bundleSchema(schemas, 'architecture.schema.json') as { $defs: Record<string, { $defs: Record<string, unknown> }> };
const point = architecture.$defs['file:common.schema.json'].$defs.point as Record<string, unknown>;
assert.deepEqual(point.items, [{ type: 'number' }, { type: 'number' }]);
assert.equal(point.additionalItems, false);
});
test('a diagram gets the schema of its diagram_type, a decision none', () => {
const editor = new EditorSchemas(schemas);
assert.equal(editor.forSource('diagram', 'schema_version: 1\ndiagram_type: sequence\n')?.key, 'sequence.schema.json');
assert.equal(editor.forSource('diagram', 'diagram_type: "workflow"\n')?.key, 'workflow.schema.json');
assert.equal(editor.forSource('diagram', 'meta:\n title: x\n')?.key, 'archify.schema.json');
assert.equal(editor.forSource('diagram', 'diagram_type: poster\n')?.key, 'archify.schema.json');
assert.equal(editor.forSource('registry', '')?.key, 'archify-registry.schema.json');
assert.equal(editor.forSource('decision', ''), undefined);
});
+103
View File
@@ -0,0 +1,103 @@
import assert from 'node:assert/strict';
import fs from 'node:fs';
import os from 'node:os';
import path from 'node:path';
import { test } from 'node:test';
import { parse } from 'yaml';
import { validate } from '../src/archify/cli';
import { MODEL_EXAMPLES, mainFromExample } from '../src/language/examples';
import { MAIN_FILE, REGISTRY_EXT, hasDiagramBody, mergeRegistries, parseRegistry, readModelMeta, resolveRefs } from '../src/model/format';
import { DECISION_EXT, mergeDecisions, parseDecision, validateDecisions } from '../src/model/decisions';
import { readDiagramSource } from '../src/sources/detect';
const root = path.resolve(__dirname, '..', '..');
const examples = path.join(root, 'templates', 'models');
const runtime = {
cliPath: path.join(root, 'vendor', 'archify', 'bin', 'archify.mjs'),
nodePath: process.execPath,
runAsNode: false,
workDir: fs.mkdtempSync(path.join(os.tmpdir(), 'archify-ext-examples-')),
};
function walk(dir: string, rel = ''): string[] {
return fs.readdirSync(path.join(dir, rel), { withFileTypes: true }).flatMap((entry) => {
const next = rel ? `${rel}/${entry.name}` : entry.name;
return entry.isDirectory() ? walk(dir, next) : [next];
});
}
test('every example folder is listed, every listed example exists, labels are the three C4 examples', () => {
const folders = fs.readdirSync(examples, { withFileTypes: true }).filter((e) => e.isDirectory()).map((e) => e.name).sort();
assert.deepEqual(MODEL_EXAMPLES.map((e) => e.folder).sort(), folders);
assert.deepEqual(
MODEL_EXAMPLES.map((e) => e.label),
['C4 - Standard Web App', 'C4 - E-Shop', 'C4 - Event-Based Integration'],
);
});
for (const example of MODEL_EXAMPLES) {
test(`example ${example.folder} is a complete model that validates`, async () => {
const dir = path.join(examples, example.folder);
const files = walk(dir);
const read = (rel: string) => fs.readFileSync(path.join(dir, rel), 'utf8');
// main.archify: model block with id/name/description and an overview diagram.
assert.ok(files.includes(MAIN_FILE));
const main = parse(read(MAIN_FILE));
const meta = readModelMeta(main);
assert.equal(meta?.id, example.folder.replace(/^c4-/, ''));
assert.ok(meta?.name && meta.description);
assert.ok(hasDiagramBody(main));
// Registry: at least people, systems and containers; no problems.
const registryFiles = files.filter((f) => f.endsWith(REGISTRY_EXT)).sort();
assert.ok(registryFiles.length >= 3, `registry files: ${registryFiles.join(', ')}`);
const registry = mergeRegistries(registryFiles.map((file) => ({ file, ...parseRegistry(read(file), file) })));
assert.deepEqual(registry.problems, []);
for (const element of registry.elements.values()) {
assert.ok(element.type && element.label && element.description, `${element.id} needs type, label and description`);
if (element.diagram) assert.ok(files.includes(element.diagram), `${element.id} links to missing ${element.diagram}`);
}
// Decisions: at least one, all links resolve.
const decisionFiles = files.filter((f) => f.endsWith(DECISION_EXT));
assert.ok(decisionFiles.length >= 1, 'an example carries at least one decision');
const decisions = mergeDecisions(decisionFiles.map((file) => ({ file, ...parseDecision(read(file), file) })));
assert.deepEqual(decisions.problems, []);
const diagramPaths = new Set(files.filter((f) => f.endsWith('.archify') && f !== MAIN_FILE));
assert.deepEqual(validateDecisions(decisions, registry, diagramPaths), []);
for (const d of decisions.decisions.values()) assert.ok(d.title && d.status && d.context && d.decision && d.consequences, `${d.id} is complete`);
// Diagrams: the three C4 levels, each resolving without problems and valid for Archify.
const diagrams = files.filter((f) => f.endsWith('.archify')).sort();
for (const level of ['0100-context', '0200-containers', '0300-components']) {
assert.ok(diagrams.some((d) => d.startsWith(`${level}/`)), `missing ${level}`);
}
const used = new Set<string>();
for (const file of diagrams) {
const source = readDiagramSource(read(file), file);
assert.ok(source, `${file} is not a diagram`);
const resolved = resolveRefs(source.diagram, { registry, decisions: new Set(decisions.decisions.keys()), fileName: file });
assert.deepEqual(resolved.problems, [], file);
for (const link of resolved.links.values()) assert.ok(files.includes(link), `${file} links to missing ${link}`);
for (const id of resolved.used) used.add(id);
const result = await validate(runtime, source.type, JSON.stringify(resolved.diagram));
assert.deepEqual(result.diagnostics.filter((d) => d.severity === 'error').map((d) => `${file}: ${d.code}: ${d.message}`), []);
assert.ok(result.ok, file);
}
// Every registry element is used by some diagram.
for (const id of registry.elements.keys()) assert.ok(used.has(id), `element ${id} is never used`);
});
}
test('mainFromExample keeps the example as written, or renames it after the folder', () => {
const example = MODEL_EXAMPLES[1];
const text = fs.readFileSync(path.join(examples, example.folder, MAIN_FILE), 'utf8');
assert.equal(mainFromExample(text, example.folder, example), text);
const renamed = parse(mainFromExample(text, 'shop two', example));
assert.equal(renamed.model.id, 'shop-two');
assert.equal(renamed.model.name, 'Shop two');
assert.equal(renamed.meta.title, 'Shop two — overview');
assert.equal(renamed.model.description, parse(text).model.description);
assert.deepEqual(renamed.components, parse(text).components);
});
+26
View File
@@ -0,0 +1,26 @@
schema_version: 1
diagram_type: architecture
meta:
title: System context
output: context.html
components:
- ref: customer
pos: [40, 60]
size: [130, 60]
- ref: support
pos: [40, 260]
size: [130, 60]
- ref: shop
pos: [280, 160]
size: [150, 60]
- ref: psp
pos: [520, 60]
size: [150, 60]
- ref: email
pos: [520, 260]
size: [150, 60]
connections:
- { from: customer, to: shop, label: buys, variant: emphasis }
- { from: support, to: shop, label: manages orders }
- { from: shop, to: psp, label: charges, variant: security }
- { from: shop, to: email, label: sends mail }
+41
View File
@@ -0,0 +1,41 @@
schema_version: 1
diagram_type: architecture
meta:
title: Containers
output: containers.html
decisions: [postgres-as-source-of-truth]
components:
- ref: customer
pos: [40, 160]
size: [130, 60]
- ref: web
pos: [250, 160]
size: [130, 60]
- ref: api
pos: [460, 160]
size: [130, 60]
- ref: cache
pos: [670, 60]
size: [130, 60]
- ref: db
pos: [670, 260]
size: [130, 60]
- ref: queue
pos: [460, 360]
size: [130, 60]
decisions: [queue-between-api-and-worker]
- ref: worker
pos: [670, 460]
size: [130, 60]
boundaries:
- kind: region
label: Online Shop
wraps: [web, api, cache, db, queue, worker]
connections:
- { from: customer, to: web, label: HTTPS, variant: emphasis }
- { from: web, to: api, label: JSON }
- { from: api, to: cache, label: read }
- { from: api, to: db, label: SQL }
- { from: api, to: queue, label: enqueue, labelAt: [560, 290], decisions: [queue-between-api-and-worker] }
- { from: queue, to: worker, label: poll }
- { from: worker, to: db, label: SQL, labelAt: [735, 420] }
+42
View File
@@ -0,0 +1,42 @@
schema_version: 1
diagram_type: architecture
meta:
title: API components
output: api.html
components:
- ref: web
pos: [40, 160]
size: [130, 60]
- id: auth
type: security
label: Auth
sublabel: sessions, OIDC
pos: [250, 60]
size: [130, 60]
- id: orders
type: backend
label: Orders
pos: [250, 160]
size: [130, 60]
- id: catalogue
type: backend
label: Catalogue
pos: [250, 260]
size: [130, 60]
- ref: db
pos: [460, 160]
size: [130, 60]
- ref: queue
pos: [460, 310]
size: [130, 60]
boundaries:
- kind: region
label: API
wraps: [auth, orders, catalogue]
connections:
- { from: web, to: auth, label: sign in, variant: security }
- { from: web, to: orders, label: place order }
- { from: web, to: catalogue, label: browse }
- { from: orders, to: db, label: SQL }
- { from: catalogue, to: db, label: SQL }
- { from: orders, to: queue, label: enqueue }
@@ -0,0 +1,20 @@
schema_version: 1
decision:
id: postgres-as-source-of-truth
title: PostgreSQL as the single source of truth
status: accepted
date: 2026-09-02
elements: [db, api, worker]
diagrams: [0200-containers/online-shop.archify]
context: >
Orders, customers and the catalogue were spread over the
shop database and two spreadsheets kept by support.
Refunds were reconciled by hand every Monday.
decision: >
One PostgreSQL database owns orders, customers and the
catalogue. The API is the only writer. Everything else
(cache, search, reports) is derived and may be rebuilt.
consequences: >
Support loses the spreadsheets and gets the admin console.
Any new store must be declared derived or get its own
decision. Backups and migrations are the API team's job.
Loaded 100 of 115 files, more files were not shown because too many files have changed in this diff. Show more