How to add ktlint and spotless to an Android project

For ktlint and spotless to work, your machine must have java installed as well as ktlint.

In Terminal, run the following line:

If you could not locate a Java runtime, run the following line to install java using brew.

Once you're done, run java --version again to make sure it registered.

In Terminal, run the following line:

Open the project level build.gradle.kts and make the following changes.

Add the Spotless dependency using code similar to that below.

Add the spotless plugin using code similar to that below

Finally, add the code below to the build.gradle.kts.

This code links the project to a Spotless gradle that sets the rules, which will be created in the next step.

If you are looking for the complete solution provided in our starter project, use the gist below.

Create a new file at the root of your project called spotless.gradle and paste in the code below.

Note that there is no .kts extension.

To learn more about what you can do with this gradle file, consult the guide below.

Press Sync Now to sync the Gradles.

In the Android Studio Terminal, run the following line:

If it is successful it will look like the image above.

If not, an error will appear similar to the image shown below.

To fix the invalid JAVA_HOME directory, please consult the tutorial below.

Follow our guide below to create a pre-commit git hook script that applies spotless and ktlint to guarantee code consistency across your app.

If you wish to add it to your project so that it is accessible to your team in a way that they recieve updates, follow the tutorial below.