Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 74 additions & 0 deletions vscode-rivet/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Rivet SDLC — VS Code Extension

SDLC artifact traceability with live validation, hover info, and embedded dashboard.

## Features

### Real-time Validation

Red squiggly lines appear on broken links, missing required fields, and cardinality violations as you edit YAML artifact files. Powered by salsa incremental computation — only changed files are re-validated.

### Hover Info

Hover over any artifact ID (e.g., `REQ-001`) to see its title, type, description, status, and link count.

### Go-to-Definition

Ctrl+click (or Cmd+click on macOS) on an artifact ID to jump to its definition in the source YAML file.

### Completions

- Type `target:` in a link block → suggests all artifact IDs with title and type
- Type `type:` → suggests artifact types from the loaded schema

### Embedded Dashboard

Open the Rivet dashboard as a side panel inside VS Code:

- **Rivet: Show Dashboard** — full dashboard with filter/sort/pagination
- **Rivet: Show Graph** — traceability graph
- **Rivet: Show STPA** — STPA + STPA-Sec hierarchy

The dashboard auto-refreshes when you save a file (`rivet serve --watch`).

### Commands

| Command | Description |
|---------|-------------|
| `Rivet: Show Dashboard` | Open dashboard in a WebView panel |
| `Rivet: Show Graph` | Open traceability graph |
| `Rivet: Show STPA` | Open STPA analysis view |
| `Rivet: Validate` | Run `rivet validate` and show results |
| `Rivet: Add Artifact` | Create a new artifact with quick-pick UI |

## Requirements

- **Rivet CLI** installed: `cargo install rivet-cli` (or download from [releases](https://github.com/pulseengine/rivet/releases))
- A workspace with `rivet.yaml` in the root

## Extension Settings

| Setting | Default | Description |
|---------|---------|-------------|
| `rivet.binaryPath` | `""` (auto-detect) | Path to `rivet` binary |
| `rivet.serve.port` | `0` (auto-assign) | Port for the embedded dashboard |

## How It Works

1. **Activation**: When VS Code opens a folder with `rivet.yaml`, the extension activates
2. **LSP**: Starts `rivet lsp` via stdio for diagnostics, hover, goto-def, completions
3. **Dashboard**: Starts `rivet serve --watch` in the background on an auto-assigned port
4. **Live reload**: File saves trigger incremental re-validation (salsa) and dashboard refresh

## Development

```bash
cd vscode-rivet
npm install
npm run compile
# Press F5 in VS Code to launch Extension Development Host
```

## License

Apache-2.0
Binary file added vscode-rivet/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
27 changes: 27 additions & 0 deletions vscode-rivet/icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading