Расширение Svacer (Static Analysis History Server) для Visual Studio Code

Расширение для Visual Studio Code, добавляющее поддержку результатов анализа Svace.

Использование

Установка

Расширение можно установить из официального магазина расширений для VSCode.

Для установки расширения из файла svacer-<version>.vsix воспользуйтесь командой Установка из VSIX... в выпадающем меню на странице расширений.

Так же можно установить с помощью параметра командной строки --install-extension, явно указав путь к файлу .vsix

code --install-extension <path-to-file>/svacer-<version>.vsix

Настройка

Установите необходимые значения для настроек сервера и проекта или оставьте значения по умолчанию.

Авторизация

Для авторизации на сервере Svacer необходимо осуществить вход в профиль на вкладке Учетные записи, где следует выбрать пункт Войдите с помощью SvacerAuth, чтобы использовать Svacer. В результате этого будет открыт браузер с адресом сервера, который был указан в настроках, где будет необходимо разрешить доступ расширения к данным профиля.

Загрузка исходного кода

Загрузите исходный код проекта, если он был импортирован на сервер.

В процессе загрузки будет отображаться строка с текущим прогрессом.

После завершения загрузки будет отображено информационное сообщение.

Загрузка данных

Загрузите данные с сервера при помощи команды или из вкладки Инструменты Svacer: Информация Svacer и начните работу.

После завершения загрузки данных будет отображено информационное сообщение.

Работа с маркерами

Работать с маркерами можно при помощи раздела Маркеры Svacer.

Так же доступ к Разметке Svacer можно получить через всплывающее окно, при наведении на предупреждение к редакторе кода.

В этом всплывающем окне можно так же блокировать/разблокировать предупреждения и добавлять, изменять и удалять комментарии к маркеру.

Инструменты Svacer

Расширение предоставляет пользователю владку, объединяющую все инструменты, которые позволяют получить функциональность Svacer в VSCode.

Информация Svacer

Если данные с сервера еще не были загружены, то в этом разделе отображается приветственное сообщение.

После загрузки данных в этом разделе отображается информация о выбранном проекте, ветке и снимке.

Так же в этом разделе можно выполнить следующие действия:

1. Перезагрузить данные с сервера*;
2. Очистить данные о предупреждениях*;
3. Открыть настройки расширения.

Маркеры Svacer**

В данном разделе отображаются все предупреждения для текущего выбранного файла.

При наведении на строку с предупреждением, будет появляться кнопка прехода к месту предупреждения в коде и кнопка для блокировки/разблокировки предупреждения.

Если развернуть файл, то будут отображены вкладки с трассой, пользовательской разметкой предупреждения и комметариями.

Трасса маркера

Данный раздел содержит трассу предупреждения, построенную при анализе кода. У каждого элемента отображается имя файла, номер строки и текст сообщения. При нажатии на элемент будет осуществляться переход к месту в коде.

Разметка маркера

Данный раздел позволяет осуществлять пользовательскую разметку для предупреждений. При нажатии на необходимую опцию будет открываться диалоговое окно с вариантами для выбранной опции.

Комментарии маркера

Данный раздел содержит комментарии для предупреждения.

При наведении на корневой элемент, будет отображаться кнопка для добавления комментария.

При наведении на строку с комментарием будет отображаться всплывающее сообщение с временем последнего редактирования комментария, а так же кнопки для удаления и редактирования комментария.

Файлы Svacer*

В данном разделе отображаются все файлы текущего проекта, в которых были обнаружены предупреждения.

При наведении на строку с файлом, будет появлятся всплывающее сообщение, содержащее полный путь к файлу и количество предупреждений в нем. Так же будет появляться кнопка для блокировки/разблокировки предупреждений по имени файла.

Если развернуть файл, то будут отображены все предупреждения в данном файле. При нажатии на предупреждение будет осуществлен переход к месту предупреждения в выбранном файле.

Детекторы Svacer*

В данном разделе отображаются все детекторы, которые сработали в текущем проекте.

При наведении на строку с детектором, будет отображаться всплывающее сообщение с критичностью детектора и количеством предупреждений для данного детектора. Так же будет появляться кнопка для блокировки/разблокировки предупреждений по типу детектора.

Если развернуть детектор, то будут отображены все предупреждения для данного детектора. При нажатии на предупреждение будет осуществлен переход к месту предупреждения в исходном коде.

Поддерживаемые команды

Результаты анализа Svace можно загрузить с помощью команды Svacer: Загрузить данные с сервера или svacer.load.

Загрузить исходный код с сервера можно с помощью команды Svacer: Загрузить исходный код или svacer.loadSources.

Результаты анализа Svace можно очистить с помощью команды Svacer: Очистить предупреждения или svacer.clear*.

Посмотреть текущий выбранный проект, ветку и снимок можно с помощью команды Svacer: Информация о проекте или svacer.info*.

Параметры

Расширение поддерживает следующие настраиваемые параметры:

*Отображается только при загруженных данных с сервера

**Отображается только при открытом файле, содержащем предупреждения