SwiftLint pour Swift : guide complet avec exemples

1. Qu'est-ce que SwiftLint et pourquoi l'utiliser ?

SwiftLint est un outil d'analyse statique de code (linter) pour le langage de programmation Swift. Il vérifie automatiquement votre code par rapport à un ensemble de règles basées sur le Swift Style Guide (recommandations de style de code d'Apple) et les meilleures pratiques de la communauté. Imaginez un « relecteur intelligent » qui travaille en temps réel directement dans votre éditeur de code, en mettant en évidence les problèmes potentiels, les violations de formatage et les erreurs logiques.

Pourquoi en avez-vous besoin ? Dans les grands projets où des dizaines de développeurs travaillent sur la même base de code, maintenir un style de code cohérent devient crucial. SwiftLint résout ce problème automatiquement. Il vous aide non seulement à écrire un code plus propre et plus lisible, mais aussi à prévenir l'apparition de nombreux bugs courants dès les premières étapes. Par exemple, il peut vous avertir de l'utilisation d'API obsolètes (deprecated), de fonctions trop complexes difficiles à tester, ou d'un mauvais formatage des indentations.

L'intégration de SwiftLint dans votre processus de développement (CI/CD) permet de rejeter automatiquement les Pull Requests qui ne respectent pas les normes de qualité, ce qui fait gagner du temps lors des revues de code et améliore la stabilité globale du projet. C'est un outil indispensable pour toute équipe professionnelle de développeurs iOS/macOS.

2. Installation

SwiftLint peut être installé de plusieurs façons. La méthode la plus populaire et recommandée est via Homebrew (le gestionnaire de paquets pour macOS).

Méthode 1 : Homebrew (Recommandée)

Ouvrez le terminal et exécutez la commande :

brew install swiftlint

Méthode 2 : CocoaPods

Si vous utilisez CocoaPods, ajoutez ceci à votre Podfile :

pod 'SwiftLint'

Ensuite, exécutez :

pod install

Méthode 3 : Swift Package Manager (SPM)

Ajoutez le paquet à votre Package.swift :

dependencies: [
    .package(url: "https://github.com/realm/SwiftLint.git", from: "0.54.0")
]

Méthode 4 : Mint

Si vous utilisez Mint :

mint install realm/SwiftLint

3. Démarrage rapide : exemple minimal fonctionnel

Après l'installation, le moyen le plus simple de vérifier le fonctionnement de SwiftLint est de l'exécuter depuis le terminal dans le dossier racine de votre projet.

1. Créez un nouveau fichier Swift example.swift avec du code « mauvais » :

// example.swift
import Foundation

let x = 10
let y = 20
func sum(a:Int, b:Int)->Int {
return a + b
}
print(sum(a: x, b: y))

2. Lancez le linter :

swiftlint lint --path example.swift

Vous verrez dans le terminal quelque chose comme :

example.swift:3:1: warning: Colon Violation (colon) - Colons should be next to the identifier when specifying a type and next to the key in dictionary literals.
example.swift:5:1: warning: Vertical Whitespace Violation (vertical_whitespace) - Limit vertical whitespace to a single empty line.
example.swift:5:16: warning: Colon Violation (colon) - Colons should be next to the identifier when specifying a type.
example.swift:6:1: warning: Return Arrow Whitespace Violation (return_arrow_whitespace) - File should have a single trailing newline.
...

SwiftLint a trouvé des violations de style. Corrigez maintenant le code en suivant les indications :

// example.swift (corrigé)
import Foundation

let x = 10
let y = 20

func sum(a: Int, b: Int) -> Int {
    return a + b
}

print(sum(a: x, b: y))

Relancez le linter — il n'y aura plus d'avertissements.

4