zig fmt: форматирование кода

В Zig есть встроенный форматтер, поэтому все проекты выглядят одинаково. Команда zig fmt переписывает Ваш код в каноническом стиле Zig.

Укажите файл для zig fmt, и команда отформатирует его прямо на диске, исправив отступы, пробелы и переносы строк.

Передайте команде directory, и zig fmt рекурсивно обойдёт его, приведя в порядок каждый найденный файл .zig. Одна команда форматирует весь проект.

Не нужно спорить о style options. У zig fmt один фиксированный стиль, который прекращает споры о форматировании во всех командах и кодовых базах.

Флаг --check сообщает о неотформатированных файлах и завершает работу с ошибкой, но никогда ничего не изменяет. Идеально для проверки.

Поскольку --check возвращает ошибочный exit code, его можно подключить к непрерывной интеграции, чтобы автоматически отклонять неотформатированный код.

Передайте --stdin, и zig fmt отформатирует текст из конвейера и выведет результат. Редакторы используют это для форматирования при сохранении.

Большинство редакторов автоматически запускают zig fmt при save. Ваш код мгновенно принимает аккуратный вид, и Вам больше не приходится думать о его оформлении.

Помните об области действия: zig fmt исправляет только layout. Он не переименовывает элементы и не находит логические ошибки — это задача компилятора.

zig fmt в основном оставляет без изменений line breaks в литералах и комментариях, поэтому очищает структуру, не стирая намеренное оформление.

Запускайте форматтер before каждым коммитом. Чистые и единообразные различия ускоряют проверку и делают всю историю понятной для всех.

В CI нужно завершать сборку с ошибкой, если код не отформатирован, но не изменять файлы. Какая команда подойдёт?

Вы познакомились с zig fmt: единый канонический стиль, форматирование файлов или каталогов, --check для CI и форматирование при сохранении в редакторе, чтобы без усилий поддерживать код в чистоте. 🧹