Fix some lint names (file -> path, ruleId -> shortCode)

Author: nedtwigg

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

@@ -37,28 +37,28 @@ public static Lint atLine(int line, String ruleId, String detail) {
 		return new Lint(line, ruleId, detail);
 	}
 
-	public static Lint atLineRange(int lineStart, int lineEnd, String ruleId, String detail) {
-		return new Lint(lineStart, lineEnd, ruleId, detail);
+	public static Lint atLineRange(int lineStart, int lineEnd, String shortCode, String detail) {
+		return new Lint(lineStart, lineEnd, shortCode, detail);
 	}
 
 	private static final long serialVersionUID = 1L;
 
 	private int lineStart, lineEnd; // 1-indexed, inclusive
-	private String ruleId; // e.g. CN_IDIOM https://spotbugs.readthedocs.io/en/stable/bugDescriptions.html#cn-class-implements-cloneable-but-does-not-define-or-use-clone-method-cn-idiom
+	private String shortCode; // e.g. CN_IDIOM https://spotbugs.readthedocs.io/en/stable/bugDescriptions.html#cn-class-implements-cloneable-but-does-not-define-or-use-clone-method-cn-idiom
 	private String detail;
 
-	private Lint(int lineStart, int lineEnd, String ruleId, String detail) {
+	private Lint(int lineStart, int lineEnd, String shortCode, String detail) {
 		if (lineEnd < lineStart) {
 			throw new IllegalArgumentException("lineEnd must be >= lineStart: lineStart=" + lineStart + " lineEnd=" + lineEnd);
 		}
 		this.lineStart = lineStart;
 		this.lineEnd = lineEnd;
-		this.ruleId = LineEnding.toUnix(ruleId);
+		this.shortCode = LineEnding.toUnix(shortCode);
 		this.detail = LineEnding.toUnix(detail);
 	}
 
-	private Lint(int line, String ruleId, String detail) {
-		this(line, line, ruleId, detail);
+	private Lint(int line, String shortCode, String detail) {
+		this(line, line, shortCode, detail);
 	}
 
 	public int getLineStart() {
@@ -69,8 +69,8 @@ public int getLineEnd() {
 		return lineEnd;
 	}
 
-	public String getRuleId() {
-		return ruleId;
+	public String getShortCode() {
+		return shortCode;
 	}
 
 	public String getDetail() {
@@ -115,12 +115,12 @@ public RuntimeException shortcut() {
 	public String toString() {
 		if (lineStart == lineEnd) {
 			if (lineStart == LINE_UNDEFINED) {
-				return "LINE_UNDEFINED: (" + ruleId + ") " + detail;
+				return "LINE_UNDEFINED: (" + shortCode + ") " + detail;
 			} else {
-				return "L" + lineStart + ": (" + ruleId + ") " + detail;
+				return "L" + lineStart + ": (" + shortCode + ") " + detail;
 			}
 		} else {
-			return "L" + lineStart + "-" + lineEnd + ": (" + ruleId + ") " + detail;
+			return "L" + lineStart + "-" + lineEnd + ": (" + shortCode + ") " + detail;
 		}
 	}
 
@@ -131,12 +131,12 @@ public boolean equals(Object o) {
 		if (o == null || getClass() != o.getClass())
 			return false;
 		Lint lint = (Lint) o;
-		return lineStart == lint.lineStart && lineEnd == lint.lineEnd && Objects.equals(ruleId, lint.ruleId) && Objects.equals(detail, lint.detail);
+		return lineStart == lint.lineStart && lineEnd == lint.lineEnd && Objects.equals(shortCode, lint.shortCode) && Objects.equals(detail, lint.detail);
 	}
 
 	@Override
 	public int hashCode() {
-		return Objects.hash(lineStart, lineEnd, ruleId, detail);
+		return Objects.hash(lineStart, lineEnd, shortCode, detail);
 	}
 
 	/** Attempts to parse a line number from the given exception. */
@@ -201,7 +201,7 @@ public void addWarningMessageTo(StringBuilder buffer, String stepName, boolean o
 			}
 		}
 		buffer.append(" ");
-		buffer.append(stepName).append("(").append(ruleId).append(") ");
+		buffer.append(stepName).append("(").append(shortCode).append(") ");
 
 		int firstNewline = detail.indexOf('\n');
 		if (firstNewline == -1) {

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

@@ -21,16 +21,16 @@ public class LintSuppression implements java.io.Serializable {
 	private static final long serialVersionUID = 1L;
 
 	private static final String ALL = "*";
-	private String file = ALL;
+	private String path = ALL;
 	private String step = ALL;
 	private String shortCode = ALL;
 
-	public String getFile() {
-		return file;
+	public String getPath() {
+		return path;
 	}
 
-	public void setFile(String file) {
-		this.file = Objects.requireNonNull(file);
+	public void setPath(String path) {
+		this.path = Objects.requireNonNull(path);
 	}
 
 	public String getStep() {
@@ -50,9 +50,9 @@ public void setShortCode(String shortCode) {
 	}
 
 	public boolean suppresses(String relativePath, FormatterStep formatterStep, Lint lint) {
-		if (file.equals(ALL) || file.equals(relativePath)) {
+		if (path.equals(ALL) || path.equals(relativePath)) {
 			if (step.equals(ALL) || formatterStep.getName().equals(this.step)) {
-				if (shortCode.equals(ALL) || lint.getRuleId().equals(this.shortCode)) {
+				if (shortCode.equals(ALL) || lint.getShortCode().equals(this.shortCode)) {
 					return true;
 				}
 			}
@@ -61,7 +61,7 @@ public boolean suppresses(String relativePath, FormatterStep formatterStep, Lint
 	}
 
 	public void ensureDoesNotSuppressAll() {
-		boolean suppressAll = file.equals(ALL) && step.equals(ALL) && shortCode.equals(ALL);
+		boolean suppressAll = path.equals(ALL) && step.equals(ALL) && shortCode.equals(ALL);
 		if (suppressAll) {
 			throw new IllegalArgumentException("You must specify a specific `file`, `step`, or `shortCode`.");
 		}
@@ -74,18 +74,18 @@ public boolean equals(Object o) {
 		if (o == null || getClass() != o.getClass())
 			return false;
 		LintSuppression that = (LintSuppression) o;
-		return Objects.equals(file, that.file) && Objects.equals(step, that.step) && Objects.equals(shortCode, that.shortCode);
+		return Objects.equals(path, that.path) && Objects.equals(step, that.step) && Objects.equals(shortCode, that.shortCode);
 	}
 
 	@Override
 	public int hashCode() {
-		return Objects.hash(file, step, shortCode);
+		return Objects.hash(path, step, shortCode);
 	}
 
 	@Override
 	public String toString() {
 		return "LintSuppression{" +
-				"file='" + file + '\'' +
+				"file='" + path + '\'' +
 				", step='" + step + '\'' +
 				", code='" + shortCode + '\'' +
 				'}';

lib/src/test/java/com/diffplug/spotless/LintSuppressionTest.java

@@ -50,8 +50,8 @@ public void testMatchSingle() {
 		assertThat(noSuppressions.isHasLints()).isTrue();
 		removesLint(s -> s.setStep("blah")).isFalse();
 		removesLint(s -> s.setStep("endWithNewline")).isTrue();
-		removesLint(s -> s.setFile("blah")).isFalse();
-		removesLint(s -> s.setFile("testFile")).isTrue();
+		removesLint(s -> s.setPath("blah")).isFalse();
+		removesLint(s -> s.setPath("testFile")).isTrue();
 		removesLint(s -> s.setShortCode("blah")).isFalse();
 		removesLint(s -> s.setShortCode("66")).isTrue();
 	}