DomainForge VS Code Extension

Language support for the DomainForge SEA DSL - syntax highlighting, diagnostics, and formatting for .sea files.

Features

🎨 Syntax Highlighting - Full TextMate grammar for SEA DSL
🔍 Diagnostics - Real-time parse error detection
📐 Formatting - Format Document with configurable indent style
🔗 Go to Definition - Navigate to entity/resource declarations
💡 Hover Information - Rich tooltips for entities, resources, flows
✨ Code Completion - Context-aware suggestions
🌐 Web Support - Works in vscode.dev and github.dev

Requirements

VS Code 1.107.0 or later
For desktop: Native LSP binary (bundled)
For web: sea-core WASM module (bundled)

Extension Settings

Setting	Type	Default	Description
`domainforge.trace.server`	`off` \| `messages` \| `verbose`	`off`	Traces communication with language server
`domainforge.server.path`	`string`	`""`	Custom path to LSP binary (leave empty for bundled)
`domainforge.formatting.indentStyle`	`space` \| `tab`	`space`	Indent style for formatting
`domainforge.formatting.indentWidth`	`number`	`4`	Spaces per indent level (1-8)

MCP (Model Context Protocol) Settings

The MCP server enables AI agents (like VS Code Copilot, Claude, etc.) to query DomainForge language features in a controlled, secure manner.

Setting	Type	Default	Description
`domainforge.mcp.enable`	`boolean`	`false`	Enable MCP server for AI agent integration
`domainforge.mcp.serverPath`	`string`	`""`	Custom path to MCP binary (leave empty for bundled)
`domainforge.mcp.rateLimits.diagnostics`	`number`	`10`	Max requests/second for diagnostics tool
`domainforge.mcp.rateLimits.hover`	`number`	`20`	Max requests/second for hover tool
`domainforge.mcp.rateLimits.definition`	`number`	`10`	Max requests/second for definition tool
`domainforge.mcp.rateLimits.references`	`number`	`5`	Max requests/second for references tool
`domainforge.mcp.rateLimits.renamePreview`	`number`	`2`	Max requests/second for rename preview tool
`domainforge.mcp.rateLimits.codeActions`	`number`	`5`	Max requests/second for code actions tool
`domainforge.mcp.auditLog.path`	`string`	`""`	Path to MCP audit log file (empty = disabled)

Commands

Command	Description
`DomainForge: Restart Language Server`	Restart the LSP server
`DomainForge: Restart MCP Server`	Restart the MCP server (if enabled)
`DomainForge: Show MCP Server Logs`	Show MCP server output channel

Web Extension Support

This extension works in browser-based VS Code environments:

✅ vscode.dev - Full web support
✅ github.dev - Open any repo and edit .sea files
✅ GitHub Codespaces - Cloud development environments

Web Feature Availability

Feature	Desktop	Web
Syntax Highlighting	✅	✅
Diagnostics	✅ Full	✅ Parse errors
Formatting	✅	✅
Hover	✅	❌
Go to Definition	✅	❌
Code Completion	✅	❌
Code Actions	✅	❌

Note: Web version uses sea-core WASM for core functionality. Advanced features require the native LSP server.

Quick Start

Open a .sea file
Enjoy syntax highlighting and diagnostics
Use Format Document (Shift+Alt+F) to format
Hover over entities/resources for information
Ctrl+Click to go to definition

SEA DSL Syntax Reference

SEA (Structured Entity Architecture) models business domains using five universal primitives:

Primitive	Purpose	Example
Entity	Actors and locations	`Entity "Warehouse" in logistics`
Resource	Things of value that move	`Resource "Money" currency in finance`
Flow	Movement between entities	`Flow "Money" from "A" to "B" quantity 1`
Pattern	Reusable validation patterns	`Pattern "Email" matches "^.+@.+$"`
Policy	Business rules & constraints	`Policy min_qty as: quantity >= 10`

Basic Example

// Define entities (who/where)
Entity "Warehouse" in logistics
Entity "Factory" in manufacturing

// Define resources (what moves)
Resource "Camera" units in inventory

// Define flows (how things move)
Flow "Camera" from "Warehouse" to "Factory" quantity 100

// Define validation patterns
Pattern "SKU" matches "^[A-Z]{3}-[0-9]{4}$"

// Define business rules
Policy min_shipment as: quantity >= 10

Advanced Features

// Versioned entities with evolution tracking
Entity "Vendor" v2.0.0
  @replaces "Supplier" v1.0.0
  @changes ["renamed", "added_fields"]

// Roles and relations
Role "Approver" in governance

Relation "Payment"
  subject: "Buyer"
  predicate: "pays"
  object: "Seller"
  via: flow "Money"

// Typed instances
Instance acme_corp of "Vendor" {
  name: "Acme Corporation",
  credit_limit: 50000 "USD"
}

// Quantified policy expressions
Policy all_shipments_inspected as:
  forall s in flows: (s.inspected = true)

Supported Declarations

Declaration	Syntax
Entity	`Entity "Name" [vX.Y.Z] [in domain]`
Resource	`Resource "Name" [unit] [in domain]`
Flow	`Flow "Resource" from "A" to "B" [quantity N]`
Pattern	`Pattern "Name" matches "regex"`
Role	`Role "Name" [in domain]`
Relation	`Relation "Name" subject: ... predicate: ... object: ...`
Instance	`Instance id of "Entity" { field: value }`
Policy	`Policy name as: expression`
Dimension	`Dimension "Name"`
Unit	`Unit "Name" of "Dimension" factor N base "Base"`
Metric	`Metric "Name" as: expression`
Mapping	`Mapping "Name" for format { ... }`
Projection	`Projection "Name" for format { ... }`
ConceptChange	`ConceptChange "Name" @from_version ... @to_version ...`

Known Issues

Web version only provides parse-level diagnostics (no semantic validation)
Large files (>10,000 lines) may experience performance delays

Release Notes

See the DomainForge Changelog for detailed release history.

Development

# Install dependencies
pnpm install

# Build (desktop + web)
pnpm run compile

# Build web only
pnpm run compile-web

# Run tests
pnpm test

# Test in browser
pnpm run test-web

License

MIT

DomainForge

GodSpeed AI