diffplug / diffplug/spotless

SBT support

Ouverte
#688 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
enhancement
Langage dominant
Java
Étoiles
5.6k
Forks
559
Merge moyen
1 j 14 h
PR mergées (30 j)
43

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.

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

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par le README racine, settings.gradle autour des lignes 47-49 et le projet sbt-spotless lié. Examinez les recommandations de Gradle concernant le plugin Scala et le modèle existant d’inclusion dans le build ; c’est terminé lorsque le plugin SBT est inclus en tant que plugin-sbt, que le build s’effectue via Gradle pour la publication et qu’il est lié depuis le README.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
java, scala
Domaine
build-system, documentation
Type d'issue
Fonctionnalité
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
38/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.