Help:Vscode: Difference between revisions

Revision as of 12:41, 17 May 2023

Инструкция по работе с расширением Svacer для Visual Studio Code

Установка

Установка из официального магазина VSCode

На странице расширений VSCode найдите Svacer и нажмите кнопку Установить:

Установка расширения из магазина приложений

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

Установка из файла

Получить установочный файл можно в пользовательском интерфейсе сервера Svacer. Для этого выберите пункт Скачать расширение для VSCode в меню пользователя:

Имя установочного файла имеет вид svacer-<version>.vsix.

Для установки:

1. На странице расширений VSCode нажмите кнопку

и выберите пункт Установка из VSIX:

2. В открывшемся окне проводника выберите скачанный установочный файл svacer-<version>.vsix.

Также расширение Svacer можно установить с помощью параметра командной строки --install-extension, указав путь к файлу:
--install-extension <path-to-file>/svacer-<version>.vsix
Приложение считается успешно установленным, если появилось соответствующее сообщение и на панели слева отобразилась вкладка расширения .

Настройка подключения к серверу Svacer

Для работы расширения требуется настроить подключение к серверу Svacer:

1. Перейдите на вкладку расширения

.

2. На панели ИНСТРУМЕНТЫ SVACER: Информация Svacer нажмите кнопку

и выберите пункт Параметры расширения.

В правой части окна VSCode откроется вкладка Параметры.

3. Укажите адрес и порт сервера Svacer.

4. Настройте остальные параметры (опционально).

Название	Описание	По умолчанию
Настройки сервера
Hostname	Имя или IP-адрес Svacer	localhost
Port	Порт Svacer	8080 Если значение оставить пустым, то будет использован порт по умолчанию для выбранного протокола
Use Https	Использовать протокол https	false
Настройки рабочей области
Include Traces	Отображать трассу для маркеров	true
Include Comments	Отображать комментарии пользователей	true

Авторизация

Для доступа к серверу Svacer требуется авторизоваться:

1. Нажмите кнопку

и выберите пункт Войдите с помощью SvacerAuth, чтобы использовать Svacer, либо на вкладке расширения в разделе ИНФОРМАЦИЯ SVACER нажмите кнопку Авторизоваться.

2. Нажмите кнопку Разрешить в появившемся окне:

3. Подтвердите открытие в браузере внешнего веб-сайта для авторизации.

В браузере по умолчанию откроется страница ввода учётных данных:

4. Введите логин и пароль.

Отобразится страница с запросом разрешения:

5. Нажмите кнопку Разрешить.

6. Подтвердите открытие расширения Svacer в VSCode.

Откроется окно VSCode с открытой вкладкой расширения, на которой отображается список проектов Svacer:

Алгоритм работы

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

Открыть папку для хранения исходного кода.
Выбрать проект, ветку и снимок.
Загрузить исходный код.
Загрузить маркеры.
Выбрать маркер.
Посмотреть исходный код файла.
Разметить маркеры.
Добавить, изменить или удалить комментарии (опционально).
Заблокировать или разблокировать маркеры (опционально).
Выбрать другие снимки проекта (опционально).

Открытие папки исходного файла

Чтобы открыть папку для хранения исходного кода:

1. Перейдите в окно проводника операционной системы одним из трех способов:

способ 1 – в меню Файл выберите пункт Открыть папку;
способ 2 – на вкладке Проводник нажмите кнопку Открыть папку;
способ 3 – нажмите клавиши CTRL+K и следом CTRL+O.

2. Выберите папку, в которой будет храниться исходный код снимка проекта.

Открытие папки. Способ 1
Открытие папки. Способ 2

Открытая папка и её содержимое будет отображается на вкладке Проводник.

Выбор проекта, ветки и снимка

Для этого перейдите в раздел ПРОЕКТЫ и с помощью кнопки раскройте проект и ветку, нажмите на снимок.
Для перехода в раздел ПРОЕКТЫ можно использовать команду Инструменты Svacer: Перевести фокус на представление Проекты Svacer.
Выбранные проект, ветка и снимок отмечены точкой справа, а информация о них отображается в разделе ИНФОРМАЦИЯ SVACER.
Для последнего загруженного снимка отображается надпись latest.

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

Для этого запустите на выполнение команду Svacer: Загрузить исходный код.

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

