Make an explicit constant for a lint at an undefined line.

Author: nedtwigg

lib/src/main/java/com/diffplug/spotless/Lint.java

@@ -27,16 +27,21 @@
  * to Spotless, then it is by definition.
  */
 public final class Lint implements Serializable {
-	/** Returns a runtime exception which, if thrown, will lint the entire file. */
-	public static ShortcutException entireFile(String code, String msg) {
-		return new ShortcutException(Lint.create(code, msg, -1));
+	/** Returns a runtime exception which, if thrown, will create a lint at an undefined line. */
+	public static ShortcutException atUndefinedLine(String code, String msg) {
+		return new ShortcutException(Lint.create(code, msg, LINE_UNDEFINED));
 	}
 
 	/** Returns a runtime exception which, if thrown, will lint a specific line. */
 	public static ShortcutException atLine(int line, String code, String msg) {
 		return new ShortcutException(Lint.create(code, msg, line));
 	}
 
+	/** Returns a runtime exception which, if thrown, will lint a specific line range. */
+	public static ShortcutException atLineRange(int lineStart, int lineEnd, String code, String msg) {
+		return new ShortcutException(Lint.create(code, msg, lineStart, lineEnd));
+	}
+
 	/** Any exception which implements this interface will have its lints extracted and reported cleanly to the user. */
 	public interface Has {
 		List<Lint> getLints();
@@ -103,7 +108,11 @@ public String getMsg() {
 	@Override
 	public String toString() {
 		if (lineStart == lineEnd) {
-			return lineStart + ": (" + code + ") " + msg;
+			if (lineStart == LINE_UNDEFINED) {
+				return "LINE_UNDEFINED: (" + code + ") " + msg;
+			} else {
+				return lineStart + ": (" + code + ") " + msg;
+			}
 		} else {
 			return lineStart + "-" + lineEnd + ": (" + code + ") " + msg;
 		}
@@ -163,4 +172,6 @@ private static String msgFrom(String message) {
 		}
 		return "";
 	}
+
+	public static final int LINE_UNDEFINED = -1;
 }

plugin-gradle/src/test/java/com/diffplug/gradle/spotless/ErrorShouldRethrowTest.java

@@ -43,7 +43,7 @@ private void writeBuild(String... toInsert) throws IOException {
 		lines.add("        target file('README.md')");
 		lines.add("        custom 'no swearing', {");
 		lines.add("             if (it.toLowerCase(Locale.ROOT).contains('fubar')) {");
-		lines.add("                 throw com.diffplug.spotless.Lint.entireFile('swearing', 'No swearing!');");
+		lines.add("                 throw com.diffplug.spotless.Lint.atUndefinedLine('swearing', 'No swearing!');");
 		lines.add("             }");
 		lines.add("        }");
 		lines.addAll(Arrays.asList(toInsert));
@@ -68,8 +68,8 @@ void anyExceptionShouldFail() throws Exception {
 		runWithFailure(
 				"> Task :spotlessMisc FAILED\n" +
 						"Step 'no swearing' found problem in 'README.md':\n" +
-						"-1: (swearing) No swearing!\n" +
-						"java.lang.Throwable: -1: (swearing) No swearing!");
+						"LINE_UNDEFINED: (swearing) No swearing!\n" +
+						"java.lang.Throwable: LINE_UNDEFINED: (swearing) No swearing!");
 	}
 
 	@Test
@@ -113,8 +113,8 @@ void failsIfNeitherStepNorFileExempted() throws Exception {
 		setFile("README.md").toContent("This code is fubar.");
 		runWithFailure("> Task :spotlessMisc FAILED\n" +
 				"Step 'no swearing' found problem in 'README.md':\n" +
-				"-1: (swearing) No swearing!\n" +
-				"java.lang.Throwable: -1: (swearing) No swearing!");
+				"LINE_UNDEFINED: (swearing) No swearing!\n" +
+				"java.lang.Throwable: LINE_UNDEFINED: (swearing) No swearing!");
 	}
 
 	private void runWithSuccess(String expectedToStartWith) throws Exception {