Быстрые действия в SourceCraft Code Assistant
Для удобства работы с плагином предусмотрены быстрые действия — интеграции Code Assistant в IDE.
Для Visual Studio Code доступны следующие интеграции:
- Лампочка (Lightbulb) — меню, доступное по кнопке рядом с блоками кода, с возможностью сгенерировать документацию и тесты.
- Линза (CodeLens) — кнопки над блоками кода с возможностью сгенерировать документацию и тесты, а также настроить действия, отображаемые в линзах и лампочках.
- Контекстное меню — меню, вызываемое правой кнопкой мыши, с возможностью сгенерировать документацию и тесты, отправить выделенный код в чат, запросить автодополнение и улучшения для кода, а также сформировать сообщение для коммита в системе контроля версий git.
- Чат — кнопка в чате с возможностью запросить улучшения для кода, а также сформировать сообщение для коммита в системе контроля версий git.
Для IDE от JetBrains доступны линзы с возможностью сгенерировать документацию и тесты.
Функциональность отличается в зависимости от используемой IDE.
Примечание
Язык интерфейса плагина для Visual Studio Code зависит от установленного языка IDE.
Сгенерировать тесты
В линзе или лампочке рядом с блоком кода, для которого вы хотите сформировать тесты, нажмите SourceCraft Code Assistant: Generate Tests.
Также вы можете установить курсор в блоке кода, для которого вы хотите сформировать тесты, правой кнопкой мыши вызвать контекстное меню и выбрать SourceCraft Code Assistant → Generate Tests.
Тесты отобразятся в новом чате.
Над блоком кода, для которого вы хотите сформировать тесты, нажмите SourceCraft Code Assistant: Generate Tests.
Тесты отобразятся в новом чате.
Сгенерировать документацию
В линзе или лампочке рядом с блоком кода, для которого вы хотите сформировать документацию, нажмите SourceCraft Code Assistant: Generate Docs.
Также вы можете установить курсор в блоке кода, для которого вы хотите сформировать документацию, правой кнопкой мыши вызвать контекстное меню и выбрать SourceCraft Code Assistant → Generate Docs.
Документация будет предложена в виде комментария к блоку кода. Чтобы принять или отклонить комментарий, нажмите Accept (сочетание клавиш Ctrl + Y в Windows/Linux или Command + Y в macOS) или Reject (сочетание клавиш Ctrl + N в Windows/Linux или Command + N в macOS).
Над блоком кода, для которого вы хотите сформировать документацию, нажмите SourceCraft Code Assistant: Generate Docs.
Документация отобразится в новом чате.
Предложить улучшения кода
Функциональность доступна только в Visual Studio Code.
-
На левой панели редактора нажмите кнопку SourceCraft Code Assistant.
Если у вас много плагинов, кнопка чата может быть скрыта в меню .
Также вы можете использовать сочетание клавиш Ctrl + L в Windows/Linux или Command + L в macOS.
- В окне для ввода сообщения нажмите кнопку и выберите Refactor code.
Также вы можете в редакторе вызвать правой кнопкой мыши контекстное меню и выбрать SourceCraft Code Assistant → Refactor code.
Отредактированный код и объяснения отобразятся в чате.
Отправить блок кода в чат
Функциональность доступна только в Visual Studio Code.
-
Выделите блок кода.
-
Правой кнопкой мыши вызовите контекстное меню и выберите SourceCraft Code Assistant → Add Selection to Chat.
Также вы можете использовать сочетание клавиш Ctrl + I в Windows/Linux или Command + I в macOS.
Сформировать сообщение для коммита
Функциональность доступна только в Visual Studio Code.
Поддерживается только система контроля версий git.
-
На левой панели редактора нажмите кнопку SourceCraft Code Assistant.
Если у вас много плагинов, кнопка чата может быть скрыта в меню .
Также вы можете использовать сочетание клавиш Ctrl + L в Windows/Linux или Command + L в macOS.
- В окне для ввода сообщения нажмите кнопку и выберите Commit description.
Также вы можете в редакторе вызвать правой кнопкой мыши контекстное меню и выбрать SourceCraft Code Assistant → Commit description.
Краткий отчет об изменениях и сообщение для коммита отобразятся в новом чате.
Настроить действия, отображаемые в линзах и лампочках
Функциональность доступна только в Visual Studio Code.
- В линзе над блоком кода нажмите .
- В открывшемся окне с настройками выберите, какие действия отображать в линзах, а какие — в лампочках.
Вызвать автодополнение кода
Функциональность доступна только в Visual Studio Code.
- Установите курсор в месте, в котором вы хотите вызвать автодополнение.
- Правой кнопкой мыши вызовите контекстное меню и выберите SourceCraft Code Assistant → Suggest code.