diffplug / diffplug/spotless

SBT support

オープン
#688 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
enhancement
主要言語
Java
スター
5.6k
フォーク
559
平均マージ
1日 14時間
マージ済み PR(30日)
43

説明

@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

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

ルートREADME、47〜49行付近のsettings.gradle、およびリンクされているsbt-spotlessプロジェクトから始めてください。GradleのScala pluginに関するガイダンスと、既存のbuildへの組み込みパターンを確認してください。完了条件は、SBT pluginがplugin-sbtとして組み込まれ、公開用にGradleを通じてビルドされ、READMEからリンクされていることです。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
java, scala
領域
build-system, documentation
issue の種類
機能追加
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
38/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。