cloudfoundry / cloudfoundry/cf-java-client

Which version of "googleJavaFormat" to use?

Aperta
#1,316 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Java
Stelle
334
Fork
319
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

Currently we are using spotless-maven-plugin:2.44.4 together with googleJavaFormat 1.19.1 to format the java sources. This does not work in JDK8 but all later versions.
With JDK25, spotless-maven-plugin:3.0.0 and googleJavaFormat 1.27.0 are the minimal versions. Older versions will simply fail when ./mvnw spotless:check is executed.
This version does require JDK17 or higher.
I see three options to continue:
a) Stick with 2.44.4 and 1.19.1 and do not run spotless in JDK25 and later.
b) Upgrade to 3.00 and 1.27.0 and do not run spotless in JDK16 and earlier.
c) Choose the spotless version depending on the JDK version.

a) Is least effort for existing developers, but makes onboarding for new contributors more complicated.
b) Is least effort for new developers, might be a problem if someone is required to use a JDK before 17.
c) At the moment, the differences in the formatters (mostly indenting in comments) have no impact on existing code. That might change with added documentation in the future, resulting in formatters changing back and forth.

My prefered solution is b). Are there any showstoppers?
Alternatively we could go for c) until we have see a problem and switch to b) then.

What are your thoughts?

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia esaminando la configurazione attuale di spotless-maven-plugin e googleJavaFormat, quindi esegui ./mvnw spotless:check con le versioni JDK pertinenti. Il lavoro è completato quando è stata scelta e documentata una strategia per le versioni supportate, la configurazione è stata aggiornata se necessario e si è verificato che i controlli di formattazione funzionino per l’intervallo di JDK previsto.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
java
Ambito
build-system
Tipo di issue
Refactoring
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.