Repolode
Enviar
codespell-project

codespell-project/codespell

Ferramenta de linha de comando que encontra e corrige erros ortográficos comuns em código-fonte e arquivos de texto usando um dicionário selecionado de erros frequentes.

Ver no GitHub
Estrelas
2,432
Forks
536
Issues abertas
265
Último commit
há 12 horas

O que é?

codespell verifica arquivos em busca de uma lista selecionada de erros ortográficos comuns, em vez de validar palavras com base em um dicionário completo. Isso reduz falsos positivos quando o código usa termos específicos, sem deixar de detectar erros como "adn" no lugar de "and". A ferramenta foi projetada principalmente para código-fonte e ignora sequências de escape com barra invertida, mas funciona com qualquer arquivo de texto.

Por padrão, ela funciona em modo de simulação e apenas informa os erros encontrados. Com a flag -w, grava as correções sugeridas; no modo interativo, você pode revisar cada alteração. É possível ignorar palavras usando um arquivo de exclusões, listas passadas pela linha de comando ou comentários no código. As configurações podem ser armazenadas em setup.cfg, .codespellrc ou pyproject.toml.

O projeto inclui vários dicionários derivados de uma lista da Wikipedia de erros ortográficos comuns, e os usuários também podem fornecer os próprios dicionários. A instalação é feita com pip, é necessário ter Python 3.9 ou mais recente, e o projeto inclui um hook de pre-commit.

Recursos principais

  • 01Verifica arquivos usando uma lista selecionada de erros ortográficos comuns, em vez de um dicionário completo.
  • 02Pode aplicar as correções sugeridas automaticamente ou de forma interativa com -w e -i.
  • 03Ignora falsos positivos usando listas de palavras, flags de linha de comando ou comentários no código.
  • 04Lê as configurações de setup.cfg, .codespellrc ou pyproject.toml.
  • 05Funciona como hook de pre-commit e pode fazer execuções de CI falharem quando as correções são gravadas.

Casos de uso

  • Detectar erros em comentários, identificadores e documentação do código-fonte durante o desenvolvimento.
  • Executar verificações ortográficas em um pipeline de CI ou hook de pre-commit.
  • Corrigir erros em uma base de código existente de grande porte com revisões interativas.

Início rápido

  1. 1

    Instale o codespell do PyPI com pip

    pip install codespell
  2. 2

    Execute o codespell no diretório atual

    codespell

Antes de usar

  • É licenciado sob a GPL-2.0, uma licença copyleft que pode restringir a forma de distribuir código derivado.
  • Ele detecta apenas erros ortográficos comuns presentes em seu dicionário, portanto não encontrará erros incomuns.

Tópicos

#spell-checking#linting#command-line#developer-tools#python#code-quality#pre-commit

Perguntas frequentes

O que é codespell?
Ferramenta de linha de comando que encontra e corrige erros ortográficos comuns em código-fonte e arquivos de texto usando um dicionário selecionado de erros frequentes. codespell verifica arquivos em busca de uma lista selecionada de erros ortográficos comuns, em vez de validar palavras com base em um dicionário completo. Isso reduz falsos positivos quando o código usa termos específicos, sem deixar de detectar erros como "adn" no lugar de "and". A ferramenta foi projetada principalmente para código-fonte e ignora sequências de escape com barra invertida, mas funciona com qualquer arquivo de texto.
codespell é gratuito? Qual é a licença?
codespell é open source sob a licença GPL-2.0. Confira os termos da licença antes de usá-lo em produtos comerciais.
codespell ainda é mantido?
Manutenção ativa. O último commit de codespell foi em 6 de nov. de 2026.
Para que posso usar codespell?
Detectar erros em comentários, identificadores e documentação do código-fonte durante o desenvolvimento. Executar verificações ortográficas em um pipeline de CI ou hook de pre-commit. Corrigir erros em uma base de código existente de grande porte com revisões interativas.
Como instalar codespell?
Instale o codespell do PyPI com pip: pip install codespell Execute o codespell no diretório atual: codespell
Onde consigo codespell?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/codespell-project/codespell

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

Projetos relacionados