VSCodeExtensions: Difference between revisions

Revision as of 09:31, 2 October 2026

На этой странице приведена инструкция по работе с расширением 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 - Отображение детекторов в дереве маркеров по умолчанию. Доступные значения: группировать детекторы по уровню серьезности (по умолчанию), список детекторов.

@@ Line 13: / Line 13: @@
 . Панель '''Снимки'''. Содержит перечень всех снимков (snap-файлов), размещённых в рабочей директории. По нажатии на имя снимка обновляются данные о маркерах на остальных панелях.
-Чтобы просмотреть JSON снимка нажмите кнопку '''Просмотреть JSON''' [[File:icon_info2.png|25px]] в правой части строки с его именем.
+Чтобы просмотреть JSON снимка нажмите кнопку '''Просмотреть JSON''' [[File:icon_info2.png|x25px]] в правой части строки с его именем.
 . Панель '''Маркеры.''' Содержит перечень всех сработавших детекторов в одном из представлений: списком или сгруппированными по уровням серьезности.
-Для переключения представления нажмите кнопку '''Изменить группировку''' [[File:icon_grouping.png|25px]].
+Для переключения представления нажмите кнопку '''Изменить группировку''' [[File:icon_grouping.png|x25px]].
-Чтобы раскрыть список маркеров, обнаруженных детектором, нажмите кнопку [[File:icon_next.png|25px]] в левой части строки с его именем.
+Чтобы раскрыть список маркеров, обнаруженных детектором, нажмите кнопку [[File:icon_next.png|x25px]] в левой части строки с его именем.
 Чтобы посмотреть маркер в редакторе исходного кода, нажмите на имя файла в списке.
@@ Line 38: / Line 38: @@
 Для отмены фильтрации по одному параметру повторно нажмите на него в списке.
-Для отмены всех применённых фильтров, нажмите кнопку '''Отменить фильтр''' [[File:icon_cancel_filter.png|25px]].
+Для отмены всех применённых фильтров, нажмите кнопку '''Отменить фильтр''' [[File:icon_cancel_filter.png|x25px]].
 . Панель '''Подробности Маркера'''. Содержит подробную информацию о маркере и его разметке в следующих категориях:
@@ Line 50: / Line 50: @@
 Изменения параметров разметки сохраняются автоматически.
-Чтобы установить все параметры разметки нажмите кнопку '''Разметить маркер''' [[File:icon_review.png|25px]], в открывшемся поле быстрого доступа последовательно выберите значения статуса, серьёзности и требуемого действия, при необходимости введите комментарий и сохраните разметку.
+Чтобы установить все параметры разметки нажмите кнопку '''Разметить маркер''' [[File:icon_review.png|x25px]], в открывшемся поле быстрого доступа последовательно выберите значения статуса, серьёзности и требуемого действия, при необходимости введите комментарий и сохраните разметку.
 б) Trace – содержит информацию об элементах трассы маркера.
@@ Line 58: / Line 58: @@
 в) Comments – содержит комментарии к маркеру.
-Чтобы добавить комментарий, нажмите кнопку '''Добавить комментарий''' [[File:icon_plus.png|25px]], на открывшейся вкладке введите текст и сохраните комментарий.
+Чтобы добавить комментарий, нажмите кнопку '''Добавить комментарий''' [[File:icon_plus.png|x25px]], на открывшейся вкладке введите текст и сохраните комментарий.
-Чтобы отредактировать комментарий, в его строке нажмите кнопку '''Редактировать комментарий''' [[File:icon_edit.png|25px]], на открывшейся вкладке внесите изменения и сохраните комментарий.
+Чтобы отредактировать комментарий, в его строке нажмите кнопку '''Редактировать комментарий''' [[File:icon_edit.png|x25px]], на открывшейся вкладке внесите изменения и сохраните комментарий.
-Чтобы удалить комментарий, в его строке нажмите кнопку '''Удалить комментарий''' [[File:icon_trash.png|25px]] и подтвердите действие.
+Чтобы удалить комментарий, в его строке нажмите кнопку '''Удалить комментарий''' [[File:icon_trash.png|x25px]] и подтвердите действие.
 г) Details – содержит основные атрибуты маркера: наименование детектора, описание маркера, инструмент, язык и функция.
@@ Line 70: / Line 70: @@
 По умолчанию применена встроенная в расширение конфигурация детекторов, удалить ее нельзя.
-Чтобы добавить другую конфигурацию детекторов (например, выгруженную с сервера Svacer) нажмите кнопку '''Добавить конфигурацию''' [[File:icon_plus.png|25px]] и выберите JSON-файл.
+Чтобы добавить другую конфигурацию детекторов (например, выгруженную с сервера Svacer) нажмите кнопку '''Добавить конфигурацию''' [[File:icon_plus.png|x25px]] и выберите JSON-файл.
-Чтобы применить конфигурацию детекторов нажмите кнопку [[File:icon_check.png|25px]] в правой части строки с конфигурацией. У примененной конфигурации отобразиться иконка [[File:icon_checked.png|25px]] в левой части строки.
+Чтобы применить конфигурацию детекторов нажмите кнопку [[File:icon_check.png|x25px]] в правой части строки с конфигурацией. У примененной конфигурации отобразиться иконка [[File:icon_checked.png|x25px]] в левой части строки.
-Чтобы посмотреть JSON с конфигурацией детекторов нажмите на кнопку [[File:icon_info.png|25px]] в правой части строки с конфигурацией.
+Чтобы посмотреть JSON с конфигурацией детекторов нажмите на кнопку [[File:icon_info.png|x25px]] в правой части строки с конфигурацией.
-Чтобы удалить конфигурацию детекторов нажмите на кнопку [[File:icon_trash.png|25px]] в правой части строки с конфигурацией и подтвердите действие.
+Чтобы удалить конфигурацию детекторов нажмите на кнопку [[File:icon_trash.png|x25px]] в правой части строки с конфигурацией и подтвердите действие.
 == 3         Настройки расширения ==