diffplug / diffplug/spotless

SBT support

Đang mở
#688 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
enhancement
Ngôn ngữ chính
Java
Star
5.6k
Fork
559
Merge trung bình
1 ngày 14 giờ
Pull request đã merge (30 ngày)
43

Mô tả

@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.

https://github.com/diffplug/spotless/blob/74d964d22636e58e897ff298c6df996e3fac2b69/settings.gradle#L47-L49

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

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Bắt đầu với README gốc, settings.gradle quanh dòng 47-49 và dự án sbt-spotless được liên kết. Xem lại hướng dẫn của Gradle về plugin Scala và mẫu đưa vào build hiện có; được coi là hoàn tất khi plugin SBT được đưa vào dưới dạng plugin-sbt, được build thông qua Gradle để phát hành và được liên kết từ README.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
java, scala
Lĩnh vực
build-system, documentation
Loại issue
Tính năng
Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
38/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.