Skip to content

Latest commit

 

History

History
19 lines (12 loc) · 945 Bytes

StaticAnalysis.md

File metadata and controls

19 lines (12 loc) · 945 Bytes

Static Analysis

This project leverages static analysis to ensure that the codebase meets certain standards that can be verified through automation.

Ktlint

Ktlint is a static analysis tool from Pinterest that prevents bike shedding when it comes to code formatting. It also comes with a Gradle task to automatically format your entire codebase, if it can. The benefit of a tool like this is to ensure everyone on the team will have code formatted the same way, and there's no debating around white spaces, indentation, imports, etc.

We use the JLLeitschuh Ktlint Gradle plugin in this project. You can find the setup in this Gradle file.

The following Gradle commands can be helpful:

// Will format the codebase
./gradlew ktlintFormat

// Will check if everything is formatted correctly
./gradlew ktlintCheck