Clever Geek Handbook

Kotlinプロジェクトでコードスタイルのktlintプラグインを使用する。バックエンド開発者向けのクイックガイド

私はEPAMのJava / Kotlin開発者です。





最初の記事で、私は自分のプロジェクトであるBrain-Upについて話しました。この記事では、Kotlinプロジェクト用にktlintプラグインをセットアップした経験を共有したいと思います。





このプラグインは、プロジェクト全体で一貫したコードスタイルを確保するのに役立ちます。これは、JetBrainsの公式のKotlinコードフォーマットガイドラインに基づいています。このツールを使用すると、コードを確認するだけでなく、フォーマットすることもできます。





ktlintをセットアップしている間、情報と説明を探していましたが、レビューではこのプラグインの構成トピックにほとんど注意が払われていないようで、表示された質問への回答は明確ではありませんでした。 





したがって、私は自分の経験を共有することにしました。誰かがプロジェクトに接続するためのステップバイステップの説明が役立つことを願っています。この例は、Kotlin 1.4、gradle6.0のプロジェクトに関連しています。 





＃1。プラグインごとにbuild.gradleに依存関係を追加します

dependencies {    
    ktlint "com.pinterest:ktlint:0.38.0"
}

＃2。Gradleタスクの追加 `ktlintFormat`

   , ..  , / - , . 





task ktlintFormat(type: JavaExec, group: "formatting") 
{
    description = "Fix Kotlin code style deviations."    
    classpath = configurations.ktlint    
    main = "com.pinterest.ktlint.Main"    
    args "-F", "src/*/.kt"
}

#3. gradle `ktlint` 

project.task("ktlint", type: JavaExec) {    
    group = "verification"    
    description = "Runs ktlint."    
    main = "com.pinterest.ktlint.Main"    
    classpath = project.configurations.ktlint    
    args = [            
        "--reporter=plain",            
        "--reporter=checkstyle,output=${project.buildDir}/reports/ktlint/ktlint-checkstyle-report.xml",            
        "src/*/.kt"    ]
}

#4. `ktlint` 

compileKotlin.dependsOn ktlint

.  , ,  .     . 





  ,   , ,  . 





.





#5. Idea

File -> Settings -> Code Style -> Kotlin.





#6.

.





 Ctrl+Alt+L,   Idea  . ,  Idea, . 





.





 Idea     ―   ktlintFormat —  .





#7.

-   , ,     .editorconfig



. 





,  . , , ,  ,   Ctrl+Alt+L 



    ktlintFormat 



 , . 





[*.{kt,kts}]
disabled_rules = import-ordering

   build.gradle  . 2- , . 





, , / code style Kotlin , —  , :  , , . 





, , Open Source Brain-up,     ,  . 





       Sonar Cloud Kotlin ,     , .  





! 







More articles:


All Articles