Repolode
nicklockwood

nicklockwood/SwiftFormat

Ferramenta de linha de comando e extensão do Xcode que reformata código Swift automaticamente para manter um estilo consistente.

Estrelas
8,954
Forks
729
Issues abertas
289
Último commit
há 6 horas

O que é?

SwiftFormat é uma biblioteca de código e uma ferramenta de linha de comando para reformatar código Swift no macOS, Linux ou Windows. Além de ajustar espaços em branco, ela pode inserir ou remover `self` implícito, eliminar parênteses redundantes e corrigir muitos outros desvios das convenções idiomáticas do Swift.

A ferramenta reduz o custo de manter um estilo de código compartilhado pela equipe, aplicando regras automaticamente em vez de depender de revisão manual. O comportamento da formatação é controlado por mais de 150 regras e um conjunto de opções, configuráveis pela linha de comando, em um arquivo `.swiftformat` ou diretamente no código-fonte com diretivas `swiftformat` em comentários. O modo lint aponta violações sem modificar os arquivos, sendo adequado para verificações de CI.

Ela pode ser executada pelo terminal, como plugin do Swift Package Manager, em uma etapa de build do Xcode ou por meio de uma Source Editor Extension. A instalação pode ser feita via Homebrew, Mint, Nix, Docker ou GitHub Actions.

Recursos principais

  • 01Insere ou remove `self` implícito e elimina parênteses redundantes.
  • 02Oferece mais de 150 regras de formatação, que podem ser ativadas ou desativadas individualmente.
  • 03Lê as configurações do projeto em um arquivo `.swiftformat`, com substituições específicas por diretório.
  • 04Oferece um modo lint que aponta violações sem alterar os arquivos.
  • 05Integra-se ao Xcode, ao Swift Package Manager, a hooks de pre-commit do Git e ao GitHub Actions.

Casos de uso

  • Manter um estilo de código Swift compartilhado nos repositórios de uma equipe.
  • Executar verificações de formatação no CI para impedir pull requests com código sem formatação.
  • Formatar arquivos Swift automaticamente ao salvar ou ao fazer commit.
  • Aplicar formatação ao código Swift de um projeto do Xcode durante o build.

Início rápido

  1. 1

    Instale a ferramenta de linha de comando pelo Homebrew

    brew install swiftformat
  2. 2

    Formate os arquivos Swift no diretório atual

    swiftformat .

Antes de usar

  • Executar swiftformat . sobrescreve os arquivos Swift no próprio local. Portanto, faça commit das alterações no controle de versão antes.

Em coleções

Tópicos

Perguntas frequentes

O que é SwiftFormat?
Ferramenta de linha de comando e extensão do Xcode que reformata código Swift automaticamente para manter um estilo consistente. SwiftFormat é uma biblioteca de código e uma ferramenta de linha de comando para reformatar código Swift no macOS, Linux ou Windows. Além de ajustar espaços em branco, ela pode inserir ou remover `self` implícito, eliminar parênteses redundantes e corrigir muitos outros desvios das convenções idiomáticas do Swift.
SwiftFormat é gratuito? Qual é a licença?
SwiftFormat é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.
SwiftFormat ainda é mantido?
Manutenção ativa. O último commit de SwiftFormat foi em 7 de nov. de 2026.
Para que posso usar SwiftFormat?
Manter um estilo de código Swift compartilhado nos repositórios de uma equipe. Executar verificações de formatação no CI para impedir pull requests com código sem formatação. Formatar arquivos Swift automaticamente ao salvar ou ao fazer commit. Aplicar formatação ao código Swift de um projeto do Xcode durante o build.
Como instalar SwiftFormat?
Instale a ferramenta de linha de comando pelo Homebrew: brew install swiftformat Formate os arquivos Swift no diretório atual: swiftformat .
Onde consigo SwiftFormat?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/nicklockwood/SwiftFormat

Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.

Projetos relacionados