Lint и SwiftFormat: Обеспечение чистоты и консистентности кода на Swift

Использование линтеров и форматеров – неотъемлемая часть современного процесса разработки, особенно в командной работе. Они помогают поддерживать единый стиль кодирования, выявлять потенциальные ошибки и улучшать читаемость проекта. В экосистеме Swift наиболее популярными инструментами являются SwiftLint и SwiftFormat. Рассмотрим их подробнее:

SwiftLint

SwiftLint – это инструмент статического анализа кода, который проверяет ваш код на соответствие определенным правилам стиля. Он основан на конфигурационном файле `.swiftlint.yml`, в котором вы можете настроить правила, которые должны быть применены к вашему проекту. SwiftLint не изменяет ваш код автоматически, а лишь сообщает о нарушениях правил.

Установка

Есть несколько способов установить SwiftLint:

  • Через CocoaPods: Добавьте pod 'SwiftLint' в ваш Podfile и выполните pod install.
  • Через Swift Package Manager (SPM): Добавьте зависимость в Package.swift:
dependencies: [
.package(url: "https://github.com/nimblecode/SwiftLint", from: "0.49.0")
]


Затем выполните swift package update.

  • Через Homebrew: brew install swiftlint.

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

Файл .swiftlint.yml находится в корне вашего проекта. Он определяет правила, которые SwiftLint будет использовать для анализа кода. Вот пример конфигурации:

disabled_rules:
- colon # Проверка двоеточий
- comma # Проверка запятых
- trailing_newline # Требовать завершающую новую строку в файле
- line_length # Ограничение длины строки (по умолчанию 80)

opt_in_rules:
- explicit_init # Требовать явного инициализатора
- closure_spacing # Проверка пробелов вокруг скобок замыкания
- redundant_string_interpolation # Предупреждать об избыточной интерполяции строк

reporter: "xcode" # Вывод результатов в Xcode (требует интеграции)
  • disabled_rules: Список правил, которые не будут проверяться.
  • opt_in_rules: Список правил, которые должны быть включены явно.
  • reporter: Определяет формат вывода отчетов. xcode интегрируется с Xcode, отображая ошибки и предупреждения прямо в IDE.

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

  • Из командной строки: swiftlint. Эта команда проанализирует весь проект и выведет список нарушений правил.
  • Интеграция с Xcode: SwiftLint можно интегрировать с Xcode, чтобы автоматически проверять код при сборке проекта. Для этого необходимо установить расширение SwiftLint для Xcode (обычно устанавливается вместе с CocoaPods).
  • CI/CD: SwiftLint часто используется в системах непрерывной интеграции (CI) и доставки (CD), чтобы предотвратить коммит кода, который не соответствует правилам стиля.

SwiftFormat

SwiftFormat – это инструмент автоматического форматирования кода на Swift. Он автоматически приводит ваш код к единому стилю, основываясь на предопределенных правилах. В отличие от SwiftLint, SwiftFormat изменяет ваш код напрямую.

Установка

  • Через CocoaPods: Добавьте pod 'SwiftFormat' в ваш Podfile и выполните pod install.
  • Через Swift Package Manager (SPM): Добавьте зависимость в Package.swift:
dependencies: [
.package(url: "https://github.com/davefarrell/SwiftFormat", from: "0.49.0") // Используйте актуальную версию
]

Затем выполните swift package update.

  • Через Homebrew: brew install swiftformat.

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

В отличие от SwiftLint, SwiftFormat имеет меньше возможностей для конфигурации. Он использует предопределенный стиль форматирования, который можно настроить с помощью опций командной строки или файла .swiftformat. Файл .swiftformat позволяет задать некоторые параметры, например, ширину строки.

Пример файла .swiftformat:

indentation: " " # Два пробела для отступов
lineLength: 120 # Максимальная длина строки

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

  • Из командной строки: swiftformat <путь_к_файлу>. Эта команда автоматически отформатирует указанный файл. Например, swiftformat MyFile.swift. Для форматирования всех файлов в директории можно использовать swiftformat ..
  • Интеграция с Xcode: SwiftFormat можно интегрировать с Xcode через плагины или скрипты сборки. Это позволяет автоматически форматировать код при сохранении файла.
  • Git Hooks: SwiftFormat часто используется в Git hooks, чтобы автоматически форматировать код перед коммитом.

Сравнение SwiftLint и SwiftFormat

FeatureSwiftLintSwiftFormat
Тип инструментаСтатический анализатор кодаАвтоформатер кода
Изменяет код?Нет, только сообщает об ошибкахДа, автоматически форматирует код
КонфигурацияШирокие возможности настройки правилОграниченные возможности настройки
ЦельПоддержание единого стиля кодирования и выявление потенциальных ошибокАвтоматическое приведение кода к единому стилю

Рекомендации по использованию

  • Начните с SwiftLint: Сначала настройте SwiftLint, чтобы определить правила стиля для вашего проекта.
  • Затем используйте SwiftFormat: После того как вы определили стиль кодирования с помощью SwiftLint, используйте SwiftFormat, чтобы автоматически привести код к этому стилю.
  • Интегрируйте инструменты в CI/CD: Используйте SwiftLint и SwiftFormat в системах непрерывной интеграции (CI) и доставки (CD), чтобы предотвратить коммит кода, который не соответствует правилам стиля.
  • Регулярно обновляйте правила: SwiftLint и SwiftFormat постоянно развиваются, поэтому важно регулярно обновлять правила, чтобы использовать последние возможности и исправления ошибок.

В заключение, использование SwiftLint и SwiftFormat – это эффективный способ поддерживать чистоту, консистентность и читаемость кода на Swift. Они помогают командам разработчиков работать более эффективно и снижают вероятность возникновения ошибок.


Будет интересно

Nikulux в Telegram

Статьи, архивы материалов, скоро ещё и мемы

(= Подписаться =)