diffplug / diffplug/spotless

more flexibility in keeping "sloppy" parts of existing license header

Offen
#1,611 4 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen
enhancement
Vorherrschende Sprache
Java
Sterne
5.6k
Forks
559
Ø Merge
1 T. 14 Std.
Gemergte PRs (30 T.)
43

Beschreibung

If you are submitting a **bug**, please include the following:

- [x] summary of problem
- [x] gradle or maven version
- [x] spotless version
- [ ] operating system and version
- [ ] copy-paste your full Spotless configuration block(s), and a link to a public git repo that reproduces the problem if possible
- [ ] copy-paste the full content of any console errors emitted by `gradlew spotless[Apply/Check] --stacktrace`

If you're just submitting a feature request or question, no need for the above.

* Spotless 6.16.0
* Gradle 8.0.1
* MacOS Ventura
```

spotless {
java {
licenseHeader 'SPDX-License-Identifier: Apache-2.0'
ignoreErrorForStep('LicenseHeaderStep')
}
}
```

1. Regex

Our large codebase has some variations in copyright specifically in terms of spaces between comment chars & the license text

So our `checkstyle` config (not merged, just trying to find a good tool to add this check since we migrated from maven) becomes
```






```

That seems good enough, so I'm wondering if I can use spotless instead, as it offers more functionality which we may use in future

Obviously we have have a preferred spacing (for auto fix) but want to tolerate additional spaces

I tried without the comments, but then all files fail the check

Interestingly I also wanted to only report warnings, and note that though multiple errors on a project will now be reported, in a multi module build, the build will terminate as that project build fails (unless --continue is used).

Finally, in the example above I'd need two license header steps, but this seems to not be allowed?

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne damit, die gezeigte Gradle-spotless-Konfiguration mit `gradlew spotlessCheck` und `gradlew spotlessApply` zu reproduzieren, und verfolge dann den Schritt `licenseHeader` sowie dessen Umgang mit vorhandenen Kommentarabständen. Als erledigt gilt die Aufgabe, wenn die bevorzugte Abstandsgestaltung weiterhin automatisch korrigiert werden kann, zusätzliche Leerzeichen jedoch toleriert werden, und die angeforderten mehreren License-Header-Schritte entweder unterstützt oder eindeutig behandelt werden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
java
Bereich
build-system, tooling
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.