SwiftFormat. Форматируем код

Что такое SwiftFormat?

SwiftFormat — это инструмент для, не поверишь, форматирования кода.
Вот как он работает:

Для чего он нужен?

Работая в команде, хорошо иметь единый Code Style. И как настоящий тру разработчик, лучше автоматизировать все, что можно автоматизировать. И лучше думать о том, как работает код, нежели о том, как он выглядит.

Как его установить?

Есть несколько способов установить SwiftFormat, я покажу вам пару.

Command-line tool

Открываем терминал и обновляем homebrew:

$ brew update

Устанавливаем SwiftFormat:

$ brew install swiftformat

Далее идем в директорию проекта:

$ cd myProject

И запускаем следующее, чтобы отформатировать все файлы:

$ swiftformat .

Чтобы отформатировать определенный файл, нужно ввести:

$ swiftformat GodClass.swift

Build phase в Xcode

Но запускать его каждый раз вручную как-то не тру. Поэтому мы сделаем так, что при каждом билде проекта, SwiftFormat будет запускаться сам. Для этого так же устанавливаем swiftformat через терминал и добавляем следующее в run script build phase:

if which swiftformat >/dev/null; then
  swiftformat .
else
  echo "warning: SwiftFormat not installed, download from https://github.com/nicklockwood/SwiftFormat"
fi

Таким образом, при каждом билде все файлы будут форматироваться автоматически. Но этот подход имеет свои минусы, если вы работаете в команде. Так как если SwiftFormat установлен у всех разной версии, то есть вероятность того, что он будет форматировать по разному.

Заключение

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

Поделиться
Отправить
Запинить
5 мес   tutorial