После завершения загрузки отобразится сообщение об успехе и количестве загруженных файлов. Например:

Загрузка маркеров

Для этого в разделе ИНФОРМАЦИЯ SVACER нажмите кнопку Загрузить маркеры или запустите на выполнение команду Svacer: Загрузить данные с сервера.

После завершения загрузки:

1. Отобразится сообщение об успехе и количестве загруженных маркеров. Например:

2. Раздел ПРОЕКТЫ SVACER закроется.

3. Отобразятся разделы ФАЙЛЫ SVACER и ДЕТЕКТОРЫ SVACER.

Выбор маркера

Для этого:

1. Выберите маркер в одном из двух разделов:

а) ФАЙЛЫ SVACER – в этом разделе отображаются все файлы выбранного снимка проекта, в которых найдены маркеры.

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

или

для блокировки или разблокировки маркеров для разметки другими пользователями – по имени файла.

Чтобы раскрыть список маркеров в файле, нажмите кнопку

или на имя файла.

б) ДЕТЕКТОРЫ SVACER – в этом разделе отображаются все детекторы, которые сработали в выбранном снимке проекта.

Серьезность (критичность) детектора обозначена цветом:

красный – наивысшая серьезность (CRITICAL);
желтый – высокая серьезность (MAJOR);
белый – обычная серьезность (NORMAL, MINOR, UNDEFINED).

Если навести курсор на строку с детектором, отобразится сообщение с его серьёзностью и количеством маркеров, а также появится кнопка

или

для блокировки или разблокировки маркеров для разметки другими пользователями – по детектору.

Чтобы раскрыть список маркеров, найденных этим детектором, нажмите кнопку

или на имя детектора.

Выбор маркера в списке файлов
Выбор маркера в списке детекторов

Слева отобразится раздел МАРКЕРЫ SVACER со списком маркеров, найденных в файле, а справа отобразится редактор исходного кода с фокусом на выбранном маркере.

В первой строке раздела МАРКЕРЫ SVACER указано имя файла, в котором обнаружен маркер. Список маркеров файла сгруппирован по названию детектора.

2. Нажмите кнопку

или на название маркера в разделе МАРКЕРЫ SVACER, чтобы раскрыть следующую информацию о нем:

а) Трасса, построенная при анализе кода.

Для каждого элемента (записи) трассы отображается имя файла, номер строки и описание.

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

б) Данные разметки.

в) Комментарии пользователей.

Просмотр исходного кода

Открыть файл с исходным кодом можно открыть двумя способами:

1. Нажмите на маркер в одном из разделов: ФАЙЛЫ SVACER, ДЕТЕКТОРЫ.

2. Нажмите кнопку

справа от маркера в разделе МАРКЕРЫ SVACER.

Наведите курсор на маркер в коде, чтобы посмотреть детальную информацию:

Чтобы посмотреть и проанализировать трассу, нажмите на элемент (запись) трассы в подразделе Трасса маркера раздела МАРКЕРЫ SVACER.

В редакторе кода откроется исходный код файла с фокусом на строку выбранного элемента трассы.

Также просмотреть исходный код файла можно на вкладке Проводник. Для этого нажмите на имя файла в иерархическом списке файлов проекта.

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

Для этого в подразделе Разметка маркера раздела МАРКЕРЫ SVACER выберите Статус, Серьёзность и Действие.

Установка серьёзности и действия доступны только после установки статуса.

Управление комментариями

Добавлять, изменять и удалять комментарии можно в подразделе Комментарии маркера раздела МАРКЕРЫ SVACER с помощью кнопок , и соответственно. Кнопка отображается при наведении курсора на шапку подраздела, а кнопки и – на сам комментарий.

Блокировка и разблокировка маркеров

Для блокировки разметки используйте кнопку в следующих частях интерфейса:

1. В разделе ДЕТЕКТОРЫ SVACER.

В этом случае блокировка распространяется на все маркеры выбранного детектора в открытом проекте и ветке, для всех снимков ветки.

2. В разделе ФАЙЛЫ SVACER.

В этом случае блокировка распространяется на все маркеры в выбранном файле в открытом проекте и ветке, для всех снимков ветки.

3. В разделе МАРКЕРЫ SVACER.

