Шаблон GitHub для запуска проектов на Android и Kotlin с настроенным статическим анализом, CI через GitHub Actions и публикацией в Maven Central.
JLLeitschuh/ktlint-gradle
Плагин Gradle, который подключает ktlint и добавляет задачи проверки и автоформатирования Kotlin-проектов.
- Звёзды
- 1,724
- Форки
- 185
- Открытые issues
- 126
- Последний коммит
- вчера
Что это?
ktlint-gradle — это плагин Gradle, который подключает линтер и форматтер ktlint для Kotlin и добавляет готовые задачи в сборку Gradle. С их помощью можно проверять и исправлять стиль кода без ручной настройки. Плагин активируется только в проектах с подключённым Kotlin-плагином и работает именно с кодом на Kotlin, а не с произвольными файлами.
Плагин создаёт задачи проверки и форматирования для каждого source set, а также задачи ktlintCheck и ktlintFormat для всего проекта и обрабатывает файлы скриптов Kotlin. Он поддерживает плагины kotlin, kotlin-android, kotlin-multiplatform и Kotlin JS. Подключить его можно через блок plugins, version catalog или устаревший метод apply.
В настройках можно задать версию ktlint, baseline-файлы, собственные репортёры и наборы правил, фильтры файлов и размер heap для worker. Плагин также может устанавливать Git pre-commit hooks, запускающие проверку или форматирование ktlint для файлов, добавленных в индекс.
Ключевые возможности
- 01Добавляет задачи ktlintCheck и ktlintFormat для всех source set и скриптов Kotlin.
- 02Поддерживает проекты с плагинами kotlin, kotlin-android, kotlin-multiplatform и Kotlin JS.
- 03Позволяет использовать baseline-файл, чтобы игнорировать уже имеющиеся нарушения правил.
- 04Поддерживает собственные репортёры и наборы правил ktlint.
- 05Может устанавливать Git pre-commit hooks для проверки или форматирования файлов, добавленных в индекс.
Сценарии использования
- Поддержание единого стиля кода Kotlin в сборках Gradle для Android или JVM.
- Добавление линтинга в мультиплатформенный проект Kotlin без ручного изменения логики сборки.
- Постепенное внедрение линтинга в устаревшую кодовую базу с помощью baseline.
- Запуск проверок стиля в CI с помощью задачи ktlintCheck.
Быстрый старт
- 1
Добавьте плагин в блок plugins скрипта сборки (укажите текущую версию).
- 2
Добавьте mavenCentral() в repositories, чтобы можно было загрузить KtLint.
- 3
Запустите задачи Gradle ktlint в проекте.
Что важно знать
- Плагин активируется только в проектах, где применяется поддерживаемый плагин Kotlin.
- Требуются Gradle 7.4 или новее и Kotlin 1.4 или новее.
Темы
Частые вопросы
- Что такое ktlint-gradle?
- Плагин Gradle, который подключает ktlint и добавляет задачи проверки и автоформатирования Kotlin-проектов. ktlint-gradle — это плагин Gradle, который подключает линтер и форматтер ktlint для Kotlin и добавляет готовые задачи в сборку Gradle. С их помощью можно проверять и исправлять стиль кода без ручной настройки. Плагин активируется только в проектах с подключённым Kotlin-плагином и работает именно с кодом на Kotlin, а не с произвольными файлами.
- ktlint-gradle можно использовать бесплатно? Какая у него лицензия?
- ktlint-gradle распространяется с открытым исходным кодом под лицензией MIT. Перед использованием в коммерческих продуктах проверьте условия лицензии.
- ktlint-gradle всё ещё поддерживается?
- Активно поддерживается. Последний коммит в ktlint-gradle — 6 нояб. 2026 г..
- Для чего можно использовать ktlint-gradle?
- Поддержание единого стиля кода Kotlin в сборках Gradle для Android или JVM. Добавление линтинга в мультиплатформенный проект Kotlin без ручного изменения логики сборки. Постепенное внедрение линтинга в устаревшую кодовую базу с помощью baseline. Запуск проверок стиля в CI с помощью задачи ktlintCheck.
- Как установить ktlint-gradle?
- Добавьте плагин в блок plugins скрипта сборки (укажите текущую версию). Добавьте mavenCentral() в repositories, чтобы можно было загрузить KtLint. Запустите задачи Gradle ktlint в проекте.
- Где скачать ktlint-gradle?
- Исходный код и инструкции по установке — на GitHub: https://github.com/JLLeitschuh/ktlint-gradle
Описание создано ИИ на основе README проекта. Статистика GitHub обновляется ежедневно.
Похожие проекты
Язык программирования Kotlin, его компилятор, стандартная библиотека и инструменты сборки для кроссплатформенной разработки, создаваемые JetBrains.
Gradle-плагин для сборки fat/uber JAR, переноса пакетов, преобразования файлов и уменьшения размера сборки с помощью R8/ProGuard.
Плагин Gradle для публикации библиотек Java, Kotlin и Android с исходниками и javadoc в Maven Central и другие репозитории Nexus.
CLI-инструмент для запуска Python-линтеров и форматтеров, таких как ruff, isort, black, mypy и flake8, прямо в Jupyter Notebooks.
Собирайте оптимизированные Docker- и OCI-образы Java-приложений с помощью Maven или Gradle, не используя Docker daemon.