Repolode
Enviar
JLLeitschuh

JLLeitschuh/ktlint-gradle

Plugin do Gradle que integra o ktlint para adicionar tarefas de verificação e formatação automática a projetos Kotlin.

Ver no GitHub
Estrelas
1,723
Forks
185
Issues abertas
126
Último commit
há 10 horas

O que é?

ktlint-gradle é um plugin do Gradle que integra o linter e formatador Kotlin ktlint, adicionando tarefas prontas ao build do Gradle para verificar e corrigir o estilo do código sem configuração manual. Ele é ativado apenas em projetos que aplicam um plugin Kotlin, portanto, atua sobre código Kotlin, não sobre arquivos arbitrários.

O plugin cria tarefas de verificação e formatação para cada source set, além das tarefas ktlintCheck e ktlintFormat para todo o projeto, e também cobre arquivos de script Kotlin. Ele oferece suporte aos plugins kotlin, kotlin-android, kotlin-multiplatform e Kotlin JS, e pode ser aplicado pelo bloco plugins, por um catálogo de versões ou pelo método apply legado.

A configuração abrange a versão do ktlint, arquivos baseline, reporters e rulesets personalizados, filtros de arquivos e o tamanho do heap dos workers. O plugin também pode instalar hooks git pre-commit que executam ktlint check ou format nos arquivos preparados para commit.

Recursos principais

  • 01Adiciona as tarefas ktlintCheck e ktlintFormat para todos os source sets e scripts Kotlin.
  • 02Oferece suporte a projetos kotlin, kotlin-android, kotlin-multiplatform e Kotlin JS.
  • 03Permite usar um arquivo baseline para suprimir violações de lint existentes.
  • 04Oferece suporte a reporters e rulesets personalizados do ktlint.
  • 05Pode instalar hooks Git pre-commit para verificar ou formatar arquivos preparados para commit.

Casos de uso

  • Manter um estilo de código Kotlin consistente em builds Gradle para Android ou JVM.
  • Adicionar verificações de lint a um projeto Kotlin multiplataforma sem alterar manualmente a lógica do build.
  • Introduzir lint gradualmente em uma base de código legada usando um baseline.
  • Executar verificações de estilo no CI por meio da tarefa ktlintCheck.

Início rápido

  1. 1

    Adicione o plugin ao bloco plugins do script de build (defina a versão como a versão atual).

  2. 2

    Adicione mavenCentral() a repositories para que o KtLint possa ser baixado.

  3. 3

    Execute as tarefas ktlint do Gradle no seu projeto.

Antes de usar

  • O plugin só é ativado em projetos que aplicam um plugin Kotlin compatível.
  • É necessário usar Gradle 7.4 ou superior e Kotlin 1.4 ou superior.

Tópicos

#kotlin#gradle#gradle-plugin#linting#code-formatting#ktlint#gradle-script-kotlin#hacktoberfest

Perguntas frequentes

O que é ktlint-gradle?
Plugin do Gradle que integra o ktlint para adicionar tarefas de verificação e formatação automática a projetos Kotlin. ktlint-gradle é um plugin do Gradle que integra o linter e formatador Kotlin ktlint, adicionando tarefas prontas ao build do Gradle para verificar e corrigir o estilo do código sem configuração manual. Ele é ativado apenas em projetos que aplicam um plugin Kotlin, portanto, atua sobre código Kotlin, não sobre arquivos arbitrários.
ktlint-gradle é gratuito? Qual é a licença?
ktlint-gradle é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.
ktlint-gradle ainda é mantido?
Manutenção ativa. O último commit de ktlint-gradle foi em 6 de nov. de 2026.
Para que posso usar ktlint-gradle?
Manter um estilo de código Kotlin consistente em builds Gradle para Android ou JVM. Adicionar verificações de lint a um projeto Kotlin multiplataforma sem alterar manualmente a lógica do build. Introduzir lint gradualmente em uma base de código legada usando um baseline. Executar verificações de estilo no CI por meio da tarefa ktlintCheck.
Como instalar ktlint-gradle?
Adicione o plugin ao bloco plugins do script de build (defina a versão como a versão atual). Adicione mavenCentral() a repositories para que o KtLint possa ser baixado. Execute as tarefas ktlint do Gradle no seu projeto.
Onde consigo ktlint-gradle?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/JLLeitschuh/ktlint-gradle

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

Projetos relacionados