VS Code Extension

C4 DSL Patterns Extension

C4 DSL Patterns Extension — это расширение для Visual Studio Code, которое упрощает работу с архитектурными шаблонами в Structurizr DSL. Расширение предоставляет удобные инструменты для разработки и валидации шаблонов с использованием новой сущности $pattern.

Возможности

• Проверка аргументов шаблонов (выделение лишних и недостающих параметров);
• Отображение встроенной документации паттернов (в формате Markdown);
• Автодополнение параметров шаблонов.

Установка

1. Скачайте VSIX-файл расширения из релизов;
2. Установите расширение в VS Code:
   Инструкция по установке VSIX;
3. Скачайте Pattern Lens из последнего релиза;
4. Укажите путь к JAR архиву Pattern Lens в настройках VS Code:

{
    "structurizrPatterns.patternLensPath": "path/to/pattern-lens.jar"
}

Note

Pattern Lens - это CLI-инструмент, который используется расширением для получения информации о доступных паттернах: параметры, описание и прочее. Без него функциональность VS Code расширения будет недоступна.

Функциональность в действии

Проверка лишних параметров

Расширение выделяет параметры, которые не описаны в паттерне:

Проверка недостающих параметров

Расширение показывает, какие обязательные параметры вы забыли указать:

Автодополнение параметров

Удобное автодополнение параметров шаблона прямо в $pattern блоке:

Документация шаблонов

Наведите курсор на $pattern или параметр - и сразу получите подсказку с документацией: