JLLeitschuh/ktlint-gradle

어떤 프로젝트인가요?

핵심 기능

• 01모든 소스 세트와 Kotlin 스크립트에 ktlintCheck 및 ktlintFormat 작업을 추가합니다.
• 02kotlin, kotlin-android, kotlin-multiplatform 및 Kotlin JS 프로젝트를 지원합니다.
• 03베이스라인 파일로 기존 린트 위반을 무시할 수 있습니다.
• 04사용자 지정 리포터와 ktlint 규칙 세트를 지원합니다.
• 05스테이징된 파일을 검사하거나 포맷하는 Git pre-commit 훅을 설치할 수 있습니다.

활용 사례

• Android 또는 JVM Gradle 빌드에서 일관된 Kotlin 코드 스타일을 적용합니다.
• 빌드 로직을 직접 수정하지 않고 멀티플랫폼 Kotlin 프로젝트에 린트 검사를 추가합니다.
• 베이스라인을 사용해 레거시 코드베이스에 린트를 점진적으로 도입합니다.
• ktlintCheck 작업을 통해 CI에서 스타일 검사를 실행합니다.

빠른 시작

1. 1

   빌드 스크립트의 plugins 블록에 플러그인을 추가합니다(버전은 최신 릴리스로 설정).

2. 2

   KtLint를 다운로드할 수 있도록 repositories에 mavenCentral()을 추가합니다.

3. 3

   프로젝트에서 Gradle ktlint 작업을 실행합니다.

사용 전 알아둘 점

• !이 플러그인은 지원되는 Kotlin 플러그인을 적용한 프로젝트에서만 활성화됩니다.
• !Gradle 7.4 이상과 Kotlin 1.4 이상이 필요합니다.

토픽

자주 묻는 질문

ktlint-gradle은(는) 무엇인가요?

Kotlin 프로젝트에 검사 및 자동 포맷 작업을 추가하는 ktlint용 Gradle 플러그인입니다. ktlint-gradle은 ktlint Kotlin 린터와 포맷터를 감싸는 Gradle 플러그인으로, Gradle 빌드에 바로 사용할 수 있는 작업을 추가해 별도 설정 없이 코드 스타일을 검사하고 수정할 수 있게 합니다. Kotlin 플러그인을 적용한 프로젝트에서만 활성화되므로 임의의 파일이 아닌 Kotlin 코드를 대상으로 합니다.

ktlint-gradle은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?

ktlint-gradle은(는) MIT 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.

ktlint-gradle은(는) 아직 유지보수되고 있나요?

활발히 유지보수 중. ktlint-gradle의 마지막 커밋은 2026년 11월 6일입니다.

ktlint-gradle은(는) 어디에 사용할 수 있나요?

Android 또는 JVM Gradle 빌드에서 일관된 Kotlin 코드 스타일을 적용합니다. 빌드 로직을 직접 수정하지 않고 멀티플랫폼 Kotlin 프로젝트에 린트 검사를 추가합니다. 베이스라인을 사용해 레거시 코드베이스에 린트를 점진적으로 도입합니다. ktlintCheck 작업을 통해 CI에서 스타일 검사를 실행합니다.

ktlint-gradle는 어떻게 설치하나요?

빌드 스크립트의 plugins 블록에 플러그인을 추가합니다(버전은 최신 릴리스로 설정). KtLint를 다운로드할 수 있도록 repositories에 mavenCentral()을 추가합니다. 프로젝트에서 Gradle ktlint 작업을 실행합니다.

ktlint-gradle은(는) 어디서 받을 수 있나요?

소스 코드와 설치 방법은 GitHub에 있습니다: https://github.com/JLLeitschuh/ktlint-gradle