Пользовательские правила в SourceCraft Code Assistant

Пользовательские правила позволяют персонализировать поведение Code Assistant, предоставляя конкретные указания, которые формируют ответы, стиль написания кода, процессы принятия решений, стандарты документации, требования к тестированию, рекомендации по рабочему процессу и прочее.

Расположение файлов правил

Вы можете предоставлять пользовательские правила с помощью глобальных правил (применяются ко всем проектам), правил рабочей области (специфичных для проекта) или через интерфейс чата (в верхней панели нажмите и выберите Modes).

Директория с глобальными правилами

Правила из этих директорий применяются ко всем проектам автоматически:

• Linux/macOS: ~/.codeassistant/rules/ и ~/.codeassistant/rules-{modeSlug}/
• Windows: %USERPROFILE%\.codeassistant\rules\ и %USERPROFILE%\.codeassistant\rules-{modeSlug}\

Директория для правил рабочей области

Правила из этих директорий применяются только к текущему проекту. Эти правила могут переопределять глобальные.

• Предпочтительный метод — директория .codeassistant/rules/:

  .
  ├── .codeassistant/
  │   └── rules/ # Правила для всей рабочей области
  │       ├── 01-general.md
  │       └── 02-coding-style.txt
  └── ... (другие файлы проекта)
  

• Дополнительный метод — файл .codeassistantrules:

  .
  ├── .codeassistantrules # Правила для всей рабочей области в виде единого файла
  └── ... (другие файлы проекта)
  

Правила для конкретного режима

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

• Предпочтительный метод — директория .codeassistant/rules-{modeSlug}/:

  .
  ├── .codeassistant/
  │   └── rules-code/ # Правила для режима code
  │       ├── 01-js-style.md
  │       └── 02-ts-style.md
  └── ... (другие файлы проекта)
  

• Дополнительный метод — файл .codeassistantrules-{modeSlug}:

  .
  ├── .codeassistantrules-code # Правила для режима code в виде единого файла
  └── ... (другие файлы проекта)
  

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

Установка глобальных пользовательских правил

Эти правила применяются ко всем рабочим областям и сохраняют ваши предпочтения независимо от того, над каким проектом вы работаете.

1. На верхней панели чата нажмите нажмите и выберите Modes.
2. В блоке Custom Instructions for All Modes введите ваши правила.

Как правила объединяются

Правила размещаются в системном запросе в следующем формате:

====
ПОЛЬЗОВАТЕЛЬСКИЕ ПРАВИЛА

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

Предпочтение языка:
[Предпочтение языка, если установлено]

Глобальные правила:
[Глобальные правила из вкладки Modes]

Правила для конкретного режима:
[Правила для конкретного режима из вкладки Modes для текущего режима]

Правила:

# Правила из директорий rules-{modeSlug}:
[Содержимое ВСЕХ файлов из ~/.codeassistant/rules-{modeSlug}/ И .codeassistant/rules-{modeSlug}/, если они существуют]

# Правила из .codeassistantrules-{modeSlug}:
[Содержимое файла .codeassistantrules-{modeSlug}, если директории для конкретного режима не содержат файлов]

# Правила из .codeassistantignore:
[Правила, связанные с .codeassistantignore, если применимо]

# Стандарт правил агентов (AGENTS.md):
[Содержимое AGENTS.md или AGENT.md из корня рабочей области, если присутствует и включено]

# Правила из директорий rules:
[Содержимое ВСЕХ файлов из ~/.codeassistant/rules/ И .codeassistant/rules/, если они существуют]

# Правила из .codeassistantrules:
[Содержимое файла .codeassistantrules, если директории общих правил не содержат файлов]
====