Конфигурация Code2Prompt 📖

Обзор учебника

Ручное написание длинных шаблонов исключения или специфических настроек токенизатора каждый раз может быть утомительным. Этот учебник покажет, как использовать файл конфигурации .c2pconfig для «настройки и забывания» настроек проекта.

Предварительные требования

Убедитесь, что code2prompt установлен. Если нет, см. руководство по установке. Знание синтаксиса TOML полезно, но не обязательно.

Что такое `.c2pconfig`?

.c2pconfig — это файл конфигурации в формате TOML. При запуске code2prompt он автоматически ищет этот файл в текущем рабочем каталоге и применяет настройки.

Вы можете определить:

Правила фильтрации: Постоянные include/exclude шаблоны.
Форматы вывода: По умолчанию JSON, Markdown или XML.
Контекст шаблона: Предопределённые переменные для ваших Handlebars‑шаблонов.

Быстрый старт

Создайте файл .c2pconfig в корне проекта и задайте базовое поведение.

# Базовые настройки
default_output = "stdout"   # варианты: stdout, clipboard, file
include_patterns = ["src/**/*.rs", "Cargo.toml"]
exclude_patterns = ["**/target/**", "tests/fixtures/**"]
line_numbers = true
output_format = "markdown"

[user_variables]
project_name = "MyAwesomeProject"
author = "Developer"

Справочник конфигурации

Ключ	Тип	Описание
`path`	String	Путь к кодовой базе (обычно `.`)
`include_patterns`	Array	Glob‑шаблоны файлов для включения
`exclude_patterns`	Array	Glob‑шаблоны файлов для исключения
`line_numbers`	Boolean	Добавлять номера строк к блокам кода
`absolute_path`	Boolean	Использовать абсолютные пути
`full_directory_tree`	Boolean	Генерировать полный дерево даже для исключённых файлов
`output_format`	String	`markdown`, `json`, `xml`
`sort_method`	String	`name_asc`, `name_desc`, `date_asc`, `date_desc`
`encoding`	String	Токенизатор: `cl100k`, `p50k`, `o200k`
`diff_enabled`	Boolean	Включать Git‑diff (HEAD vs Index)
`token_map_enabled`	Boolean	Показать карту использования токенов

Пошаговое внедрение

Создание конфигурации
Окно терминала
```
touch .c2pconfig
```
Определение глобальных фильтров
Исключите тяжёлые каталоги (node_modules, target/) для чистого контекста LLM.
```
exclude_patterns = [
  "**/node_modules/**",
  "package-lock.json",
  "dist/**"
]
```
Выбор токенизатора
Подберите токенизатор под целевую LLM. Для GPT‑4o используйте o200k, для Claude и GPT‑4 — cl100k.
```
encoding = "o200k"
```
Добавление пользовательских переменных
В разделе [user_variables] задайте переменные, которые будут доступны в ваших Handlebars‑шаблонах.
```
[user_variables]
project_goal = "Рефакторинг модуля аутентификации для повышения безопасности."
```
Запуск без дополнительных флагов
После сохранения .c2pconfig просто выполните:
Окно терминала
```
code2prompt .
```

Понимание приоритетов

CLI‑аргументы > .c2pconfig > настройки по умолчанию. Это позволяет иметь базовую конфигурацию и при необходимости переопределять её в командной строке.

Пример «готовый к ревью»

Эта конфигурация оптимизирована для генерации промптов, пригодных для обзора кода.

default_output = "clipboard"
include_patterns = ["*.rs"]
exclude_patterns = ["**/test*","**code2prompt-python*"]
line_numbers = false
absolute_path = true

[user_variables]
project = "code2prompt"