[question] Is there a way to skip licenseHeader for legacy files while keeping other formatters active?

Aperta
#2,908 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
45/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
java
Ambito
build-system, tooling

Direzione di ricerca

Inizia con la configurazione di Maven Spotless e il delimitatore di licenseHeader mostrati nell’issue, quindi esamina come i passaggi di formattazione elencati vengono applicati ai file Java. Determina se licenseHeader può essere limitato ai nuovi file senza escludere gli altri passaggi; il lavoro è completato quando i nuovi file ricevono l’header, gli header esistenti rimangono invariati e tutti gli altri formatter continuano a essere eseguiti.

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

Descrizione

Environment:

  • Java
  • Spotless Maven Plugin

Background
Our project contains both new and legacy Java files:

  • New files contain only the new license header: 
    // New License Header
  • Legacy files contain multiple historical license headers, for example: 
    // New License Header

// Old License Header

Problem
When configuring Spotless with:

<licenseHeader>
    <file>${project.basedir}/tools/spotless/license-header.txt</file>
    <delimiter>package |import |module </delimiter>
</licenseHeader>

Spotless replaces all license headers in all files, including legacy files that should keep their original headers.

This causes two issues:

  1. Legacy files lose their historical license information
  2. If I exclude legacy files from licenseHeader, then other formatters (googleJavaFormat, eclipse, prettier, idea, tableTestFormatter, importOrder) will also stop applying to them

Expected Behavior

  • New files should receive the new license header
  • Legacy files should keep their existing headers, but still be formatted by other Spotless steps

Question
Is there a recommended way to configure Spotless so that:

  • licenseHeader applies only to new files
  • Other formatters still apply to all files
  • Legacy files are not modified by the license step
Lingua principale
Java
Stelle
5.7k
Fork
560
Merge medio
1g 13h
PR unite (30g)
43

Guida per i contributori

Apri la guida per i contributori

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.

Altre issue di diffplug/spotless

Tutte le issue di diffplug/spotless

Issue simili

Altre issue su Java

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.