custom_edit_url: https://git.skbkontur.ru/forms/candy/-/edit/master/VSCodeExtension/README.md

Расширение Visual Studio Code для работы с Candy.Sugar

Расширение для Visual Studio Code, которое добавляет поддержку синтаксиса sugar.xml. Включает поддержку основных инструментов навигации и валидации кода на языке sugar.xml.

Установка

Можно установить через поиск 'vscode-candy-sugar-extension' в панели плагинов в Visual Studio Code.

Visual Studio Code Market Place: Candy.Sugar - IntelliSense for sugar.xml

Также можно использовать консоль vscode:

ext install vscode-candy-sugar-extension

Список функциональности

• подсказки полей и значений, описания настроек и валидация Candy/form.json

• валидация сахара

Также доступна консольная версия валидатора: @kontur.candy/sugar-validator

• форматирование сахара

• автозакрывание тэгов

• автокомплит элементов сахара: тэгов и атритутов

• автокомплит для определенных пользователем типов в сахаре

• автокомплит путей к данным по соответствующей схеме данных

• всплывающие подсказки для атрибутов

• всплывающие подсказки для путей к данным

• быстрый просмотр элементов схемы данных из сахара

• переход к определению схемы из сахара

• контекстный переход на справку

Подсказки для form.json

Откройте Candy/form.json и нажмите Ctrl+Space, чтобы увидеть доступные поля и значения. При наведении на поле показывается описание. Набор допустимых настроек зависит от mode: normal-build или no-editor. Поля со значениями по умолчанию можно не указывать.

Поддержка включается автоматически после установки расширения, в том числе при открытии самой папки Candy. Добавлять $schema или настройки проекта не требуется. Схема входит в расширение и работает без подключения к сети. IDE проверяет структуру, типы, допустимые значения и неизвестные поля. Точную проверку диапазонов версий SemVer в dependencies выполняют инструменты Candy.

Обновление схемы разработчиками

Структура и описания берутся из Common/FormConfig/FormConfigSchema.ts и Common/FormConfig/FormJsonSettingsSchema.ts. Для каждого поля задавайте метаданные через .meta() с обязательными title и description; остальные метаданные, например examples, добавляйте при необходимости. После установки зависимостей корневого проекта выполните npm run vscode-ext:build-form-schema из корня репозитория. Результат записывается в VSCodeExtension/dist/schemas/form.schema.json. Обычная сборка расширения и упаковка VSIX также запускают генерацию автоматически. Сгенерированный файл не нужно редактировать вручную.

Как помочь

• Использовать расширение и сообщать о багах, вносить предложения. Для этого нужно завести issue в YT и(или) обратиться к @candy_fe_duty в канале ke_forms.