VSCodeExtensions
На этой странице приведена инструкция по работе с расширением Svacer в Visual Studio Code
1 Введение
Расширение Svacer для VS Code работает в офлайн-режиме, т. е. без доступа к серверу Svacer. Для начала работы необходимо из Svacer выгрузить соответствующий проект (снимок) в snap-файл и разместить его в локальном репозитории (рабочей директории) с исходным кодом проекта.
Предупреждения (маркеры), найденные статическим анализатором, автоматически сопоставляются с актуальным исходным кодом. Это позволяет разработчику одновременно размечать маркеры и править исходный код проекта.
Разметка с комментариями сохраняется в тот же snap-файл, который в дальнейшем можно импортировать обратно в Svacer.
2 Описание интерфейса
Интерфейс расширения включает следующие элементы:
1. Панель Снимки. Содержит перечень всех снимков (snap-файлов), размещённых в рабочей директории. По нажатии на имя снимка обновляются данные о маркерах на остальных панелях.
Чтобы просмотреть JSON снимка нажмите кнопку Просмотреть JSON 
в правой части строки с его именем.
2. Панель Маркеры. Содержит перечень всех сработавших детекторов в одном из представлений: списком или сгруппированными по уровням серьезности.
Для переключения представления нажмите кнопку Изменить группировку 
.
Чтобы раскрыть список маркеров, обнаруженных детектором, нажмите кнопку 
в левой части строки с его именем.
Чтобы посмотреть маркер в редакторе исходного кода, нажмите на имя файла в списке.
3. Панель Фильтр Маркеров. Позволяет отфильтровать маркеры в панели Маркеры по следующим категориям:
- Checkers – по имени детектора;
- Checker severity – по степени серьёзности детектора;
- Checker reliability – по уровню надёжности детектора;
- Tools – по инструментам;
- Languages – по языкам;
- Review status – по статусу разметки маркера;
- Marker severity – по степени серьёзности маркера;
- Required action – по требуемым действиям.
Для применения фильтра раскройте категорию и нажмите на одно или несколько значений.
Для отмены фильтрации по одному параметру повторно нажмите на него в списке.
Для отмены всех применённых фильтров, нажмите кнопку Отменить фильтр 
.
4. Панель Подробности Маркера. Содержит подробную информацию о маркере и его разметке в следующих категориях:
а) Review – содержит информацию о разметке маркера: статус, его серьёзность и требуемое действие.
Чтобы изменить параметр разметки, нажмите на него и в открывшемся поле быстрого доступа выберите значение.
Установка серьёзности и действия доступны только после установки статуса.
Изменения параметров разметки сохраняются автоматически.
Чтобы установить все параметры разметки нажмите кнопку Разметить маркер 
, в открывшемся поле быстрого доступа последовательно выберите значения статуса, серьёзности и требуемого действия, при необходимости введите комментарий и сохраните разметку.
б) Trace – содержит информацию об элементах трассы маркера.
Чтобы перейти к элементу трассы в редакторе исходного кода, нажмите на имя файла в списке.
в) Comments – содержит комментарии к маркеру.
Чтобы добавить комментарий, нажмите кнопку Добавить комментарий 
, на открывшейся вкладке введите текст и сохраните комментарий.
Чтобы отредактировать комментарий, в его строке нажмите кнопку Редактировать комментарий 
, на открывшейся вкладке внесите изменения и сохраните комментарий.
Чтобы удалить комментарий, в его строке нажмите кнопку Удалить комментарий 
и подтвердите действие.
г) Details – содержит основные атрибуты маркера: наименование детектора, описание маркера, инструмент, язык и функция.
5. Панель Конфигурации детекторов. Конфигурация детекторов предоставляет информацию о детекторах в случае, если она отсутствует в snap-файлах.
По умолчанию применена встроенная в расширение конфигурация детекторов, удалить ее нельзя.
Чтобы добавить другую конфигурацию детекторов (например, выгруженную с сервера Svacer) нажмите кнопку Добавить конфигурацию 
и выберите JSON-файл.
Чтобы применить конфигурацию детекторов нажмите кнопку 
в правой части строки с конфигурацией. У примененной конфигурации отобразиться иконка File:Icon checked.png в левой части строки.
Чтобы посмотреть JSON с конфигурацией детекторов нажмите на кнопку 
в правой части строки с конфигурацией.
Чтобы удалить конфигурацию детекторов нажмите на кнопку в правой части строки с конфигурацией и подтвердите действие.
3 Настройки расширения
Настройки расширения содержат следующие параметры:
a) Svacer-lsp › Trace: Server - Лог взаимодействия между VS Code и Language server. Доступные значения: off (по умолчанию), message, verbose.
b) Svacer › Markers: Checkers Display - Отображение детекторов в дереве маркеров по умолчанию. Доступные значения: группировать детекторы по уровню серьезности (по умолчанию), список детекторов.