|
|
| (72 intermediate revisions by 4 users not shown) |
| Line 1: |
Line 1: |
| [[Category:Help]]
| | == Интеграция с Visual Studio Code == |
| <span style="color:#ff0000">
| | В состав дистрибутива Svacer входит расширение для Visual Studio Code, обеспечивающее взаимодействие пользователя VS Code с сервером Svacer. Подробная информация может быть найдена в документации на данное расширение в дистрибутиве Svacer по пути '''integrations/vscode/readme.pdf''', а также на [https://marketplace.visualstudio.com/items?itemName=ISP-RAS.svacer Visual Studio Marketplace] |
| <big>В версии 8.0.0 интеграция с VS Code не поддерживается: было много изменений, и мы пока не обновили расширение VSCode для работы с ними, но обновим и выпустим немного позже.</big>
| |
| </span>
| |
| | |
| == Инструкция по работе с расширением Svacer для Visual Studio Code == | |
| === Установка ===
| |
| ==== Установка из официального магазина VSCode ====
| |
| Чтобы установить расширение 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|x25px]]
| |
| | |
| ==== Установка из файла ====
| |
| Получить установочный файл можно:
| |
| *на странице официального магазина приложений VSCode по ссылке: [https://marketplace.visualstudio.com/items?itemName=ISP-RAS.svacer&ssr=false#version-history Visual Studio Marketplace]
| |
| *в пользовательском интерфейсе сервера Svacer. Для этого выберите пункт '''Скачать расширение для VSCode''' в меню пользователя:<br/>
| |
| [[File:Установка из файла 1.png|800px]]<br/>
| |
| Имя установочного файла имеет вид ''<code>svacer-<version>.vsix</code>''.
| |
| | |
| Для установки:
| |
| :1. На странице расширений VSCode нажмите кнопку [[File:Иконка 3 точки.png|x25px]] и выберите пункт '''Установка из VSIX''':
| |
| :[[File:Установка из файла 2.png|800px]]
| |
| | |
| :2. В открывшемся окне проводника выберите скачанный установочный файл ''<code>svacer-<version>.vsix</code>''
| |
| Также расширение '''Svacer''' можно установить с помощью параметра командной строки
| |
| '''<code>--install-extension</code>''', указав путь к файлу:<br/>
| |
| '''<code>--install-extension <path-to-file>/svacer-<version>.vsix</code>'''<br/>
| |
| Приложение считается успешно установленным, если появилось соответствующее сообщение и на панели слева отобразилась вкладка расширения [[File:Иконка_расширения.png|x25px]]
| |
| | |
| === Настройка подключения к серверу Svacer ===
| |
| Для работы расширения требуется настроить подключение к серверу Svacer:
| |
| :1. Перейдите на вкладку расширения [[File:Иконка расширения.png|x25px]]
| |
| :2. На панели '''ИНСТРУМЕНТЫ SVACER: Информация Svacer''' нажмите кнопку [[File:Иконка Шестеренка.png|25px]] и выберите пункт '''Параметры расширения'''<br/>
| |
| :[[File:Настройка подключения 1.png|800px]]<br/>
| |
| | |
| :В правой части окна VSCode откроется вкладка '''Параметры'''.<br/>
| |
| | |
| :[[File:Настройка подключения 2.png|800px]]<br/>
| |
| | |
| :3. Укажите адрес и порт сервера Svacer
| |
| :4. Настройте остальные параметры (опционально)
| |
| :{| class="wikitable" style="text-align: left"
| |
| |-
| |
| ! Название !! Описание !! По умолчанию
| |
| |-
| |
| ! scope="row" colspan="3"| Настройки сервера
| |
| |-
| |
| | Hostname || Имя или IP-адрес Svacer || localhost
| |
| |-
| |
| | Port || Порт Svacer || 8080
| |
| Если значение оставить пустым, то будет использован порт по умолчанию для выбранного протокола
| |
| |-
| |
| | Use Https || Использовать протокол https || false
| |
| |-
| |
| ! scope="row" colspan="3"| Настройки рабочей области
| |
| |-
| |
| | Include Traces || Отображать трассу для маркеров || true
| |
| |-
| |
| | Include Comments || Отображать комментарии пользователей || true
| |
| |}
| |
| | |
| ===Авторизация ===
| |
| Для доступа к серверу Svacer требуется авторизоваться:
| |
| :1. Нажмите кнопку [[File:Иконка аккаунт.png|x25px]] и выберите пункт '''Войдите с помощью SvacerAuth, чтобы использовать Svacer''', либо на вкладке расширения в разделе '''ИНФОРМАЦИЯ SVACER''' нажмите кнопку '''Авторизоваться'''
| |
| :[[File:Авторизация 1.png|none|400px]]
| |
| | |
| :[[File:Авторизация 2.png|none|600px]]
| |
| | |
| :2. Нажмите кнопку '''Разрешить''' в появившемся окне:
| |
| :[[File:Авторизация 3.png|400px]]
| |
| | |
| :3. Подтвердите открытие в браузере внешнего веб-сайта для авторизации
| |
| :В браузере по умолчанию откроется страница ввода учётных данных:
| |
| <gallery mode=packed heights="350px" style="float:left; clear:right; margin-right:1em; margin-left:1em">
| |
| Авторизация 4.png
| |
| Авторизация 5.png
| |
| </gallery>
| |
| <br clear=all />
| |
| :4. Введите логин и пароль
| |
| :Отобразится страница с запросом разрешения:
| |
| :[[File:Авторизация 6.png|400px]]
| |
| :5. Нажмите кнопку '''Разрешить'''
| |
| :6. Подтвердите открытие расширения Svacer в VSCode
| |
| :Откроется окно VSCode с открытой вкладкой расширения, на которой отображается список проектов Svacer:<br/>
| |
| :[[File:Авторизация 7.png|800px|none]]
| |
| | |
| === Алгоритм работы ===
| |
| Каждый раз для разметки маркеров того или иного снимка проекта требуется выполнять следующие действия:
| |
| # [[#Открытие папки исходного кода|Открыть папку для хранения исходного кода]]
| |
| # [[#Выбор проекта, ветки и снимка|Выбрать проект, ветку и снимок]]
| |
| # [[#Загрузка исходного кода|Загрузить исходный код]]
| |
| # [[#Загрузка маркеров|Загрузить маркеры]]
| |
| # [[#Выбор маркера|Выбрать маркер]]
| |
| # [[#Просмотр исходного кода|Посмотреть исходный код файла]]
| |
| # [[#Разметка маркера|Разметить маркеры]]
| |
| # [[#Управление комментариями|Добавить, изменить или удалить комментарии]] (опционально)
| |
| # [[#Блокировка и разблокировка маркеров|Заблокировать или разблокировать маркеры]] (опционально)
| |
| # [[#Выбор другого снимка проекта|Выбрать другие снимки проекта]] (опционально)
| |
| | |
| ==== Открытие папки исходного файла ====
| |
| Чтобы открыть папку для хранения исходного кода:
| |
| :1. Перейдите в окно проводника операционной системы одним из трех способов:
| |
| :* способ 1 – в меню '''Файл''' выберите пункт '''Открыть папку'''
| |
| :* способ 2 – на вкладке '''Проводник''' нажмите кнопку '''Открыть папку'''
| |
| :* способ 3 – нажмите клавиши CTRL+K и следом CTRL+O
| |
| :2. Выберите папку, в которой будет храниться исходный код снимка проекта
| |
| <gallery mode=packed heights="400px" style="float:left; clear:right; margin-right:1em; margin-left:1em">
| |
| Открытие папки 1.png|Открытие папки. Способ 1
| |
| Открытие папки 2.png|Открытие папки. Способ 2
| |
| </gallery>
| |
| <br clear=all />
| |
| Открытая папка и её содержимое будет отображается на вкладке '''Проводник'''.
| |
| | |
| ==== Выбор проекта, ветки и снимка ====
| |
| Для этого перейдите в раздел '''ПРОЕКТЫ''' и с помощью кнопки [[File:Иконка стрелочка.png|x20px]] раскройте проект и ветку, нажмите на снимок.<br/>
| |
| Для перехода в раздел '''ПРОЕКТЫ''' можно использовать [[#Поддерживаемые команды|команду]] '''Инструменты Svacer: Перевести фокус на представление Проекты Svacer'''.<br/>
| |
| Выбранные проект, ветка и снимок отмечены точкой справа, а информация о них отображается в разделе '''ИНФОРМАЦИЯ SVACER'''.<br/>
| |
| Для последнего загруженного снимка отображается надпись '''latest'''.<br/>
| |
| [[File:Выбор снимка.png|300px]]
| |
| | |
| ==== Загрузка исходного кода ====
| |
| Для этого запустите на выполнение команду '''Svacer: Загрузить исходный код.'''<br/>
| |
| [[File:Загрузка исходного кода 1.png|600px]]<br/>
| |
| | |
| В процессе загрузки будет отображаться строка прогресса. Например:<br/>
| |
| [[File:Загрузка исходного кода 2.png|400px]]<br/>
| |
| | |
| После завершения загрузки отобразится сообщение об успехе и количестве загруженных файлов. Например:<br/>
| |
| [[File:Загрузка исходного кода 3.png|400px]]
| |
| | |
| ==== Загрузка маркеров ====
| |
| Для этого в разделе '''ИНФОРМАЦИЯ SVACER''' нажмите кнопку '''Загрузить маркеры''' или запустите на выполнение [[#Поддерживаемые команды|команду]] '''Svacer: Загрузить данные с сервера'''.
| |
| [[File:Загрузка маркера 1.png|thumb|none|300px|Загрузка маркеров. Вариант 1]]
| |
| [[File:Загрузка маркера 2.png|thumb|none|600px|Загрузка маркеров. Вариант 2]]
| |
| После завершения загрузки:
| |
| :1. Отобразится сообщение об успехе и количестве загруженных маркеров. Например:
| |
| :[[File:Загрузка маркера 3.png|400px]]
| |
| :2. Раздел '''ПРОЕКТЫ SVACER''' закроется
| |
| :3. Отобразятся разделы '''ФАЙЛЫ SVACER''' и '''ДЕТЕКТОРЫ SVACER'''
| |
| [[File:Загрузка маркера 4.png|800px]]
| |
| | |
| ==== Выбор маркера ====
| |
| Для этого:
| |
| :1. Выберите маркер в одном из двух разделов:
| |
| ::а) '''ФАЙЛЫ SVACER''' – в этом разделе отображаются все файлы [[#Выбор проекта, ветки и снимка|выбранного снимка проекта]], в которых найдены маркеры
| |
| ::: Если навести курсор на строку с файлом, отобразится сообщение, которое содержит полный путь к файлу и количество маркеров в нем, а также появится кнопка [[File:Icon block.png|x20px]] или [[File:Icon unblock.png|x20px]] для блокировки или разблокировки маркеров для разметки другими пользователями – по имени файла.
| |
| ::: Чтобы раскрыть список маркеров в файле, нажмите кнопку [[File:Иконка стрелочка.png|x20px]] или на имя файла.
| |
| ::б) '''ДЕТЕКТОРЫ SVACER''' – в этом разделе отображаются все детекторы, которые сработали в выбранном снимке проекта
| |
| ::: Серьезность (критичность) детектора обозначена цветом:
| |
| :::* красный – наивысшая серьезность (CRITICAL)
| |
| :::* желтый – высокая серьезность (MAJOR)
| |
| :::* белый – обычная серьезность (NORMAL, MINOR, UNDEFINED)
| |
| ::: Если навести курсор на строку с детектором, отобразится сообщение с его серьёзностью и количеством маркеров, а также появится кнопка [[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:4em">
| |
| Выбор маркера 1.png|Выбор маркера в списке файлов
| |
| Выбор маркера 2.png|Выбор маркера в списке детекторов
| |
| </gallery>
| |
| <br clear=all />
| |
| :: Слева отобразится раздел '''МАРКЕРЫ SVACER''' со списком маркеров, найденных в файле, а справа отобразится редактор исходного кода с фокусом на выбранном маркере.
| |
| :: В первой строке раздела '''МАРКЕРЫ SVACER''' указано имя файла, в котором обнаружен маркер. Список маркеров файла сгруппирован по названию детектора.
| |
| ::[[File:Выбор маркера 3.png|800px]]
| |
| :2. Нажмите кнопку [[File:Иконка стрелочка.png|x20px]] или на название маркера в разделе '''МАРКЕРЫ SVACER''', чтобы раскрыть следующую информацию о нем:
| |
| :: а) Трасса, построенная при анализе кода
| |
| ::: Для каждого элемента (записи) трассы отображается имя файла, номер строки и описание
| |
| ::: Если нажать на элемент трассы, в редакторе откроется исходный код файла с фокусом на строку, указанную в трассе
| |
| :: б) Данные [[#Разметка маркера|разметки]]
| |
| :: в) [[#Управление комментариями|Комментарии пользователей]]
| |
| ::[[File:Выбор маркера 4.png|400px]]
| |
| | |
| ==== Просмотр исходного кода ====
| |
| Открыть файл с исходным кодом можно открыть двумя способами:
| |
| :1. Нажмите на маркер в одном из разделов: '''ФАЙЛЫ SVACER, ДЕТЕКТОРЫ'''
| |
| :2. Нажмите кнопку [[File:Иконка цель.png|x20px]] справа от маркера в разделе '''МАРКЕРЫ SVACER'''
| |
| Наведите курсор на маркер в коде, чтобы посмотреть детальную информацию:
| |
| [[File:Просмотр кода 1.png|none|800px]]
| |
| Чтобы посмотреть и проанализировать трассу, нажмите на элемент (запись) трассы в подразделе '''Трасса маркера''' раздела '''МАРКЕРЫ SVACER'''.
| |
| | |
| В редакторе кода откроется исходный код файла с фокусом на строку выбранного элемента трассы.
| |
| | |
| Также просмотреть исходный код файла можно на вкладке '''Проводник'''. Для этого нажмите на имя файла в иерархическом списке файлов проекта.
| |
| [[File:Просмотр кода 2.png|none|800px]]
| |
| | |
| ==== Разметка маркера ====
| |
| Для этого в подразделе '''Разметка маркера''' раздела '''МАРКЕРЫ SVACER''' выберите '''Статус''', '''Серьёзность''' и '''Действие'''.
| |
| | |
| Установка серьёзности и действия доступны только после установки статуса.
| |
| [[File:Разметка маркера.png|none|400px]]
| |
| | |
| ==== Управление комментариями ====
| |
| Добавлять, изменять и удалять комментарии можно в подразделе '''Комментарии маркера''' раздела '''МАРКЕРЫ SVACER''' с помощью кнопок [[File:Иконка плюс.png|x20px]], [[File:Иконка редактирования.png|x20px]] и [[File:Иконка корзина.png|x20px]] соответственно.
| |
| Кнопка [[File:Иконка плюс.png|x20px]] отображается при наведении курсора на шапку подраздела, а кнопки [[File:Иконка редактирования.png|x20px]] и [[File:Иконка корзина.png|x20px]] – на сам комментарий.
| |
| [[File:Управление комментариями.png|none|300px]]
| |
| | |
| ==== Блокировка и разблокировка маркеров ====
| |
| Для блокировки разметки используйте кнопку [[File:Icon block.png|x20px]] в следующих частях интерфейса:
| |
| :1. В разделе '''ДЕТЕКТОРЫ SVACER'''
| |
| : В этом случае блокировка распространяется на все маркеры выбранного детектора в открытом проекте и ветке, для всех снимков ветки.
| |
| :2. В разделе '''ФАЙЛЫ SVACER'''
| |
| : В этом случае блокировка распространяется на все маркеры в выбранном файле в открытом проекте и ветке, для всех снимков ветки.
| |
| :3. В разделе '''МАРКЕРЫ SVACER'''
| |
| : В этом случае блокировка распространяется на все эквивалентные маркеры в открытом проекте и ветке, для всех снимков ветки.
| |
| Если один пользователь заблокировал маркер, то в строке маркера отображается [[File:Icon other block.png|x20px]]. В этом случае другой пользователь не сможет заблокировать и разблокировать детектор, которому принадлежит этот маркер, и файл, в котором этот маркер найден.
| |
| | |
| Чтобы разблокировать маркер нажмите кнопку [[File:Icon unblock.png|x20px]]
| |
| | |
| ==== Выбор другого снимка проекта ====
| |
| Чтобы перейти к другому снимку этого или другого проекта:
| |
| :1. Нажмите кнопку [[File:Иконка очистки предупреждений.png|x20px]] в шапке раздела '''ИНФОРМАЦИЯ SVACER''' (отображается при наведении курсора) или запустите на выполнение [[#Поддерживаемые команды|команду]] '''Svacer: Очистить предупреждения'''
| |
| :[[File:Выбор другого снимка 1.png|none|400px]]
| |
| | |
| :2. Закройте папку с исходными кодами – в меню '''Файл''' выберите пункт '''Закрыть папку''' или воспользуйтесь горячими клавишами CTRL+K и F
| |
| :[[File:Выбор другого снимка 2.png|none|400px]]
| |
| | |
| :3. Повторите действия [[#Алгоритм работы|алгоритма работы]]
| |
| | |
| === Поддерживаемые команды ===
| |
| Чтобы открыть список доступных команд, нажмите клавиши CTRL+SHIFT+P или введите '''<code>></code>''' в строке поиска.
| |
| {| class="wikitable" style="text-align: left"
| |
| |-
| |
| ! Команда !! Аналог команды !! Описание
| |
| |-
| |
| | 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'''
| |
| |}
| |