Sobre o projeto
SwiftFormat é uma biblioteca de código e ferramenta de linha de comando para reformatar código Swift em macOS, Linux ou Windows. Além do simples ajuste de espaços em branco, pode inserir ou remover `self` implícito, remover parênteses redundantes e corrigir muitos outros desvios dos idiomas padrão do Swift.
A motivação declarada do projeto é que concordar com um estilo de codificação comum ajuda na colaboração, mas aplicá-lo manualmente é tedioso e propenso a erros. Um formatador automatizado permite que as equipes se concentrem no comportamento do código, em vez da apresentação.
Formas de usá-lo:
- Ferramenta de linha de comando, executada manualmente ou como parte de um fluxo de trabalho
- Extensão do Editor de Código Fonte do Xcode, invocada via menu Editor > SwiftFormat
- Fase de build do Xcode, executada em cada build
- Hook de pré-commit do Git, formatando arquivos alterados antes do commit
- Plugin de comando do Swift Package Manager (Swift 5.6+)
- Integrações para VSCode (via Run on Save), Sublime Text e Nova
- GitHub Actions, Danger em CI, Bazel, Docker e AppleScript
As opções de instalação incluem Homebrew (`brew install swiftformat`), Mint, Nix/nixpkgs, CocoaPods, um artifactbundle binário em Package.swift, ou compilação manual com `swift build -c release`. A extensão do Xcode está disponível como cask do Homebrew ou nas Releases do GitHub.
O uso básico é `swiftformat .` para formatar arquivos Swift no diretório atual. O README avisa que isso sobrescreve arquivos no local, então os usuários devem commitar as alterações primeiro; `--infer-options` pode sugerir configurações que correspondem ao estilo de um projeto existente. O pipe de entrada/saída padrão é suportado, incluindo `--stdin-path` para fornecer contexto de localização do arquivo.
A configuração cobre opções, regras, versão do Swift, um arquivo de configuração `.swiftformat`, globs, modo de linting, códigos de erro, cache, cabeçalhos de arquivo e formatação Markdown. O README também inclui um FAQ, problemas conhecidos, um pote de gorjetas e créditos. O projeto é licenciado sob MIT.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.