В этом случае блокировка распространяется на все эквивалентные маркеры в открытом проекте и ветке, для всех снимков ветки.

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

Чтобы разблокировать маркер нажмите кнопку .

Выбор другого снимка проекта

Чтобы перейти к другому снимку этого или другого проекта:

1. Нажмите кнопку

в шапке раздела ИНФОРМАЦИЯ SVACER (отображается при наведении курсора) или запустите на выполнение команду Svacer: Очистить предупреждения.

2. Закройте папку с исходными кодами – в меню Файл выберите пункт Закрыть папку или воспользуйтесь горячими клавишами CTRL+K и F.

3. Повторите действия алгоритма работы.

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

Чтобы открыть список доступных команд, нажмите клавиши CTRL+SHIFT+P или введите > в строке поиска.

Команда	Аналог команды	Описание
Svacer: Информация о проекте	svacer.info	Отобразить сообщение с информацией о выбранных проекте, ветке и снимке
Svacer: Загрузить исходный код	svacer.loadSources	Загрузка исходного кода выбранного снимка проекта
Svacer: Загрузить данные с сервера	svacer.load	Загрузка результатов анализа (маркеров) выбранного снимка проекта
Svacer: Очистить предупреждения	svacer.clear	Очистить результаты анализа (маркеры) выбранного снимка проекта. После очистки маркеров становится доступен раздел со списком проектов
Svacer: Сбросить выбранный проект	–	Сброс выбранного проекта в разделах ИНФОРМАЦИЯ SVACER и ПРОЕКТЫ SVACER
Представление: Показать Инструменты Svacer	–	Перейти к панели ИНСТРУМЕНТЫ SVACER
Инструменты Svacer: Перевести фокус на представление Информация Svacer	–	Перейти в раздел ИНФОРМАЦИЯ SVACER
Инструменты Svacer: Перевести фокус на представление Файлы Svacer	–	Перейти в раздел ФАЙЛЫ SVACER
Инструменты Svacer: Перевести фокус на представление Проекты Svacer	–	Перейти в раздел ПРОЕКТЫ SVACER

@@ Line 8: / Line 8: @@
 ==== Установка из файла ====
-Получить установочный файл можно в пользовательском интерфейсе сервера Svacer. Для этого выберите пункт '''Скачать расширение для VSCode''' в меню пользователя:</br>
+Получить установочный файл можно в пользовательском интерфейсе сервера Svacer. Для этого выберите пункт '''Скачать расширение для VSCode''' в меню пользователя:<br/>
-[[File:Установка из файла 1.png|800px]]</br>
+[[File:Установка из файла 1.png|800px]]<br/>
-Имя установочного файла имеет вид: ''<code>svacer-<version>.vsix</code>''.
+Имя установочного файла имеет вид ''<code>svacer-<version>.vsix</code>''.
 Для установки:
 :1.	На странице расширений VSCode нажмите кнопку [[File:Иконка 3 точки.png|x25px]] и выберите пункт '''Установка из VSIX''':
-[[File:Установка из файла 2.png|800px]]
+:[[File:Установка из файла 2.png|800px]]
 :2.	В открывшемся окне проводника выберите скачанный установочный файл ''<code>svacer-<version>.vsix</code>''.
 Также расширение '''Svacer''' можно установить с помощью параметра командной строки
-'''<code>--install-extension</code>''', указав путь к файлу:</br>
+'''<code>--install-extension</code>''', указав путь к файлу:<br/>
-'''<code>code --install-extension <path-to-file>/svacer-<version>.vsix</code>'''</br>
+'''<code>--install-extension <path-to-file>/svacer-<version>.vsix</code>'''<br/>
 Приложение считается успешно установленным, если появилось соответствующее сообщение и на панели слева отобразилась вкладка расширения [[File:Иконка_расширения.png|x25px]].
@@ Line 24: / Line 24: @@
 Для работы расширения требуется настроить подключение к серверу Svacer:
 :1.	Перейдите на вкладку расширения [[File:Иконка расширения.png|x25px]].
