Repolode
Предложить
nicklockwood

nicklockwood/SwiftFormat

Инструмент командной строки и расширение для Xcode, которые автоматически приводят код Swift к единому стилю.

Открыть на GitHub
Звёзды
8,954
Форки
729
Открытые issues
289
Последний коммит
6 часов назад

Что это?

SwiftFormat — библиотека и инструмент командной строки для форматирования кода Swift в macOS, Linux и Windows. Помимо корректировки пробелов, он может добавлять или удалять неявный `self`, убирать лишние скобки и исправлять множество других отклонений от общепринятых идиом Swift.

SwiftFormat помогает команде соблюдать единый стиль кода без лишних затрат: вместо ручной проверки он автоматически применяет правила форматирования. Поведение настраивается с помощью более чем 150 правил и набора параметров, которые можно задавать в командной строке, в файле конфигурации `.swiftformat` или прямо в исходном коде с помощью директив `swiftformat` в комментариях. Режим lint сообщает о нарушениях, не изменяя файлы, что удобно для проверок в CI.

SwiftFormat можно запускать из терминала, как плагин Swift Package Manager, на этапе сборки Xcode или через Source Editor Extension. Установить его можно с помощью Homebrew, Mint, Nix, Docker или GitHub Actions.

Ключевые возможности

  • 01Добавляет или удаляет неявный `self` и убирает лишние скобки.
  • 02Предлагает более 150 правил форматирования, каждое из которых можно включать и отключать отдельно.
  • 03Читает настройки проекта из файла `.swiftformat` с переопределениями для отдельных каталогов.
  • 04Предоставляет режим lint, который сообщает о нарушениях, не изменяя файлы.
  • 05Интегрируется с Xcode, Swift Package Manager, Git pre-commit hooks и GitHub Actions.

Сценарии использования

  • Поддерживать единый стиль кода Swift в репозиториях команды.
  • Запускать проверки форматирования в CI, чтобы блокировать pull request с неотформатированным кодом.
  • Автоматически форматировать файлы Swift при сохранении или коммите.
  • Форматировать код Swift в проекте Xcode во время сборки.

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

  1. 1

    Установите инструмент командной строки через Homebrew

    brew install swiftformat
  2. 2

    Отформатируйте файлы Swift в текущем каталоге

    swiftformat .

Что важно знать

  • Команда swiftformat . перезаписывает файлы Swift на месте, поэтому сначала зафиксируйте изменения в системе контроля версий.

В подборках

Линтеры и форматировщики кода

Темы

#swift#code-formatter#linter#xcode#command-line#ci#developer-tools

Частые вопросы

Что такое SwiftFormat?
Инструмент командной строки и расширение для Xcode, которые автоматически приводят код Swift к единому стилю. SwiftFormat — библиотека и инструмент командной строки для форматирования кода Swift в macOS, Linux и Windows. Помимо корректировки пробелов, он может добавлять или удалять неявный `self`, убирать лишние скобки и исправлять множество других отклонений от общепринятых идиом Swift.
SwiftFormat можно использовать бесплатно? Какая у него лицензия?
SwiftFormat распространяется с открытым исходным кодом под лицензией MIT. Перед использованием в коммерческих продуктах проверьте условия лицензии.
SwiftFormat всё ещё поддерживается?
Активно поддерживается. Последний коммит в SwiftFormat — 7 нояб. 2026 г..
Для чего можно использовать SwiftFormat?
Поддерживать единый стиль кода Swift в репозиториях команды. Запускать проверки форматирования в CI, чтобы блокировать pull request с неотформатированным кодом. Автоматически форматировать файлы Swift при сохранении или коммите. Форматировать код Swift в проекте Xcode во время сборки.
Как установить SwiftFormat?
Установите инструмент командной строки через Homebrew: brew install swiftformat Отформатируйте файлы Swift в текущем каталоге: swiftformat .
Где скачать SwiftFormat?
Исходный код и инструкции по установке — на GitHub: https://github.com/nicklockwood/SwiftFormat

Описание создано ИИ на основе README проекта. Статистика GitHub обновляется ежедневно.

Похожие проекты