Help:Vscode: Difference between revisions

From Svacer Wiki
VisualWikitext
No edit summary
 
(33 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[Category:Help]]
[[Category:Help]]
{{Note|type=error|text=Начиная с версии 8.0.0 интеграция с VS Code не поддерживается. В качестве замены рекомендуем [[Help:XSvacer:Webide|WebIDE]]}}
== Инструкция по работе с расширением Svacer для Visual Studio Code ==
== Инструкция по работе с расширением Svacer для Visual Studio Code ==
=== Установка ===
=== Установка ===
==== Установка из официального магазина VSCode ====
==== Установка из официального магазина VSCode ====
На странице расширений VSCode найдите '''Svacer''' и нажмите кнопку '''Установить''':
Чтобы установить расширение Svacer для Visual Studio Code:
*перейдите по ссылке [https://marketplace.visualstudio.com/items?itemName=ISP-RAS.svacer Visual Studio Marketplace] и нажмите кнопку '''Install'''
*или на странице расширений VSCode найдите '''Svacer''' и нажмите кнопку '''Установить''':
[[File:Установка из магазина приложений.png|thumb|none|800px|Установка расширения из магазина приложений]]
[[File:Установка из магазина приложений.png|thumb|none|800px|Установка расширения из магазина приложений]]
Приложение считается успешно установленным, если появилось соответствующее сообщение и на панели слева отобразилась вкладка расширения [[File:Иконка_расширения.png|x25px]].
Приложение считается успешно установленным, если появилось соответствующее сообщение и на панели слева отобразилась вкладка расширения [[File:Иконка_расширения.png|x25px]]


==== Установка из файла ====
==== Установка из файла ====
Получить установочный файл можно в пользовательском интерфейсе сервера Svacer. Для этого выберите пункт '''Скачать расширение для VSCode''' в меню пользователя:</br>
Получить установочный файл можно:
[[File:Установка из файла 1.png|800px]]</br>
*на странице официального магазина приложений VSCode по ссылке: [https://marketplace.visualstudio.com/items?itemName=ISP-RAS.svacer&ssr=false#version-history Visual Studio Marketplace]
Имя установочного файла имеет вид: ''<code>svacer-<version>.vsix</code>''.
*в пользовательском интерфейсе сервера Svacer. Для этого выберите пункт '''Скачать расширение для VSCode''' в меню пользователя:<br/>
[[File:Установка из файла 1.png|800px]]<br/>
Имя установочного файла имеет вид ''<code>svacer-<version>.vsix</code>''.


Для установки:
Для установки:
:1. На странице расширений VSCode нажмите кнопку [[File:Иконка 3 точки.png|x25px]] и выберите пункт '''Установка из VSIX''':
:1. На странице расширений VSCode нажмите кнопку [[File:Иконка 3 точки.png|x25px]] и выберите пункт '''Установка из VSIX''':
[[File:Установка из файла 2.png|800px]]
:[[File:Установка из файла 2.png|800px]]
:2. В открывшемся окне проводника выберите скачанный установочный файл ''<code>svacer-<version>.vsix</code>''.
 
:2. В открывшемся окне проводника выберите скачанный установочный файл ''<code>svacer-<version>.vsix</code>''
Также расширение '''Svacer''' можно установить с помощью параметра командной строки  
Также расширение '''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]].
Приложение считается успешно установленным, если появилось соответствующее сообщение и на панели слева отобразилась вкладка расширения [[File:Иконка_расширения.png|x25px]]


=== Настройка подключения к серверу Svacer ===
=== Настройка подключения к серверу Svacer ===
Для работы расширения требуется настроить подключение к серверу Svacer:
Для работы расширения требуется настроить подключение к серверу Svacer:
:1. Перейдите на вкладку расширения [[File:Иконка расширения.png|x25px]].
:1. Перейдите на вкладку расширения [[File:Иконка расширения.png|x25px]]
:2. На панели '''ИНСТРУМЕНТЫ SVACER: Информация Svacer''' нажмите кнопку [[File:Иконка Шестеренка.png|25px|none]] и выберите пункт '''Параметры расширения'''.</br>
:2. На панели '''ИНСТРУМЕНТЫ SVACER: Информация Svacer''' нажмите кнопку [[File:Иконка Шестеренка.png|25px]] и выберите пункт '''Параметры расширения'''<br/>
[[File:Настройка подключения 1.png|thumb|none|800px]]</br>
:[[File:Настройка подключения 1.png|800px]]<br/>
В правой части окна VSCode откроется вкладка '''Параметры'''.</br>
 
[[File:Настройка подключения 2.png|thumb|none|800px]]</br>
:В правой части окна VSCode откроется вкладка '''Параметры'''.<br/>
:3. Укажите адрес и порт сервера Svacer.
 
:4. Настройте остальные параметры (опционально).
:[[File:Настройка подключения 2.png|800px]]<br/>
{| class="wikitable" style="text-align: left"
 
:3. Укажите адрес и порт сервера Svacer
:4. Настройте остальные параметры (опционально)
:{| class="wikitable" style="text-align: left"
|-
|-
! Название !! Описание !! По умолчанию
! Название !! Описание !! По умолчанию
Line 52: Line 62:
===Авторизация ===
===Авторизация ===
Для доступа к серверу Svacer требуется авторизоваться:
Для доступа к серверу Svacer требуется авторизоваться:
:1. Нажмите кнопку [[File:Иконка аккаунт.png|x25px]] и выберите пункт '''Войдите с помощью SvaceAuth, чтобы использовать Svacer''', либо на вкладке расширения в разделе '''ИНФОРМАЦИЯ SVACER''' нажмите кнопку '''Авторизоваться'''.
:1. Нажмите кнопку [[File:Иконка аккаунт.png|x25px]] и выберите пункт '''Войдите с помощью SvacerAuth, чтобы использовать Svacer''', либо на вкладке расширения в разделе '''ИНФОРМАЦИЯ SVACER''' нажмите кнопку '''Авторизоваться'''
[[File:Авторизация 1.png|thumb|none|400px|Авторизация. Вариант 1]]
:[[File:Авторизация 1.png|none|400px]]  
[[File:Авторизация 2.png|thumb|none|800px|Авторизация. Вариант 2]]
 
:[[File:Авторизация 2.png|none|600px]]  
 
:2. Нажмите кнопку '''Разрешить''' в появившемся окне:
:2. Нажмите кнопку '''Разрешить''' в появившемся окне:
:[[File:Авторизация 3.png|400px]]  
:[[File:Авторизация 3.png|400px]]  
:3. Подтвердите открытие в браузере внешнего веб-сайта для авторизации.
 
:3. Подтвердите открытие в браузере внешнего веб-сайта для авторизации
:В браузере по умолчанию откроется страница ввода учётных данных:
:В браузере по умолчанию откроется страница ввода учётных данных:
:[[File:Авторизация 4.png|400px]][[File:Авторизация 5.png|400px]]
<gallery mode=packed heights="350px" style="float:left; clear:right; margin-right:1em; margin-left:1em">
:4. Введите логин и пароль.
  Авторизация 4.png  
  Авторизация 5.png  
</gallery>
<br clear=all />
:4. Введите логин и пароль
:Отобразится страница с запросом разрешения:
:Отобразится страница с запросом разрешения:
:[[File:Авторизация 6.png|400px]]  
:[[File:Авторизация 6.png|400px]]  
:5. Нажмите кнопку '''Разрешить'''.
:5. Нажмите кнопку '''Разрешить'''
:6. Подтвердите открытие расширения Svacer в VSCode.
:6. Подтвердите открытие расширения Svacer в VSCode
Откроется окно VSCode с открытой вкладкой расширения, на которой отображается список проектов Svacer:</br>
:Откроется окно VSCode с открытой вкладкой расширения, на которой отображается список проектов Svacer:<br/>
[[File:Авторизация 7.png|800px|none]]
:[[File:Авторизация 7.png|800px|none]]


=== Алгоритм работы ===
=== Алгоритм работы ===
Каждый раз для разметки маркеров того или иного снимка проекта требуется выполнять следующие действия:
Каждый раз для разметки маркеров того или иного снимка проекта требуется выполнять следующие действия:
# [[#Открытие папки исходного кода|Открыть папку для хранения исходного кода]].
# [[#Открытие папки исходного кода|Открыть папку для хранения исходного кода]]
# [[#Выбор проекта, ветки и снимка|Выбрать проект, ветку и снимок]].
# [[#Выбор проекта, ветки и снимка|Выбрать проект, ветку и снимок]]
# [[#Загрузка исходного кода|Загрузить исходный код]].
# [[#Загрузка исходного кода|Загрузить исходный код]]
# [[#Загрузка маркеров|Загрузить маркерs]].
# [[#Загрузка маркеров|Загрузить маркеры]]
# [[#Выбор маркера|Выбрать маркер]].
# [[#Выбор маркера|Выбрать маркер]]
# [[#Просмотр исходного кода|Посмотреть исходный код файла]].
# [[#Просмотр исходного кода|Посмотреть исходный код файла]]
# [[#Разметка маркера|Разметить маркеры]].
# [[#Разметка маркера|Разметить маркеры]]
# [[#Управление комментариями|Добавить, изменить или удалить комментарии]] (опционально).
# [[#Управление комментариями|Добавить, изменить или удалить комментарии]] (опционально)
# [[#Блокировка и разблокировка маркеров|Заблокировать или разблокировать маркеры]] (опционально).
# [[#Блокировка и разблокировка маркеров|Заблокировать или разблокировать маркеры]] (опционально)
# [[#Выбор другого снимка проекта|Выбрать другие снимки проекта]] (опционально).
# [[#Выбор другого снимка проекта|Выбрать другие снимки проекта]] (опционально)


==== Открытие папки исходного файла ====
==== Открытие папки исходного файла ====
Чтобы открыть папку для хранения исходного кода:
Чтобы открыть папку для хранения исходного кода:
:1. Перейдите в окно проводника операционной системы одним из трех способов:
:1. Перейдите в окно проводника операционной системы одним из трех способов:
:* способ 1 – в меню '''Файл''' выберите пункт '''Открыть папку''';
:* способ 1 – в меню '''Файл''' выберите пункт '''Открыть папку'''
:* способ 2 – на вкладке '''Проводник''' нажмите кнопку '''Открыть папку''';
:* способ 2 – на вкладке '''Проводник''' нажмите кнопку '''Открыть папку'''
:* способ 3 – нажмите клавиши CTRL+K и следом CTRL+O.
:* способ 3 – нажмите клавиши CTRL+K и следом CTRL+O
:2. Выберите папку, в которой будет храниться исходный код снимка проекта.
:2. Выберите папку, в которой будет храниться исходный код снимка проекта
[[File:Открытие папки 1.png|thumb|none|600px|Открытие папки. Способ 1]]
<gallery mode=packed heights="400px" style="float:left; clear:right; margin-right:1em; margin-left:1em">
[[File:Открытие папки 2.png|thumb|none|600px|Открытие папки. Способ 2]]
  Открытие папки 1.png|Открытие папки. Способ 1
  Открытие папки 2.png|Открытие папки. Способ 2
</gallery>
<br clear=all />
Открытая папка и её содержимое будет отображается на вкладке '''Проводник'''.
Открытая папка и её содержимое будет отображается на вкладке '''Проводник'''.


==== Выбор проекта, ветки и снимка ====
==== Выбор проекта, ветки и снимка ====
Для этого перейдите в раздел '''ПРОЕКТЫ''' и с помощью кнопки [[File:Иконка стрелочка.png|x25px]] раскройте проект и ветку, нажмите на снимок.</br>
Для этого перейдите в раздел '''ПРОЕКТЫ''' и с помощью кнопки [[File:Иконка стрелочка.png|x20px]] раскройте проект и ветку, нажмите на снимок.<br/>
Для перехода в раздел '''ПРОЕКТЫ''' можно использовать [[#Поддерживаемые команды|команду]] '''Инструменты Svacer: Перевести фокус на представление Проекты Svacer'''.</br>
Для перехода в раздел '''ПРОЕКТЫ''' можно использовать [[#Поддерживаемые команды|команду]] '''Инструменты Svacer: Перевести фокус на представление Проекты Svacer'''.<br/>
Выбранные проект, ветка и снимок отмечены точкой справа, а информация о них отображается в разделе '''ИНФОРМАЦИЯ SVACER'''.</br>
Выбранные проект, ветка и снимок отмечены точкой справа, а информация о них отображается в разделе '''ИНФОРМАЦИЯ SVACER'''.<br/>
Для последнего загруженного снимка отображается надпись '''latest'''.</br>
Для последнего загруженного снимка отображается надпись '''latest'''.<br/>
[[File:Выбор снимка.png|800px]]
[[File:Выбор снимка.png|300px]]


==== Загрузка исходного кода ====
==== Загрузка исходного кода ====
Для этого запустите на выполнение команду '''Svacer: Загрузить исходный код.'''</br>
Для этого запустите на выполнение команду '''Svacer: Загрузить исходный код.'''<br/>
[[File:Загрузка исходного кода 1.png|x320px]]</br>
[[File:Загрузка исходного кода 1.png|600px]]<br/>
В процессе загрузки будет отображаться строка прогресса. Например:</br>
 
[[File:Загрузка исходного кода 2.png|x250px]]</br>
В процессе загрузки будет отображаться строка прогресса. Например:<br/>
После завершения загрузки отобразится сообщение об успехе и количестве загруженных файлов. Например:</br>
[[File:Загрузка исходного кода 2.png|400px]]<br/>
[[File:Загрузка исходного кода 3.png|x250px]]
 
После завершения загрузки отобразится сообщение об успехе и количестве загруженных файлов. Например:<br/>
[[File:Загрузка исходного кода 3.png|400px]]


==== Загрузка маркеров ====
==== Загрузка маркеров ====
Для этого в разделе '''ИНФОРМАЦИЯ SVACER''' нажмите кнопку '''Загрузить маркеры''' или запустите на выполнение [[#Поддерживаемые команды|команду]] '''Svacer: Загрузить данные с сервера'''.
Для этого в разделе '''ИНФОРМАЦИЯ SVACER''' нажмите кнопку '''Загрузить маркеры''' или запустите на выполнение [[#Поддерживаемые команды|команду]] '''Svacer: Загрузить данные с сервера'''.
[[File:Загрузка маркера 1.png|thumb|none|600px|Загрузка маркеров. Вариант 1]]
[[File:Загрузка маркера 1.png|thumb|none|300px|Загрузка маркеров. Вариант 1]]
[[File:Загрузка маркера 1.png|thumb|none|600px|Загрузка маркеров. Вариант 2]]
[[File:Загрузка маркера 2.png|thumb|none|600px|Загрузка маркеров. Вариант 2]]
После завершения загрузки:
После завершения загрузки:
:1. Отобразится сообщение об успехе и количестве загруженных маркеров. Например:
:1. Отобразится сообщение об успехе и количестве загруженных маркеров. Например:
[[File:Загрузка маркера 3.png|x250px]]  
:[[File:Загрузка маркера 3.png|400px]]  
:2. Раздел '''ПРОЕКТЫ SVACER''' закроется.
:2. Раздел '''ПРОЕКТЫ SVACER''' закроется
:3. Отобразятся разделы '''ФАЙЛЫ SVACER''' и '''ДЕТЕКТОРЫ SVACER'''.
:3. Отобразятся разделы '''ФАЙЛЫ SVACER''' и '''ДЕТЕКТОРЫ SVACER'''
[[File:Загрузка маркера 4.png|600px]]
[[File:Загрузка маркера 4.png|800px]]


==== Выбор маркера ====
==== Выбор маркера ====
Для этого:
Для этого:
:1. Выберите маркер в одном из двух разделов:
:1. Выберите маркер в одном из двух разделов:
::а) '''ФАЙЛЫ SVACER''' – в этом разделе отображаются все файлы [[#Выбор проекта, ветки и снимка|выбранного снимка проекта]], в которых найдены маркеры.
::а) '''ФАЙЛЫ SVACER''' – в этом разделе отображаются все файлы [[#Выбор проекта, ветки и снимка|выбранного снимка проекта]], в которых найдены маркеры
::: Если навести курсор на строку с файлом, отобразится сообщение, которое содержит полный путь к файлу и количество маркеров в нем, а также появится кнопка [[File:Icon block.png|x25px]] или [[File:Icon unblock.png|x25px]] для блокировки или разблокировки маркеров для разметки другими пользователями – по имени файла.
::: Если навести курсор на строку с файлом, отобразится сообщение, которое содержит полный путь к файлу и количество маркеров в нем, а также появится кнопка [[File:Icon block.png|x20px]] или [[File:Icon unblock.png|x20px]] для блокировки или разблокировки маркеров для разметки другими пользователями – по имени файла.
::: Чтобы раскрыть список маркеров в файле, нажмите кнопку [[File:Иконка стрелочка.png|x25px]] или на имя файла.
::: Чтобы раскрыть список маркеров в файле, нажмите кнопку [[File:Иконка стрелочка.png|x20px]] или на имя файла.
::б) '''ДЕТЕКТОРЫ SVACER''' – в этом разделе отображаются все детекторы, которые сработали в выбранном снимке проекта.
::б) '''ДЕТЕКТОРЫ SVACER''' – в этом разделе отображаются все детекторы, которые сработали в выбранном снимке проекта
::: Серьезность (критичность) детектора обозначена цветом:  
::: Серьезность (критичность) детектора обозначена цветом:  
:::* красный – наивысшая серьезность (CRITICAL);
:::* красный – наивысшая серьезность (CRITICAL)
:::* желтый – высокая серьезность (MAJOR);
:::* желтый – высокая серьезность (MAJOR)
:::* белый – обычная серьезность (NORMAL, MINOR, UNDEFINED).
:::* белый – обычная серьезность (NORMAL, MINOR, UNDEFINED)
::: Если навести курсор на строку с детектором, отобразится сообщение с его серьёзностью и количеством маркеров, а также появится кнопка [[File:Icon block.png|x25px]] или [[File:Icon unblock.png|x25px]] для блокировки или разблокировки маркеров для разметки другими пользователями – по детектору.
::: Если навести курсор на строку с детектором, отобразится сообщение с его серьёзностью и количеством маркеров, а также появится кнопка [[File:Icon block.png|x20px]] или [[File:Icon unblock.png|x20px]] для блокировки или разблокировки маркеров для разметки другими пользователями – по детектору.
::: Чтобы раскрыть список маркеров, найденных этим детектором, нажмите кнопку [[File:Иконка стрелочка.png|x25px]] или на имя детектора.
::: Чтобы раскрыть список маркеров, найденных этим детектором, нажмите кнопку [[File:Иконка стрелочка.png|x20px]] или на имя детектора.
[[File:Выбор маркера 1.png|thumb|none|600px|Выбор маркера в списке файлов]]
<gallery mode=packed heights="250px" style="float:left; clear:right; margin-right:1em; margin-left:4em">
[[File:Выбор маркера 2.png|thumb|none|600px|Выбор маркера в списке детекторов]]
  Выбор маркера 1.png|Выбор маркера в списке файлов
:: Слева отобразится раздел '''МАРКЕРЫ SVACER''' со списком маркеров, найденных в файле, а справа отобразится редактор исходного кода с фокусом на выбранном маркере.  
  Выбор маркера 2.png|Выбор маркера в списке детекторов
</gallery>
<br clear=all />
:: Слева отобразится раздел '''МАРКЕРЫ SVACER''' со списком маркеров, найденных в файле, а справа отобразится редактор исходного кода с фокусом на выбранном маркере.
:: В первой строке раздела '''МАРКЕРЫ SVACER''' указано имя файла, в котором обнаружен маркер. Список маркеров файла сгруппирован по названию детектора.  
:: В первой строке раздела '''МАРКЕРЫ SVACER''' указано имя файла, в котором обнаружен маркер. Список маркеров файла сгруппирован по названию детектора.  
[[File:Выбор маркера 3.png|600px]]
::[[File:Выбор маркера 3.png|800px]]
:2. Нажмите кнопку [[File:Иконка стрелочка.png|x25px]] или на название маркера в разделе '''МАРКЕРЫ SVACER''', чтобы раскрыть следующую информацию о нем:  
:2. Нажмите кнопку [[File:Иконка стрелочка.png|x20px]] или на название маркера в разделе '''МАРКЕРЫ SVACER''', чтобы раскрыть следующую информацию о нем:  
:: а) Трасса, построенная при анализе кода.
:: а) Трасса, построенная при анализе кода
::: Для каждого элемента (записи) трассы отображается имя файла, номер строки и описание.
::: Для каждого элемента (записи) трассы отображается имя файла, номер строки и описание
::: Если нажать на элемент трассы, в редакторе откроется исходный код файла с фокусом на строку, указанную в трассе.
::: Если нажать на элемент трассы, в редакторе откроется исходный код файла с фокусом на строку, указанную в трассе
:: б) Данные [[#Разметка маркера|разметки]].
:: б) Данные [[#Разметка маркера|разметки]]
:: в) [[#Управление комментариями|Комментарии пользователей]].
:: в) [[#Управление комментариями|Комментарии пользователей]]
[[File:Выбор маркера 4.png|400px]]
::[[File:Выбор маркера 4.png|400px]]


==== Просмотр исходного кода ====
==== Просмотр исходного кода ====
Открыть файл с исходным кодом можно открыть двумя способами:
Открыть файл с исходным кодом можно открыть двумя способами:
:1. Нажмите на маркер в одном из разделов: '''ФАЙЛЫ SVACER, ДЕТЕКТОРЫ'''.
:1. Нажмите на маркер в одном из разделов: '''ФАЙЛЫ SVACER, ДЕТЕКТОРЫ'''
:2. Нажмите кнопку [[File:Иконка цель.png|x25px]] справа от маркера в разделе '''МАРКЕРЫ SVACER'''.
:2. Нажмите кнопку [[File:Иконка цель.png|x20px]] справа от маркера в разделе '''МАРКЕРЫ SVACER'''
Наведите курсор на маркер в коде, чтобы посмотреть детальную информацию:
Наведите курсор на маркер в коде, чтобы посмотреть детальную информацию:
[[File:Просмотр кода 1.png|none|600px]]
[[File:Просмотр кода 1.png|none|800px]]
Чтобы посмотреть и проанализировать трассу, нажмите на элемент (запись) трассы в подразделе '''Трасса маркера''' раздела '''МАРКЕРЫ SVACER'''.
Чтобы посмотреть и проанализировать трассу, нажмите на элемент (запись) трассы в подразделе '''Трасса маркера''' раздела '''МАРКЕРЫ SVACER'''.
В редакторе кода откроется исходный код файла с фокусом на строку выбранного элемента трассы.
В редакторе кода откроется исходный код файла с фокусом на строку выбранного элемента трассы.


Также просмотреть исходный код файла можно на вкладке '''Проводник'''. Для этого нажмите на имя файла в иерархическом списке файлов проекта.
Также просмотреть исходный код файла можно на вкладке '''Проводник'''. Для этого нажмите на имя файла в иерархическом списке файлов проекта.
[[File:Просмотр кода 2.png|none|600px]]
[[File:Просмотр кода 2.png|none|800px]]


==== Разметка маркера ====
==== Разметка маркера ====
Для этого в подразделе '''Разметка маркера''' раздела '''МАРКЕРЫ SVACER''' выберите '''Статус''', '''Серьёзность''' и '''Действие'''.
Для этого в подразделе '''Разметка маркера''' раздела '''МАРКЕРЫ SVACER''' выберите '''Статус''', '''Серьёзность''' и '''Действие'''.
Установка серьёзности и действия доступны только после установки статуса.
Установка серьёзности и действия доступны только после установки статуса.
[[File:Разметка маркера.png|none|400px]]
[[File:Разметка маркера.png|none|400px]]


==== Управление комментариями ====
==== Управление комментариями ====
Добавлять, изменять и удалять комментарии можно в подразделе '''Комментарии маркера''' раздела '''МАРКЕРЫ SVACER''' с помощью кнопок [[File:Иконка плюс.png|x25px]], [[File:Иконка редактирования.png|x25px]] и [[File:Иконка корзина.png|x25px]] соответственно.
Добавлять, изменять и удалять комментарии можно в подразделе '''Комментарии маркера''' раздела '''МАРКЕРЫ SVACER''' с помощью кнопок [[File:Иконка плюс.png|x20px]], [[File:Иконка редактирования.png|x20px]] и [[File:Иконка корзина.png|x20px]] соответственно.
Кнопка [[File:Иконка плюс.png|x25px]] отображается при наведении курсора на шапку подраздела, а кнопки [[File:Иконка редактирования.png|x25px]] и [[File:Иконка корзина.png|x25px]] – на сам комментарий.
Кнопка [[File:Иконка плюс.png|x20px]] отображается при наведении курсора на шапку подраздела, а кнопки [[File:Иконка редактирования.png|x20px]] и [[File:Иконка корзина.png|x20px]] – на сам комментарий.
[[File:Управление комментариями.png|none|300px]]
[[File:Управление комментариями.png|none|300px]]


==== Блокировка и разблокировка маркеров ====
==== Блокировка и разблокировка маркеров ====
Для блокировки разметки используйте кнопку [[File:Icon block.png|x25px]] в следующих частях интерфейса:  
Для блокировки разметки используйте кнопку [[File:Icon block.png|x20px]] в следующих частях интерфейса:  
:1. В разделе '''ДЕТЕКТОРЫ SVACER'''.
:1. В разделе '''ДЕТЕКТОРЫ SVACER'''
:: В этом случае блокировка распространяется на все маркеры выбранного детектора в открытом проекте и ветке, для всех снимков ветки.
: В этом случае блокировка распространяется на все маркеры выбранного детектора в открытом проекте и ветке, для всех снимков ветки.
:2. В разделе '''ФАЙЛЫ SVACER'''.
:2. В разделе '''ФАЙЛЫ SVACER'''
:: В этом случае блокировка распространяется на все маркеры в выбранном файле в открытом проекте и ветке, для всех снимков ветки.
: В этом случае блокировка распространяется на все маркеры в выбранном файле в открытом проекте и ветке, для всех снимков ветки.
:3. В разделе '''МАРКЕРЫ SVACER'''.
:3. В разделе '''МАРКЕРЫ SVACER'''
:: В этом случае блокировка распространяется на все эквивалентные маркеры в открытом проекте и ветке, для всех снимков ветки.
: В этом случае блокировка распространяется на все эквивалентные маркеры в открытом проекте и ветке, для всех снимков ветки.
Если один пользователь заблокировал маркер, то в строке маркера отображается  [[File:Icon other block.png|x25px]]. В этом случае другой пользователь не сможет заблокировать и разблокировать детектор, которому принадлежит этот маркер, и файл, в котором этот маркер найден.  
Если один пользователь заблокировал маркер, то в строке маркера отображается  [[File:Icon other block.png|x20px]]. В этом случае другой пользователь не сможет заблокировать и разблокировать детектор, которому принадлежит этот маркер, и файл, в котором этот маркер найден.  
Чтобы разблокировать маркер нажмите кнопку [[File:Icon unblock.png|x25px]].
 
Чтобы разблокировать маркер нажмите кнопку [[File:Icon unblock.png|x20px]]


==== Выбор другого снимка проекта ====
==== Выбор другого снимка проекта ====
Чтобы перейти к другому снимку этого или другого проекта:
Чтобы перейти к другому снимку этого или другого проекта:
:1. Нажмите кнопку [[File:Иконка очистки предупреждений.png|x25px]] в шапке раздела '''ИНФОРМАЦИЯ SVACER''' (отображается при наведении курсора) или запустите на выполнение [[#Поддерживаемые команды|команду]] '''Svacer: Очистить предупреждения'''.
:1. Нажмите кнопку [[File:Иконка очистки предупреждений.png|x20px]] в шапке раздела '''ИНФОРМАЦИЯ SVACER''' (отображается при наведении курсора) или запустите на выполнение [[#Поддерживаемые команды|команду]] '''Svacer: Очистить предупреждения'''
[[File:Выбор другого снимка 1.png|none|600px]]
:[[File:Выбор другого снимка 1.png|none|400px]]
:2. Закройте папку с исходными кодами – в меню '''Файл''' выберите пункт '''Закрыть папку''' или воспользуйтесь горячими клавишами CTRL+K и F.
 
[[File:Выбор другого снимка 2.png|none|600px]]  
:2. Закройте папку с исходными кодами – в меню '''Файл''' выберите пункт '''Закрыть папку''' или воспользуйтесь горячими клавишами CTRL+K и F
:3. Повторите действия [[#Алгоритм работы|алгоритма работы]].
:[[File:Выбор другого снимка 2.png|none|400px]]  
 
:3. Повторите действия [[#Алгоритм работы|алгоритма работы]]


=== Поддерживаемые команды ===
=== Поддерживаемые команды ===
Line 199: Line 229:
| Svacer: Очистить предупреждения || svacer.clear || Очистить результаты анализа (маркеры) выбранного снимка проекта. После очистки маркеров становится доступен раздел со списком проектов
| Svacer: Очистить предупреждения || svacer.clear || Очистить результаты анализа (маркеры) выбранного снимка проекта. После очистки маркеров становится доступен раздел со списком проектов
|-
|-
| Svacer: Сбросить выбранный проект || - || Сброс выбранного проекта в разделах '''ИНФОРМАЦИЯ SVACER''' и '''ПРОЕКТЫ SVACER'''
| Svacer: Сбросить выбранный проект || – || Сброс выбранного проекта в разделах '''ИНФОРМАЦИЯ SVACER''' и '''ПРОЕКТЫ SVACER'''
|-
|-
| Представление: Показать Инструменты Svacer || - || Перейти к панели '''ИНСТРУМЕНТЫ SVACER'''
| Представление: Показать Инструменты Svacer || – || Перейти к панели '''ИНСТРУМЕНТЫ SVACER'''
|-
|-
| Инструменты Svacer: Перевести фокус на представление Информация Svacer || - || Перейти в раздел '''ИНФОРМАЦИЯ SVACER'''
| Инструменты Svacer: Перевести фокус на представление Информация Svacer || – || Перейти в раздел '''ИНФОРМАЦИЯ SVACER'''
|-
|-
| Инструменты Svacer: Перевести фокус на представление Файлы Svacer || - || Перейти в раздел '''ФАЙЛЫ SVACER'''
| Инструменты Svacer: Перевести фокус на представление Файлы Svacer || – || Перейти в раздел '''ФАЙЛЫ SVACER'''
|-
|-
| Инструменты Svacer: Перевести фокус на представление Проекты Svacer || - || Перейти в раздел '''ПРОЕКТЫ SVACER'''
| Инструменты Svacer: Перевести фокус на представление Проекты Svacer || – || Перейти в раздел '''ПРОЕКТЫ SVACER'''
|}
|}

Latest revision as of 19:02, 18 June 2024

Начиная с версии 8.0.0 интеграция с VS Code не поддерживается. В качестве замены рекомендуем WebIDE

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

Установка

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

Чтобы установить расширение Svacer для Visual Studio Code:

  • перейдите по ссылке Visual Studio Marketplace и нажмите кнопку Install
  • или на странице расширений VSCode найдите Svacer и нажмите кнопку Установить:
Установка расширения из магазина приложений

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

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

Получить установочный файл можно:

  • на странице официального магазина приложений VSCode по ссылке: Visual Studio Marketplace
  • в пользовательском интерфейсе сервера 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. Открыть папку для хранения исходного кода
  2. Выбрать проект, ветку и снимок
  3. Загрузить исходный код
  4. Загрузить маркеры
  5. Выбрать маркер
  6. Посмотреть исходный код файла
  7. Разметить маркеры
  8. Добавить, изменить или удалить комментарии (опционально)
  9. Заблокировать или разблокировать маркеры (опционально)
  10. Выбрать другие снимки проекта (опционально)

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

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

1. Перейдите в окно проводника операционной системы одним из трех способов:
  • способ 1 – в меню Файл выберите пункт Открыть папку
  • способ 2 – на вкладке Проводник нажмите кнопку Открыть папку
  • способ 3 – нажмите клавиши CTRL+K и следом CTRL+O
2. Выберите папку, в которой будет храниться исходный код снимка проекта
  • Открытие папки. Способ 1

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

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

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


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

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

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

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

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

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

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

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

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

Загрузка маркеров. Вариант 1
Загрузка маркеров. Вариант 2

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

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
Retrieved from "https://svacer.ispras.ru/mediawiki/index.php?title=Help:Vscode&oldid=2023"