root-at-skicandClaude Opus 5.5
ed830ec349
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
99 lines
5.5 KiB
Markdown
99 lines
5.5 KiB
Markdown
# Archify Diagram Viewer
|
|
|
|
View [Archify](https://github.com/tt-a1i/archify) diagrams inside VS Code. Write a diagram in a `.archify` file and see the interactive diagram next to it, updated as you type. Open rendered Archify HTML files in a viewer tab instead of a browser.
|
|
|
|
|
|
|
|
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.
|
|
|
|
## Quick start
|
|
|
|
1. Create a file ending in `.archify`, for example `hello.archify`:
|
|
|
|
```json
|
|
{
|
|
"schema_version": 1,
|
|
"diagram_type": "architecture",
|
|
"meta": { "title": "Hello Archify", "output": "hello.html" },
|
|
"components": [
|
|
{ "id": "browser", "type": "frontend", "label": "Browser", "pos": [40, 120], "size": [140, 60] },
|
|
{ "id": "api", "type": "backend", "label": "API", "pos": [260, 120], "size": [140, 60] },
|
|
{ "id": "db", "type": "database", "label": "PostgreSQL", "pos": [480, 120], "size": [140, 60] }
|
|
],
|
|
"connections": [
|
|
{ "from": "browser", "to": "api", "label": "HTTPS" },
|
|
{ "from": "api", "to": "db", "label": "SQL" }
|
|
]
|
|
}
|
|
```
|
|
|
|
2. Click the preview button in the editor title, or press <kbd>Cmd/Ctrl+K V</kbd>.
|
|
|
|
The same file is in [examples/hello.archify](examples/hello.archify).
|
|
|
|
## The `.archify` format
|
|
|
|
A `.archify` file is an Archify JSON diagram source, the same JSON the Archify CLI renders. `diagram_type` selects the kind of diagram: `architecture`, `workflow`, `sequence`, `dataflow` or `lifecycle`. VS Code treats `.archify` as JSON, so you get syntax highlighting, formatting, and completion and hover from the schema for that `diagram_type`.
|
|
|
|
Archify's own naming, `name.architecture.json`, `name.workflow.json` and so on, works too.
|
|
|
|
## Features
|
|
|
|
- **Live preview**: for `.archify` files, Archify's `*.architecture.json`-style files, or any JSON with a `diagram_type`. Use the preview button in the editor title, <kbd>Cmd/Ctrl+K V</kbd> (to the side) or <kbd>Cmd/Ctrl+Shift+V</kbd>. The preview keeps the focus and route you selected (`#focus=…`, `#route=…`) when it re-renders.
|
|
- **HTML viewer**: right-click a rendered `.html` file and choose **Open in Archify Viewer**, or use *Reopen Editor With… → Archify Diagram 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**: `archify validate` runs on the source and reports schema, layout and evidence problems at the matching JSON location.
|
|
- **Schema help**: completion and hover documentation come from Archify's own JSON schemas. In `.archify` files, the schema follows `diagram_type`.
|
|
- **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.
|
|
- **Commands**: *Archify: Render to HTML File…*, *Archify: Open in Browser*, *Archify: Refresh Preview*, *Archify: Show Source*.
|
|
|
|
## 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.
|
|
|
|
When verification fails, the default (`archify.sourceEvidence: "fallback"`) still shows the diagram without source links, explains why in a notice, and reports the reason as a warning. Set it to `"strict"` to treat this as an error, as the Archify CLI does. *Render to HTML File…* always verifies strictly and asks before rendering without source links.
|
|
|
|
## Settings
|
|
|
|
| Setting | Default | Description |
|
|
|---|---|---|
|
|
| `archify.theme` | `vscode` | `vscode` follows the color theme; `dark` or `light` force one; `diagram` keeps the diagram's own choice. |
|
|
| `archify.preview.liveUpdate` | `true` | Re-render while typing; when off, re-render on save. |
|
|
| `archify.preview.debounceMs` | `400` | Delay before re-rendering after an edit. |
|
|
| `archify.validation.enabled` | `true` | Report validation results in Problems. |
|
|
| `archify.quality` | `""` | Force the `standard` or `showcase` quality profile. |
|
|
| `archify.sourceEvidence` | `fallback` | `fallback` or `strict` handling of unverifiable source evidence. |
|
|
| `archify.repoRoot` | `""` | Checkout used to verify source evidence. |
|
|
| `archify.nodePath` | `""` | Node.js 18+ executable to use instead of VS Code's runtime. |
|
|
|
|
## Security
|
|
|
|
Diagrams run in a webview with a strict content security policy. Only the page's own inline scripts run (via a per-render nonce), there is no network access for scripts or fetches, and links open through VS Code.
|
|
|
|
## Development
|
|
|
|
```bash
|
|
npm install
|
|
npm run build # bundle to dist/
|
|
npm test # unit tests + renderer tests (Node)
|
|
npm run test:integration # runs the suite inside VS Code
|
|
npm run package # build archify-vscode-ext-<version>.vsix
|
|
```
|
|
|
|
Press <kbd>F5</kbd> to launch an Extension Development Host with the test fixtures.
|
|
|
|
### Updating the bundled renderer
|
|
|
|
`vendor/archify/` and `schemas/` are generated from an Archify checkout:
|
|
|
|
```bash
|
|
node scripts/sync-archify.mjs /path/to/archify # default: ../../ws-storm/archify
|
|
npm test
|
|
```
|
|
|
|
`vendor/archify.json` records the upstream version and commit.
|
|
|
|
## 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`.
|