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.

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

Conversation

ColtonIdle
Copy link
Contributor

Please DO NOT FORCE PUSH. Don't worry about messy history, it's easier to do code review if we can tell what happened after the review, and force pushing breaks that.

Please make sure that your PR allows edits from maintainers. Sometimes it's faster for us to just fix something than it is to describe how to fix it.

Allow edits from maintainers

After creating the PR, please add a commit that adds a bullet-point under the [Unreleased] section of CHANGES.md, plugin-gradle/CHANGES.md, and plugin-maven/CHANGES.md which includes:

  • a summary of the change
  • either
    • a link to the issue you are resolving (for small changes)
    • a link to the PR you just created (for big changes likely to have discussion)

If your change only affects a build plugin, and not the lib, then you only need to update the plugin-foo/CHANGES.md for that plugin.

If your change affects lib in an end-user-visible way (fixing a bug, updating a version) then you need to update CHANGES.md for both the lib and all build plugins. Users of a build plugin shouldn't have to refer to lib to see changes that affect them.

This makes it easier for the maintainers to quickly release your changes :)

@Goooler
Copy link
Member

Goooler commented Feb 27, 2025

Seems we can call out

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'
```

as well.

@ColtonIdle
Copy link
Contributor Author

Yeah I copied the code from there, but I suppose we can add a warning around it so that github md gives it that nice treatment. Also... does anyone know if both

target 'src//kotlin/**/.kt'
target 'src//java/**/.kt'

are needed? I'm assuming so... but idk.

@Goooler
Copy link
Member

Goooler commented Feb 28, 2025

Yeah, need to add both src/kotlin/**/.kt and src/java/**/.kt if you mixed the using of two source sets.

@ColtonIdle
Copy link
Contributor Author

Cool. FWIW. I thought src/kotlin/**/.kt was working for me (as my spotlessApply started to work reallllly fast)... but it wasn't actually working upon my files.

I started
#2437

which also led me to comment here
#111

All related to this readme PR 😄

If anyone can tell where I'm going wrong I'd appreciate it!

@nedtwigg
Copy link
Member

nedtwigg commented Apr 7, 2025

In your comments above...

  • src/kotlin/**/.kt (will not work)
  • src/kotlin/**/*.kt (might work)
  • src/*/kotlin/**/*.kt (what I would expect, but of course it depends on how your particular project is laid out)

But the real root of the problem is that each call to target wipes out all previous calls. In order to have two targets, you need to call target only once, but with two arguments. I fixed this in the commit I just pushed.

@nedtwigg nedtwigg merged commit 0fe8f9b into diffplug:main Apr 7, 2025
@ColtonIdle
Copy link
Contributor Author

Thank you for the additional fixes! Every time I add spotless to a project I'm always looking at different notes. Good to have an updated canonical example. Cheers @nedtwigg ! Next step... getting spotless to understand where the android src sets are automatically 🚂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants