Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

What is the use of com.diffplug.spotless plugin in Android Studio?

I am working with Jetpack Compose and I came across "com.diffplug.spotless" plugin in the app's build.gradle file of many examples, but I am not sure if I need it in my project. Can anyone explain the purpose of using it in the Jetpack compose projects?

''' apply plugin: "com.diffplug.spotless" '''

like image 676
Sweta Jain Avatar asked Dec 05 '20 18:12

Sweta Jain


People also ask

What is spotless plugin?

Spotless plugin for Gradle. Keep your code Spotless with Gradle. Spotless is a general-purpose formatting plugin used by 4,000 projects on GitHub (August 2020). It is completely à la carte, but also includes powerful "batteries-included" if you opt-in.

What is spotless in Android?

Spotless is a pluggable formatter for Gradle and Android. In our current configuration, Spotless includes the Google Java Format plug-in which formats all our Java code using the Google Java coding style guidelines.

What is Maven spotless plugin?

Spotless: Keep your code spotless with Maven. Spotless is a general-purpose formatting plugin used by 4,000 projects on GitHub (August 2020).

What is Android plugin application?

apply plugin: 'android' specifies that It's an Android project but it does not specify Its an Application or Library project. To make life easier you can tell gradle the type of project and indicate which plugin should be used. I recommend to use apply plugin: 'com. android.


1 Answers

Spotless: Keep your code spotless with Gradle

While working, Many a times you will get formatting issues at the stage of every commit like removing empty lines, cutting white spaces correct, indentation and other minor formatting mistakes. Using tool/plugin called “Spotless” will reduce time in addressing code review comments.

Spotless provides support for a variety of languages. Spotless consists of a list of format and each format has:-

1.a target (the files to format), which you set with target. 2.a list of FormatterStep, which are just String -> String functions, such as replace, replaceRegex, trimTrailingWhitespace, custom, prettier, eclipseWtp, licenseHeader etc.

To start integration with Gradle:-

1.Add the following dependency to your build.gradle file classpath(“com.diffplug.spotless:spotless-plugin-gradle:$spotlessVersion”)

2.Apply the following plugin apply plugin: ‘com.diffplug.gradle.spotless’

3.Applying spotless to your gradle file in Android Java source

spotless {
java {
  // ...
  target '**/*.java'
  // ...
}

}

Note:- Be sure to add target '**/*.java' otherwise spotless will not detect Java code inside Android modules.

For more detail you can refer this link : 1

like image 134
Jyoti Avatar answered Oct 19 '22 05:10

Jyoti