-:2.	На панели '''ИНСТРУМЕНТЫ SVACER: Информация Svacer''' нажмите кнопку [[File:Иконка Шестеренка.png|25px]] и выберите пункт '''Параметры расширения'''.</br>
+:2.	На панели '''ИНСТРУМЕНТЫ SVACER: Информация Svacer''' нажмите кнопку [[File:Иконка Шестеренка.png|25px]] и выберите пункт '''Параметры расширения'''.<br/>
-[[File:Настройка подключения 1.png|800px]]</br>
+:[[File:Настройка подключения 1.png|800px]]<br/>
-В правой части окна VSCode откроется вкладка '''Параметры'''.</br>
-[[File:Настройка подключения 2.png|800px]]</br>
+:В правой части окна VSCode откроется вкладка '''Параметры'''.<br/>
+:[[File:Настройка подключения 2.png|800px]]<br/>
 :3.	Укажите адрес и порт сервера Svacer.
 :4.	Настройте остальные параметры (опционально).
-{| class="wikitable" style="text-align: left"
+:{| class="wikitable" style="text-align: left"
 |-
 ! Название !! Описание !! По умолчанию
@@ Line 52: / Line 55: @@
 ===Авторизация ===
 Для доступа к серверу Svacer требуется авторизоваться:
-:1.	Нажмите кнопку [[File:Иконка аккаунт.png|x25px]] и выберите пункт '''Войдите с помощью SvaceAuth, чтобы использовать Svacer''', либо на вкладке расширения в разделе '''ИНФОРМАЦИЯ SVACER''' нажмите кнопку '''Авторизоваться'''.
+:1.	Нажмите кнопку [[File:Иконка аккаунт.png|x25px]] и выберите пункт '''Войдите с помощью SvacerAuth, чтобы использовать Svacer''', либо на вкладке расширения в разделе '''ИНФОРМАЦИЯ SVACER''' нажмите кнопку '''Авторизоваться'''.
-  [[File:Авторизация 1.png|none|400px]]
+:[[File:Авторизация 1.png|none|400px]]
+:[[File:Авторизация 2.png|none|600px]]
-  [[File:Авторизация 2.png|none|600px]]
 :2.	Нажмите кнопку '''Разрешить''' в появившемся окне:
 :[[File:Авторизация 3.png|400px]]
 :3.	Подтвердите открытие в браузере внешнего веб-сайта для авторизации.
 :В браузере по умолчанию откроется страница ввода учётных данных:
@@ Line 70: / Line 75: @@
 :5.	Нажмите кнопку '''Разрешить'''.
 :6.	Подтвердите открытие расширения Svacer в VSCode.
-Откроется окно VSCode с открытой вкладкой расширения, на которой отображается список проектов Svacer:</br>
+:Откроется окно VSCode с открытой вкладкой расширения, на которой отображается список проектов Svacer:<br/>
-[[File:Авторизация 7.png|800px|none]]
+:[[File:Авторизация 7.png|800px|none]]
 === Алгоритм работы ===
@@ Line 78: / Line 83: @@
 # [[#Выбор проекта, ветки и снимка|Выбрать проект, ветку и снимок]].
 # [[#Загрузка исходного кода|Загрузить исходный код]].
-# [[#Загрузка маркеров|Загрузить маркерs]].
+# [[#Загрузка маркеров|Загрузить маркеры]].
 # [[#Выбор маркера|Выбрать маркер]].
 # [[#Просмотр исходного кода|Посмотреть исходный код файла]].
@@ Line 101: / Line 106: @@
 ==== Выбор проекта, ветки и снимка ====
-Для этого перейдите в раздел '''ПРОЕКТЫ''' и с помощью кнопки [[File:Иконка стрелочка.png|x20px]] раскройте проект и ветку, нажмите на снимок.</br>
+Для этого перейдите в раздел '''ПРОЕКТЫ''' и с помощью кнопки [[File:Иконка стрелочка.png|x20px]] раскройте проект и ветку, нажмите на снимок.<br/>
-Для перехода в раздел '''ПРОЕКТЫ''' можно использовать [[#Поддерживаемые команды|команду]] '''Инструменты Svacer: Перевести фокус на представление Проекты Svacer'''.</br>
+Для перехода в раздел '''ПРОЕКТЫ''' можно использовать [[#Поддерживаемые команды|команду]] '''Инструменты Svacer: Перевести фокус на представление Проекты Svacer'''.<br/>
-Выбранные проект, ветка и снимок отмечены точкой справа, а информация о них отображается в разделе '''ИНФОРМАЦИЯ SVACER'''.</br>
+Выбранные проект, ветка и снимок отмечены точкой справа, а информация о них отображается в разделе '''ИНФОРМАЦИЯ SVACER'''.<br/>
-Для последнего загруженного снимка отображается надпись '''latest'''.</br>
+Для последнего загруженного снимка отображается надпись '''latest'''.<br/>
 [[File:Выбор снимка.png|300px]]
 ==== Загрузка исходного кода ====
-Для этого запустите на выполнение команду '''Svacer: Загрузить исходный код.'''</br>
+Для этого запустите на выполнение команду '''Svacer: Загрузить исходный код.'''<br/>
-[[File:Загрузка исходного кода 1.png|600px]]</br>
+[[File:Загрузка исходного кода 1.png|600px]]<br/>
-В процессе загрузки будет отображаться строка прогресса. Например:</br>
+В процессе загрузки будет отображаться строка прогресса. Например:<br/>
-[[File:Загрузка исходного кода 2.png|400px]]</br>
+[[File:Загрузка исходного кода 2.png|400px]]<br/>
-После завершения загрузки отобразится сообщение об успехе и количестве загруженных файлов. Например:</br>
+После завершения загрузки отобразится сообщение об успехе и количестве загруженных файлов. Например:<br/>
 [[File:Загрузка исходного кода 3.png|400px]]
@@ Line 139: / Line 144: @@
 ::: Если навести курсор на строку с детектором, отобразится сообщение с его серьёзностью и количеством маркеров, а также появится кнопка [[File:Icon block.png|x20px]] или [[File:Icon unblock.png|x20px]] для блокировки или разблокировки маркеров для разметки другими пользователями – по детектору.
 ::: Чтобы раскрыть список маркеров, найденных этим детектором, нажмите кнопку [[File:Иконка стрелочка.png|x20px]] или на имя детектора.
-<gallery mode=packed heights="250px" style="float:left; clear:right; margin-right:1em; margin-left:1em">
+<gallery mode=packed heights="250px" style="float:left; clear:right; margin-right:1em; margin-left:4em">
    Выбор маркера 1.png|Выбор маркера в списке файлов
    Выбор маркера 2.png|Выбор маркера в списке детекторов
@@ Line 146: / Line 151: @@
 :: Слева отобразится раздел '''МАРКЕРЫ SVACER''' со списком маркеров, найденных в файле, а справа отобразится редактор исходного кода с фокусом на выбранном маркере.
 :: В первой строке раздела '''МАРКЕРЫ SVACER''' указано имя файла, в котором обнаружен маркер. Список маркеров файла сгруппирован по названию детектора.
-[[File:Выбор маркера 3.png|800px]]
+::[[File:Выбор маркера 3.png|800px]]
 :2.	Нажмите кнопку [[File:Иконка стрелочка.png|x20px]] или на название маркера в разделе '''МАРКЕРЫ SVACER''', чтобы раскрыть следующую информацию о нем:
 :: а)	Трасса, построенная при анализе кода.
@@ Line 153: / Line 158: @@
 :: б)	Данные [[#Разметка маркера|разметки]].
 :: в)	[[#Управление комментариями|Комментарии пользователей]].
-[[File:Выбор маркера 4.png|400px]]
+::[[File:Выбор маркера 4.png|400px]]
 ==== Просмотр исходного кода ====
@@ Line 194: / Line 199: @@
 Чтобы перейти к другому снимку этого или другого проекта:
 :1. Нажмите кнопку [[File:Иконка очистки предупреждений.png|x20px]] в шапке раздела '''ИНФОРМАЦИЯ SVACER''' (отображается при наведении курсора) или запустите на выполнение [[#Поддерживаемые команды|команду]] '''Svacer: Очистить предупреждения'''.
-[[File:Выбор другого снимка 1.png|none|400px]]
+:[[File:Выбор другого снимка 1.png|none|400px]]
 :2. Закройте папку с исходными кодами – в меню '''Файл''' выберите пункт '''Закрыть папку''' или воспользуйтесь горячими клавишами CTRL+K и F.
-[[File:Выбор другого снимка 2.png|none|400px]]
+:[[File:Выбор другого снимка 2.png|none|400px]]
 :3.	Повторите действия [[#Алгоритм работы|алгоритма работы]].