Editors (IDE)
VS Code extension
The EventCatalog DSL extension gives you a full editing experience for .ec files inside VS Code.
Features
| Feature | What it does |
|---|---|
| Syntax highlighting | Keywords, strings, annotations, and comments are color-coded |
| Autocompletion | Suggests resource types, properties, and imported names as you type |
| Live preview | Opens an interactive architecture diagram alongside your .ec file |
| Diagnostics | Underlines errors and warnings as you edit |
| Go to definition | Jump to where a resource is defined |
| Hover information | See resource details on hover |
Install
Install from the VS Code Marketplace, search for EventCatalog DSL in the VS Code extensions panel, or install from the command line:
code --install-extension eventcatalog.eventcatalog-dslLive preview
Open any .ec file and click the preview icon in the editor title bar (or run EventCatalog: Open Preview from the command palette). A side panel renders your architecture diagram in real time as you type.
File association
The extension automatically activates for any file with the .ec extension. No additional configuration is needed.