Sruja Language Support
VS Code extension for the Sruja architecture DSL. Lint and Markdown export run in-process using bundled WebAssembly (no CLI required). You can optionally use the Sruja CLI by setting sruja.lsp.path.
Features
- Diagnostics – Lint runs in the extension via bundled WASM (or
sruja lint if sruja.lsp.path is set). Errors and warnings appear in the editor (Problems panel, underlines). Supports unsaved buffers. Debounced on type; pending lint is cancelled when the document is closed.
- Syntax highlighting – TextMate grammar for keywords, relations, strings, comments
- Language configuration – Comment toggling (
//), bracket matching and autoclosing, word pattern for double‑click selection, indentation rules for {/}, folding with // #region / // #endregion markers
- Snippets – Kind declarations (person, system, container, database), elements, relations (
->), views, description blocks
- Generate Markdown from DSL – Run Sruja: Export to Markdown (or right-click in a .sruja file): generates Markdown via bundled WASM (or CLI), opens it in the editor, and optionally saves to a
.md file next to the source.
- AI features (skills & rules) – Browse skills, open SKILL.md / AGENTS.md, list and open rules, copy rule or agent guide to clipboard for use with AI assistants (e.g. Cursor, Copilot). Multi‑root workspaces: skills are collected from every folder that has a
skills subfolder.
- Workspace support – Extension runs in the workspace (remote/SSH); supports untrusted workspaces.
Requirements
- None for lint and export when using the published extension (bundled WASM). Optionally set
sruja.lsp.path to use the Sruja CLI instead (e.g. for a specific binary or when developing the extension without running copy-assets).
Commands
| Command |
Description |
| Sruja: Run validation (check after AI/edit) |
Run sruja lint on the active .sruja file now (unsaved content is linted via temp file). Use after every AI code iteration to ensure the file is valid and per standards. |
| Sruja: Export to Markdown |
Export the active .sruja file to Markdown (opens in editor; optional save to .md) |
| Sruja: Open Skills Overview |
Open SKILL.md for a skill (quick-pick if multiple) |
| Sruja: Open Agent Guide (AGENTS.md) |
Open AGENTS.md for a skill |
| Sruja: List Rules… |
Quick-pick list of all rules; open selected rule |
| Sruja: Copy Rule for AI |
Copy a rule’s markdown to clipboard for pasting into an AI chat |
| Sruja: Copy Agent Guide for AI |
Copy AGENTS.md content to clipboard |
Views
- Sruja Skills (Explorer sidebar) – Tree of skills → SKILL.md, AGENTS.md, and rules. Click a file to open it. Skills are resolved from
sruja.skills.path, workspace skills folder, or the extension’s bundled skills (if present).
Settings
| Setting |
Default |
Description |
sruja.lsp.path |
(empty) |
Path to the Sruja CLI binary. If set, lint and export use the CLI instead of bundled WASM. |
sruja.skills.path |
(empty) |
Path to skills folder for AI rules. Empty = use workspace skills or extension skills. |
Publishing to Open VSX
The extension is published to the Open VSX Registry via GitHub Actions when a release is published (see .github/workflows/README.md). Uses org secret OPEN_VSX_TOKEN (Personal Access Token from open-vsx.org). On release, the extension version is taken from the release tag (e.g. v0.2.0 → 0.2.0).
Development
cd extension
npm install
npm run compile
Run from VS Code (F5). Ensure the Sruja CLI is on PATH or set sruja.lsp.path. For the Sruja Skills view, open this repo (or any workspace with a skills folder) or set sruja.skills.path.
How to check the extension is working
Build the Sruja CLI (required for lint and export):
cargo build --release -p sruja-cli
For lint and export: run npm run copy:assets from the extension directory (copies WASM into extension/wasm/), or set sruja.lsp.path to your Sruja CLI binary.
Launch the extension
Open this repo in VS Code, press F5 (or Run → Start Debugging). A new VS Code window opens with the extension loaded (“Extension Development Host” in the title).
In the Extension Development Host window:
| Check |
How |
| Syntax highlighting |
Open a .sruja file (e.g. examples/tutorial/01-basic-system.sruja). Keywords, strings, -> should be colored. |
| Diagnostics |
In a .sruja file, introduce an error (e.g. duplicate ID or invalid ref). After a short delay (or on save), Problems panel and red squiggles should show. |
| Run validation |
With a .sruja file active: Command Palette → “Sruja: Run validation”. Message should say “no issues” or “N error(s), M warning(s)”. |
| Export to Markdown |
With a .sruja file active: Command Palette → “Sruja: Export to Markdown” (or right‑click → same). A markdown preview tab opens; “Save” writes a .md next to the file. |
| Snippets |
In a .sruja file, type person or -> and accept the snippet suggestion. |
| Sruja Skills view |
In the Explorer sidebar, open “Sruja Skills”. This repo has skills/sruja-architecture; you should see SKILL.md, AGENTS.md, and rules. Click to open. |
| Commands |
Command Palette → “Sruja:” to see all commands (Open Skills Overview, List Rules, Copy Rule for AI, etc.). |
If something fails:
- Lint/Export not running: If using WASM, ensure
extension/wasm/ exists (run npm run copy:assets). If using CLI, confirm sruja.lsp.path or sruja on PATH.
- No diagnostics: Ensure the file has a
.sruja extension and the document language is “Sruja”.
- Debug output: Run → Start Debugging (F5) and check the “Debug Console” in the original window for errors.
| |
