Skip to content

fix(spotless/gradle-plugin): Fix StringIndexOutOfBoundsException in scenarios where copyright year is surrounded by whitespace #2973

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Maciej-Sitarz-IBM wants to merge 6 commits into
base: main
Choose a base branch
from
+25 −2
Open

fix(spotless/gradle-plugin): Fix StringIndexOutOfBoundsException in scenarios where copyright year is surrounded by whitespace #2973

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1194289
Add tests for years surrounded by whitespace in license header
Maciej-Sitarz-IBM Jun 9, 2026
a427333
Fix handling of years surrounded by whitespace in license header
Maciej-Sitarz-IBM Jun 12, 2026
4120d3a
Update CHANGES.md, plugin-gradle/CHANGES.md and plugin-maven/CHANGES.md
Maciej-Sitarz-IBM Jun 12, 2026
dbd462d
Add missing . in all CHANGES.md
Maciej-Sitarz-IBM Jun 12, 2026
787819d
Remove unneeded debug comments
Maciej-Sitarz-IBM Jun 12, 2026
b4d9ec0
Revert the changes to `assertUnchanged()` and use `assertTransform()`…
Maciej-Sitarz-IBM Jun 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
- `FenceStep.preserveWithin` now forwards lints from nested steps while still suppressing lints inside preserved blocks. ([#2962](https://github.com/diffplug/spotless/pull/2962))
- Support `ktfmt` 0.63 and use its new builder API for formatting options to better avoid future breaking changes.
- Parse standard git year output in LicenseHeaderStep. ([#2940](https://github.com/diffplug/spotless/issues/2940))
- Fix `StringIndexOutOfBoundsException` in scenarios where copyright year is surrounded by whitespace. ([#2973](https://github.com/diffplug/spotless/pull/2973))

### Changes
- Bump default `greclipse` version to latest `4.35` -> `4.39`. ([#2924](https://github.com/diffplug/spotless/pull/2924))
Expand Down
2 changes: 1 addition & 1 deletion lib/src/main/java/com/diffplug/spotless/generic/LicenseHeaderStep.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -380,7 +380,7 @@ private String calculateYearBySearching(String content) {
String secondYear = null;
if (updateYearWithLatest) {
secondYear = firstYear.equals(yearToday) ? null : yearToday;
} else {
} else if (yearMatcher.end() + 1 < content.length()) {
String contentWithSecondYear = content.substring(yearMatcher.end() + 1);
int endOfLine = contentWithSecondYear.indexOf('\n');
if (endOfLine != -1) {
Expand Down
1 change: 1 addition & 0 deletions plugin-gradle/CHANGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
- `toggleOffOn` no longer disables lint-only steps such as `forbidWildcardImports`. ([#2962](https://github.com/diffplug/spotless/pull/2962))
- Prevent build caches from interfering when executing under the `-PspotlessIdeHook` mode. ([#2365](https://github.com/diffplug/spotless/issues/2365))
- Parse standard git year output in LicenseHeaderStep. ([#2940](https://github.com/diffplug/spotless/issues/2940))
- Fix `StringIndexOutOfBoundsException` in scenarios where copyright year is surrounded by whitespace. ([#2973](https://github.com/diffplug/spotless/pull/2973))

### Changes
- Bump default `greclipse` version to latest `4.35` -> `4.39`. ([#2924](https://github.com/diffplug/spotless/pull/2924))
Expand Down
21 changes: 20 additions & 1 deletion plugin-gradle/src/test/java/com/diffplug/gradle/spotless/LicenseHeaderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2016-2025 DiffPlug
* Copyright 2016-2026 DiffPlug
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -56,13 +56,32 @@ private void assertTransform(String yearBefore, String yearAfter) throws IOExcep
private void testSuiteUpdateWithLatest(boolean update) throws IOException {
if (update) {
assertTransform("2003", "2003-" + NOW);
assertTransform(" 2003", "2003-" + NOW);
assertTransform("2003 ", "2003-" + NOW);
assertTransform(" 2003 ", "2003-" + NOW);

assertTransform("2003-2005", "2003-" + NOW);
assertTransform(" 2003-2005", "2003-" + NOW);
assertTransform("2003-2005 ", "2003-" + NOW);
assertTransform(" 2003-2005 ", "2003-" + NOW);
} else {
assertUnchanged("2003");
assertTransform(" 2003", "2003");
assertTransform("2003 ", "2003");
assertTransform(" 2003 ", "2003");

assertUnchanged("2003-2005");
assertTransform(" 2003-2005", "2003-2005");
assertTransform("2003-2005 ", "2003-2005");
assertTransform(" 2003-2005 ", "2003-2005");
}
assertUnchanged(NOW);
assertTransform(" " + NOW, NOW);
assertTransform(NOW + " ", NOW);
assertTransform(" " + NOW + " ", NOW);

assertTransform("", NOW);
assertTransform(" ", NOW);
}

@Test
Expand Down
2 changes: 2 additions & 0 deletions plugin-maven/CHANGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (
### Fixed
- Parse standard git year output in LicenseHeaderStep. ([#2940](https://github.com/diffplug/spotless/issues/2940))
- `<toggleOffOn>` no longer disables lint-only steps such as `<forbidWildcardImports>`. ([#2962](https://github.com/diffplug/spotless/pull/2962))
- Fix `StringIndexOutOfBoundsException` in scenarios where copyright year is surrounded by whitespace. ([#2973](https://github.com/diffplug/spotless/pull/2973))

### Added
- Add support for AsciiDoc formatting via `adocfmt`. ([#2960](https://github.com/diffplug/spotless/pull/2960))
- `<flexmark>` step now supports arbitrary formatter options via `<formatterOptions>`. ([#2968](https://github.com/diffplug/spotless/pull/2968))
Expand Down