SwiftFormat для Swift: полное руководство с примерами

Добро пожаловать на PythonLib! Сегодня мы разберём одну из самых полезных утилит для Swift-разработчиков — SwiftFormat. Это мощный инструмент для автоматического форматирования кода, который поможет вам поддерживать единый стиль в проекте, экономить время на code review и избегать типичных ошибок, связанных с расстановкой пробелов, скобок и отступов.

1. Что это и зачем нужна

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

Зачем это нужно? Во-первых, единообразие кода. Когда над проектом работает несколько разработчиков, каждый пишет в своём стиле. SwiftFormat приводит всё к общему знаменателю, что упрощает чтение и поддержку кода. Во-вторых, экономия времени: вместо того чтобы вручную править отступы или переносы строк, вы запускаете одну команду и получаете идеально отформатированный код. В-третьих, интеграция в CI/CD: вы можете добавить форматирование в пайплайн, чтобы гарантировать, что каждый коммит соответствует стандартам.

SwiftFormat поддерживает практически все версии Swift (от 4.0 до 5.x) и активно развивается сообществом. Он может работать как через командную строку, так и через Xcode (с помощью плагинов или встроенных скриптов).

2. Установка

SwiftFormat распространяется через несколько менеджеров пакетов. Вот основные способы установки:

Через Homebrew (рекомендуется для macOS)

brew install swiftformat

Через CocoaPods (для проектов iOS/macOS)

# Добавьте в Podfile:
pod 'SwiftFormat'

# Затем выполните:
pod install

Через Swift Package Manager (SPM)

// Добавьте в Package.swift:
dependencies: [
    .package(url: "https://github.com/nicklockwood/SwiftFormat.git", from: "0.53.0")
]

Через Mint

mint install nicklockwood/SwiftFormat

После установки проверьте, что всё работает:

swiftformat --version

3. Быстрый старт — минимальный рабочий пример

Допустим, у вас есть файл example.swift с таким содержимым:

func   hello(name:String)->String{
return "Hello, \(name)!"
}

Запустите SwiftFormat:

swiftformat example.swift

После выполнения файл будет выглядеть так:

func hello(name: String) -> String {
    return "Hello, \(name)!"
}

Как видите, лишние пробелы удалены, добавлен пробел перед двоеточием, фигурная скобка перенесена на новую строку, и появился отступ. Всё автоматически!

Если нужно отформатировать всю папку с проектом:

swiftformat . --recursive

4. Основные методы/функции/классы

SwiftFormat предоставляет множество правил (rules) и опций для тонкой настройки. Рассмотрим 8 ключевых возможностей, которые вы будете использовать чаще всего.

swiftformat --indent spaces 4 example.swift

swiftformat --allman true example.swift

if true {
    print("Hello")
}

if true
{
    print("Hello")
}

swiftformat --trailingcommas true example.swift

let array = [
    "one",
    "two"
]

let array = [
    "one",
    "two",
]

swiftformat --stripheaders true example.swift

//
//  ViewController.swift
//  MyApp
//
//  Created by User on 01.01.2024.
//

import UIKit

import UIKit

swiftformat --self remove example.swift

class MyClass {
    var value = 0
    func update() {
        self.value = 10
    }
}

class MyClass {
    var value = 0
    func update() {
        value = 10
    }
}

swiftformat --linebreaks lf example.swift

swiftformat --semicolons never example.swift

let a = 1; let b = 2;

let a = 1
let b = 2

swiftformat --maxwidth 80 example.swift

5. Реальный практический пример (100-200 строк кода)

Представьте, что вы получили от коллеги файл UserManager.swift в ужасном состоянии. Вот его исходный код:

import Foundation
class UserManager{
var users:[String]=[]
func addUser(name:String){
users.append(name)
}
func   printUsers(){
for user in users{
print("User: \(user)")
}
}
func findUser(name:String)->String?{
for user in users{
if user==name{
return user
}
}
return nil
}
}

Запустим SwiftFormat с оптимальными настройками для типичного iOS-проекта:

swiftformat UserManager.swift \
    --indent spaces 4 \
    --allman false \
    --trailingcommas true \
    --self remove \
    --semicolons never \
    --maxwidth 100 \
    --linebreaks lf

После форматирования получаем:

import Foundation

class UserManager {
    var users: [String] = []

    func addUser(name: String) {
        users.append(name)
    }

    func printUsers() {
        for user in users {
            print("User: \(user)")
        }
    }

    func findUser(name: String) -> String? {
        for user in users {
            if user == name {
                return user
            }
        }
        return nil
    }
}

Что изменилось:

• Добавлены пробелы после двоеточий в типах (name: String).
• Пробелы вокруг операторов (==, +=).
• Отступы стали единообразными (4 пробела).
• Фигурные скобки открываются на той же строке (стиль K&R).
• Удалён избыточный self (хотя его и не было).

• Также в библиотеке

  OpenCV для C++: полное руководство с примерами Работа с ZIP/архивами в C# (.NET): полное руководство Gson для Java: полное руководство с примерами Proptest для Rust: полное руководство с примерами PDF генерация в Rust: обзор библиотек и инструментов для создания PDF-документов