Программирование
Применяем стиль и соглашения Swift с помощью SwiftLint
Поддержание чистоты и соответствия кодовой базы — действительно сложная задача, особенно при работе в команде. SwiftLint — это инструмент для соблюдения стиля и соглашений Swift.
Что такое SwiftLint?
SwiftLint — это инструмент для соблюдения стиля и соглашений Swift. Поддержание чистоты и соответствия кодовой базы — действительно сложная задача, особенно при работе в команде. У каждого разработчика возникают свои правила и соглашения при написании кода. Из-за этого нам нужны инструменты для постоянного поддержания и исправления стиля и соглашений в кодовой базе, основанных на “Руководстве по стилю Swift” на GitHub.
В этом руководстве я покажу как установить и использовать SwiftLint в Xcode.
1. Установка SwiftLint
Вы можете установить SwiftLint в свой iOS-проект через Cocoapod или установить на свой Mac локально. Это ваш выбор.
Использование Homebrew:
Просто откройте терминал и выполните:
brew install swiftlint
Использование CocoaPods:
Просто добавьте следующую строку в свой подфайл:
pod 'SwiftLint'
2. Интеграция с Xcode
Перейдите к цели приложения. На левой верхней вкладке нажмите «Build Phases», нажмите на знак «плюс» и, наконец, нажмите «New Run Script Phase».
В пустую область сценария скопируйте и вставьте установочный сценарий ниже.
Скопируйте скрипт в эту область и сохраните. Обязательно установите флажки “Based on dependency analysis” (На основе анализа зависимостей) и “Show environment variables in build log” (Показывать переменные среды в логах сборки).
Примечание. Поскольку мы добавили сценарий для фазы сборки, теперь каждый раз, когда Xcode начнет сборку проекта, будет запускаться этот сценарий.
Сделаем пробный запуск:
- Нажмем Command + b, чтобы собрать приложение.
- После завершения сборки поищем логи.
Вы увидите кучу логов нашего скрипта.
- При запуске скрипт обнаружил SwiftLint. Это здорово 😊
- И напечатал свою версию.
- Но выдал фатальное исключение из-за отсутствия репозитория git.
На данный момент это нормально, потому что я создал свой проект локально и не добавлял его в локальный репозиторий git. Давайте исправим это.
Примечание. Вы можете не получить эту ошибку, потому что ваш проект уже находится в репозитории git.
Чтобы исправить эту ошибку, в основном меню Xcode перейдите в верхнем меню к Source Control → Новый репозиторий Git
После того, как появится окно, выберите проект, который вы хотите добавить, и нажмите «Создать».
Теперь можно двигаться дальше. Давайте снова соберем проект и проверим, работает ли наш сценарий.
Ура! 👌
3. Тестирование SwiftLint
Давайте откроем файл ViewController.swift и попробуем испытать правила по умолчанию, которые предварительно прописаны в SwiftLint. Например, сделаем принудительное приведение типа, чтобы попробовать.
Вы можете найти обновленный список правил и дополнительную информацию о них здесь.
Вы должны получить красные и желтые предупреждения в коде.
Предупреждения и ошибки
trailing_whitespace → Lines should not have trailing whitespace.
force_cast → Force casts should be avoided.
Заключение
Теперь скрипт SwiftLint запускается после каждой сборки и обрабатывает все правила по умолчанию. Теперь вы готовы применить стиль и соглашения Swift к своему проекту. 🎉
Бонус
Для своих пользовательских правил найдите в папке проекта файл swiftlint.yml и пропишите их туда.
Полезные ссылки для SwiftLint
