Настройка правил чата в SourceCraft Code Assistant

Важно

Функциональность доступна только в Visual Studio Code.

Вы можете указать, какие правила должен соблюдать Code Assistant при выполнении запроса. Например, что код должен быть написан на языке Python с соблюдением гайдлайнов по качеству.

Используйте предустановленное правило, откорректируйте его или добавьте собственное.

Правила задаются для конкретного запроса в чат и не сохраняются для всех последующих запросов. Чтобы правило применялось для всех запросов, добавьте в его настройки параметр alwaysApply: true.

Примечание

Язык интерфейса плагина для Visual Studio Code зависит от установленного языка IDE.

Использовать правило

  1. На левой панели редактора нажмите кнопку SourceCraft Code Assistant.

    Если у вас много плагинов, кнопка чата может быть скрыта в меню .

    Также вы можете использовать сочетание клавиш Ctrl + L в Windows/Linux или Command + L в macOS.

  2. В окне для ввода сообщения нажмите кнопку или введите @ и выберите Rules.
  3. Посмотрите описание правил:
    • Чтобы посмотреть краткое описание правила, наведите на него указатель.
    • Чтобы посмотреть полный текст правила, напротив него нажмите .
  4. Выберите правило.

Правило будет отображаться в меню .

Изменить предустановленное правило

  1. В окне для ввода сообщения нажмите кнопку или введите @ и выберите Rules.

  2. Напротив правила, которое вы хотите изменить, нажмите .

  3. В открывшемся файле в блоке, отделенном ---, измените параметры правила:

    • name — название правила, по которому его можно будет найти в меню Rules.
    • description — краткое описание правила, которое будет отображаться при наведении указателя.
    • alwaysApply — включать ли правило в контекст по умолчанию (true или false). Оно будет отображаться в меню , и его можно будет удалить. По умолчанию — false.

    Если не задать параметры name и description, они будут сгенерированы по имени файла и первым строкам правила.

  4. Отредактируйте текст правила и сохраните изменения.

Добавить свое правило

  1. В окне для ввода сообщения нажмите кнопку или введите @ и выберите Rules.

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

  3. В открывшемся файле в блоке, отделенном ---, заполните параметры правила:

    • name — название правила, по которому его можно будет найти в меню Rules.
    • description — краткое описание правила, которое будет отображаться при наведении указателя.
    • alwaysApply — включать ли правило в контекст по умолчанию (true или false). Оно будет отображаться в меню , и его можно будет удалить. По умолчанию — false.

    Если не задать параметры name и description, они будут сгенерированы по имени файла и первым строкам правила.

  4. Добавьте текст правила и сохраните файл.

Файл с правилом будет сохранен по пути <директория_проекта>/.codeassistant/rules/<название_файла>.mdc.

Также вы можете вручную добавлять в указанную и дочерние директории файлы правил с расширением .md и .mdc.

В файлах с расширением .mdc поддерживается блок с названием и описанием правила, а также указанием, включать ли правило в контекст по умолчанию:

---
name: Enter your rule name
description: Enter your rule description
alwaysApply: false
---

См. также

Предыдущая
Настройка контекста чата
Следующая
Библиотека промтов