SBT support
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 38/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- build-system, documentation
Research direction
Start with the root README, settings.gradle around lines 47-49, and the linked sbt-spotless project. Review Gradle's Scala plugin guidance and the existing build inclusion pattern; done means the SBT plugin is included as plugin-sbt, builds through Gradle for publishing, and is linked from the README.
Written by the indexing model from the issue text.
Description
@moznion has made a spotless plugin for the sbt buildsystem. I bumped into it the other day, and I began a conversation with the author about the option of upstreaming it https://github.com/moznion/sbt-spotless/issues/22
We should definitely let our users know that it exists by linking to it in the root README. I think it would also be good to upstream it into the spotless repo. The advantage of that is that when we add features / fix bugs in various steps, it would be easier for sbt users to know which versions to use. For spotless users that don't use sbt, it helps to have more eyes on the various steps - you never know who might fix a bug or bring a feature.
The downside of having more build steps is that our build gets bigger and slower. Right now, we have the ability to exclude the maven plugin, we could always change it to where all the plugins are excluded, and you have to manually set SPOTLESS_INCLUDE_GRADLE or SPOTLESS_INCLUDE_SBT, so that developers working on the build system they care about don't get bogged down by the larger scope.
The main challenge to upstreaming @moznion's work is just
- a PR with a folder
plugin-sbt - add the folder to
settings.gradle - get it building via gradle, so that our publishing works https://docs.gradle.org/current/userguide/scala_plugin.html
- Dominant language
- Java
- Stars
- 5.7k
- Forks
- 560
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 43
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from diffplug/spotless
-
Difficulty 5/5 Over a week Newbie friendliness 15/100
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
-
Difficulty 3/5 1-2 days Newbie friendliness 66/100
-
Difficulty 3/5 1-2 days Newbie friendliness 68/100
-
Difficulty 4/5 3-5 days Newbie friendliness 52/100
All issues in diffplug/spotless
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
elastic/gradle-plugins#157 ·
-
enhancement Tools
Difficulty 1/5 Under an hour Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
apache/rocketmq-dashboard#5008 ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
DETECT_PARAMETER_NAMES=false silently disables @ConstructorProperties-based Creator detection too Open
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
FasterXML/jackson-databind#6229 ·