yx format

Форматирование исходного кода YaoXiang, унификация стиля кода.

Использование

yx format [OPTIONS] <PATH>

Параметры

Параметр	Описание
PATH	Исходный файл или каталог для форматирования

Опции

Опция	Описание	Значение по умолчанию
-n, --dry-run	Пробный запуск: показать отличия форматирования, не записывать	Нет
-w, --write	Записать результат форматирования на место	Нет
--stdout	Вывод в стандартный вывод (поведение по умолчанию, если не указаны -n/-w)	--
--no-verify	Пропустить проверку после форматирования (оптимизация производительности)	Нет
--indent <N>	Переопределить ширину отступа	Из конфигурации
--line-width <N>	Переопределить максимальную ширину строки	Из конфигурации
--use-tabs	Использовать Tab для отступов	Из конфигурации
--single-quote	Использовать одинарные кавычки для строк	Из конфигурации

Приоритет конфигурации

Параметры форматирования применяются в следующем порядке приоритета (от высшего к низшему):

1. Флаги командной строки
2. Конфигурация форматирования из yaoxiang.toml проекта
3. Пользовательский конфигурационный файл

Подробнее о параметрах конфигурации и значениях по умолчанию см. в Конфигурация форматирования.

Коды выхода

Код	Описание
0	Успех (включая случаи, когда форматирование не требуется)
2	В режиме --dry-run обнаружены файлы, требующие форматирования, или не найдено файлов .yx
1	Прочие ошибки

Примеры

# 格式化并输出到标准输出（默认）
yx format src/main.yx

# 就地写回
yx format -w src/

# CI 检查：存在待格式化文件时以退出码 2 失败
yx format -n .

# 临时覆盖缩进与行宽
yx format --indent 4 --line-width 100 main.yx

Интеграция с CI

# GitHub Actions
- name: Format check
  run: yx format --dry-run .

Код выхода 2 означает, что существуют файлы, требующие форматирования. Подробную конфигурацию CI см. в Руководство по интеграции с CI.

См. также

• yx check — статическая проверка
• yx test — запуск тестов
• Обзор правил форматирования — отдельные правила форматирования
• Руководство по интеграции с CI — интеграция с CI/CD