Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md for android kotlin callouts #2438

Merged
merged 4 commits into from
Apr 7, 2025
+18 −7
Merged

Update README.md for android kotlin callouts #2438

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9bc2c67
Update README.md for android kotlin callouts
ColtonIdle Feb 26, 2025
60993fd
Fix the Android Kotlin warning and adjust its position.
nedtwigg Apr 7, 2025
fa3fd1e
Add the cool blockquote warning trick to the other Android spot.
nedtwigg Apr 7, 2025
d25f04d
Minor tweak.
nedtwigg Apr 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 18 additions & 7 deletions plugin-gradle/README.md
View file
Original file line number Diff line number Diff line change
@@ -207,13 +207,14 @@ spotless {

<a name="applying-to-android-java-source"></a>

The target is usually inferred automatically from the java source sets. However, Spotless cannot automatically detect [android](https://github.com/diffplug/spotless/issues/111) or [java-gradle-plugin](https://github.com/diffplug/spotless/issues/437) sources, but you can fix this easily:

```gradle
spotless {
java {
target 'src/*/java/**/*.java'
```
> [!WARNING]
> The target is usually inferred automatically from the java source sets. However, Spotless cannot automatically detect [android](https://github.com/diffplug/spotless/issues/111) or [java-gradle-plugin](https://github.com/diffplug/spotless/issues/437) sources, but you can fix this easily:
>
> ```gradle
> spotless {
> java {
> target 'src/*/java/**/*.java'
> ```

### removeUnusedImports

@@ -435,6 +436,7 @@ Groovy-Eclipse formatting errors/warnings lead per default to a build failure. T
- `com.diffplug.gradle.spotless.KotlinExtension` [javadoc](https://javadoc.io/doc/com.diffplug.spotless/spotless-plugin-gradle/7.0.2/com/diffplug/gradle/spotless/KotlinExtension.html), [code](https://github.com/diffplug/spotless/blob/main/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/KotlinExtension.java)
- `com.diffplug.gradle.spotless.KotlinGradleExtension` [javadoc](https://javadoc.io/doc/com.diffplug.spotless/spotless-plugin-gradle/7.0.2/com/diffplug/gradle/spotless/KotlinGradleExtension.html), [code](https://github.com/diffplug/spotless/blob/main/plugin-gradle/src/main/java/com/diffplug/gradle/spotless/KotlinGradleExtension.java)


```gradle
spotless { // if you are using build.gradle.kts, instead of 'spotless {' use:
// configure<com.diffplug.gradle.spotless.SpotlessExtension> {
@@ -453,6 +455,15 @@ spotless { // if you are using build.gradle.kts, instead of 'spotless {' use:
}
```

> [!WARNING]
> The target is usually inferred automatically from the java source sets. However, Spotless cannot automatically detect [android](https://github.com/diffplug/spotless/issues/111) or [java-gradle-plugin](https://github.com/diffplug/spotless/issues/437) sources, but you can fix this easily:
>
> ```gradle
> spotless {
> kotlin {
> target 'src/*/kotlin/**/*.kt', 'src/*/java/**/*.kt'
> ```

### ktfmt

[homepage](https://github.com/facebook/ktfmt). [changelog](https://github.com/facebook/ktfmt/releases).