Allow licence header to be empty (#801)

diffplug · Feb 16, 2021 · 07354bf · 07354bf
2 parents e3a35d8 + 384ca87
commit 07354bf
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 3 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -10,6 +10,8 @@ This document is intended for Spotless developers.
 We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (starting after version `1.27.0`).
 
 ## [Unreleased]
+### Fixed
+* Allow licence headers to be blank ([#801](https://github.com/diffplug/spotless/pull/801)).
 
 ## [2.12.0] - 2021-02-09
 ### Added

diff --git a/lib/src/main/java/com/diffplug/spotless/generic/LicenseHeaderStep.java b/lib/src/main/java/com/diffplug/spotless/generic/LicenseHeaderStep.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2020 DiffPlug
+ * Copyright 2016-2021 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -159,7 +159,7 @@ private Runtime(String licenseHeader, String delimiter, String yearSeparator, bo
 			}
 			// sanitize the input license
 			licenseHeader = LineEnding.toUnix(licenseHeader);
-			if (!licenseHeader.endsWith("\n")) {
+			if (!licenseHeader.isEmpty() && !licenseHeader.endsWith("\n")) {
 				licenseHeader = licenseHeader + "\n";
 			}
 			this.delimiterPattern = Pattern.compile('^' + delimiter, Pattern.UNIX_LINES | Pattern.MULTILINE);

diff --git a/plugin-gradle/CHANGES.md b/plugin-gradle/CHANGES.md
@@ -3,6 +3,8 @@
 We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (starting after version `3.27.0`).
 
 ## [Unreleased]
+### Fixed
+* Allow licence headers to be blank ([#801](https://github.com/diffplug/spotless/pull/801)).
 
 ## [5.10.1] - 2021-02-11
 ### Fixed

diff --git a/plugin-maven/CHANGES.md b/plugin-maven/CHANGES.md
@@ -3,6 +3,8 @@
 We adhere to the [keepachangelog](https://keepachangelog.com/en/1.0.0/) format (starting after version `1.27.0`).
 
 ## [Unreleased]
+### Fixed
+* Allow licence headers to be blank ([#801](https://github.com/diffplug/spotless/pull/801)).
 
 ## [2.8.0] - 2021-02-09
 ### Added

diff --git a/testlib/src/test/java/com/diffplug/spotless/generic/LicenseHeaderStepTest.java b/testlib/src/test/java/com/diffplug/spotless/generic/LicenseHeaderStepTest.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2020 DiffPlug
+ * Copyright 2016-2021 DiffPlug
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -112,6 +112,13 @@ public void should_apply_license_containing_YEAR_token_with_custom_separator() t
 				.test(hasHeaderYear("not a year"), hasHeaderYear(currentYear()));
 	}
 
+	@Test
+	public void should_remove_header_when_empty() throws Throwable {
+		StepHarness.forStep(LicenseHeaderStep.headerDelimiter("", package_).build())
+				.testUnaffected(getTestResource("license/MissingLicense.test"))
+				.test(getTestResource("license/HasLicense.test"), getTestResource("license/MissingLicense.test"));
+	}
+
 	private String header(String contents) throws IOException {
 		return "/*\n" +
 				" * " + contents + "\n" +