Skip to content

Commit 102d14e

Browse files
Anmol202005romani
Anmol202005
authored and
romani
committed
Issue #124: Implement recipe for NewlineAtEndOfFile
1 parent 0391daf commit 102d14e

20 files changed

Lines changed: 376 additions & 14 deletions

‎.gitattributes‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Test resources that need specific eol
2+
src/test/resources/org/checkstyle/autofix/recipe/newlineatendoffile/** -text
3+
4+
# Force LF line endings for diff test files
5+
*.diff text eol=lf

‎src/main/java/org/checkstyle/autofix/CheckstyleCheck.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
public enum CheckstyleCheck {
2424
FINAL_LOCAL_VARIABLE("com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck"),
2525
HEADER("com.puppycrawl.tools.checkstyle.checks.header.HeaderCheck"),
26+
NEWLINE_AT_END_OF_FILE("com.puppycrawl.tools.checkstyle.checks.NewlineAtEndOfFileCheck"),
2627
UPPER_ELL("com.puppycrawl.tools.checkstyle.checks.UpperEllCheck"),
2728
HEX_LITERAL_CASE("com.puppycrawl.tools.checkstyle.checks.HexLiteralCaseCheck"),
2829
REDUNDANT_IMPORT("com.puppycrawl.tools.checkstyle.checks.imports.RedundantImportCheck");

‎src/main/java/org/checkstyle/autofix/CheckstyleRecipeRegistry.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
import org.checkstyle.autofix.recipe.FinalLocalVariable;
3131
import org.checkstyle.autofix.recipe.Header;
3232
import org.checkstyle.autofix.recipe.HexLiteralCase;
33+
import org.checkstyle.autofix.recipe.NewlineAtEndOfFile;
3334
import org.checkstyle.autofix.recipe.RedundantImport;
3435
import org.checkstyle.autofix.recipe.UpperEll;
3536
import org.openrewrite.Recipe;
@@ -48,6 +49,7 @@ public final class CheckstyleRecipeRegistry {
4849
RECIPE_MAP.put(CheckstyleCheck.HEX_LITERAL_CASE, HexLiteralCase::new);
4950
RECIPE_MAP.put(CheckstyleCheck.FINAL_LOCAL_VARIABLE, FinalLocalVariable::new);
5051
RECIPE_MAP_WITH_CONFIG.put(CheckstyleCheck.HEADER, Header::new);
52+
RECIPE_MAP_WITH_CONFIG.put(CheckstyleCheck.NEWLINE_AT_END_OF_FILE, NewlineAtEndOfFile::new);
5153
RECIPE_MAP.put(CheckstyleCheck.REDUNDANT_IMPORT, RedundantImport::new);
5254
}
5355

‎src/main/java/org/checkstyle/autofix/recipe/Header.java‎

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ public class Header extends Recipe {
3939
private static final String HEADER_PROPERTY = "header";
4040
private static final String HEADER_FILE_PROPERTY = "headerFile";
4141
private static final String CHARSET_PROPERTY = "charset";
42-
private static final String LINE_SEPARATOR = "\n";
42+
private static final String LINE_SEPARATOR = System.lineSeparator();
4343

4444
private final List<CheckstyleViolation> violations;
4545
private final CheckConfiguration config;
@@ -75,7 +75,7 @@ private static String extractLicenseHeader(CheckConfiguration config) {
7575
.getPropertyOrDefault(CHARSET_PROPERTY, Charset.defaultCharset().name()));
7676
final String headerFilePath = config.getProperty(HEADER_FILE_PROPERTY);
7777
try {
78-
header = toLfLineEnding(Files.readString(Path.of(headerFilePath), charsetToUse));
78+
header = Files.readString(Path.of(headerFilePath), charsetToUse);
7979
}
8080
catch (IOException exception) {
8181
throw new IllegalArgumentException("Failed to extract header from config",
@@ -85,10 +85,6 @@ private static String extractLicenseHeader(CheckConfiguration config) {
8585
return header;
8686
}
8787

88-
private static String toLfLineEnding(String text) {
89-
return text.replaceAll("(?x)\\\\r(?=\\\\n)|\\r(?=\\n)", "");
90-
}
91-
9288
private static class HeaderVisitor extends JavaIsoVisitor<ExecutionContext> {
9389
private final List<CheckstyleViolation> violations;
9490
private final String licenseHeader;
@@ -121,8 +117,7 @@ public J visit(Tree tree, ExecutionContext executionContext) {
121117
private String extractCurrentHeader(JavaSourceFile sourceFile) {
122118
return sourceFile.getComments().stream()
123119
.map(comment -> {
124-
return comment.printComment(getCursor())
125-
+ toLfLineEnding(comment.getSuffix());
120+
return comment.printComment(getCursor()) + comment.getSuffix();
126121
})
127122
.collect(Collectors.joining(""));
128123
}

‎src/main/java/org/checkstyle/autofix/recipe/NewlineAtEndOfFile.java‎

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
///////////////////////////////////////////////////////////////////////////////////////////////
2+
// checkstyle-openrewrite-recipes: Automatically fix Checkstyle violations with OpenRewrite.
3+
// Copyright (C) 2025 The Checkstyle OpenRewrite Recipes Authors
4+
//
5+
// Licensed under the Apache License, Version 2.0 (the "License");
6+
// you may not use this file except in compliance with the License.
7+
// You may obtain a copy of the License at
8+
//
9+
// http://www.apache.org/licenses/LICENSE-2.0
10+
//
11+
// Unless required by applicable law or agreed to in writing, software
12+
// distributed under the License is distributed on an "AS IS" BASIS,
13+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
// See the License for the specific language governing permissions and
15+
// limitations under the License.
16+
///////////////////////////////////////////////////////////////////////////////////////////////
17+
18+
package org.checkstyle.autofix.recipe;
19+
20+
import java.nio.file.Path;
21+
import java.util.ArrayList;
22+
import java.util.List;
23+
import java.util.function.UnaryOperator;
24+
25+
import org.checkstyle.autofix.parser.CheckConfiguration;
26+
import org.checkstyle.autofix.parser.CheckstyleViolation;
27+
import org.openrewrite.ExecutionContext;
28+
import org.openrewrite.Recipe;
29+
import org.openrewrite.Tree;
30+
import org.openrewrite.TreeVisitor;
31+
import org.openrewrite.java.JavaIsoVisitor;
32+
import org.openrewrite.java.format.AutodetectGeneralFormatStyle;
33+
import org.openrewrite.java.tree.Comment;
34+
import org.openrewrite.java.tree.J;
35+
import org.openrewrite.java.tree.JavaSourceFile;
36+
import org.openrewrite.java.tree.Space;
37+
import org.openrewrite.style.GeneralFormatStyle;
38+
import org.openrewrite.style.Style;
39+
40+
public class NewlineAtEndOfFile extends Recipe {
41+
42+
private final List<CheckstyleViolation> violations;
43+
private final CheckConfiguration config;
44+
45+
public NewlineAtEndOfFile(List<CheckstyleViolation> violations, CheckConfiguration config) {
46+
this.violations = violations;
47+
this.config = config;
48+
}
49+
50+
@Override
51+
public String getDisplayName() {
52+
return "End files with a single newline";
53+
}
54+
55+
@Override
56+
public String getDescription() {
57+
return "Some tools work better when files end with an empty line.";
58+
}
59+
60+
@Override
61+
public TreeVisitor<?, ExecutionContext> getVisitor() {
62+
final String lineSeparator = config.getProperty("lineSeparator");
63+
return new NewLineAtEndOfFileVisitor(violations, lineSeparator);
64+
}
65+
66+
private static class NewLineAtEndOfFileVisitor extends JavaIsoVisitor<ExecutionContext> {
67+
private final List<CheckstyleViolation> violations;
68+
private final String lineSeparatorConfig;
69+
70+
NewLineAtEndOfFileVisitor(List<CheckstyleViolation> violations,
71+
String lineSeparatorConfig) {
72+
this.violations = violations;
73+
this.lineSeparatorConfig = lineSeparatorConfig.toLowerCase();
74+
}
75+
76+
@Override
77+
public J visit(Tree tree, ExecutionContext executionContext) {
78+
J result = (J) tree;
79+
80+
if (tree instanceof JavaSourceFile sourceFile) {
81+
82+
final Path filePath = sourceFile.getSourcePath().toAbsolutePath();
83+
84+
if (hasViolation(filePath)) {
85+
final String expectedLineEnding = determineLineEnding(sourceFile);
86+
87+
final Space eof = sourceFile.getEof();
88+
final String lastWhitespace = eof.getLastWhitespace();
89+
90+
if (!expectedLineEnding.equals(lastWhitespace)) {
91+
final List<Comment> comments = eof.getComments();
92+
if (comments.isEmpty()) {
93+
result = sourceFile.withEof(Space.format(expectedLineEnding));
94+
}
95+
else {
96+
result = sourceFile.withEof(sourceFile.getEof().withComments(mapLast(
97+
comments, comment -> comment.withSuffix(expectedLineEnding))));
98+
}
99+
}
100+
}
101+
}
102+
103+
return result;
104+
}
105+
106+
private String determineLineEnding(JavaSourceFile sourceFile) {
107+
return switch (lineSeparatorConfig) {
108+
case "lf" -> "\n";
109+
case "crlf" -> "\r\n";
110+
case "cr" -> "\r";
111+
case "system" -> System.lineSeparator();
112+
case "lf_cr_crlf" -> getAutodetectedLineEnding(sourceFile);
113+
default -> {
114+
throw new IllegalStateException("Unexpected value: " + lineSeparatorConfig);
115+
}
116+
};
117+
}
118+
119+
private String getAutodetectedLineEnding(JavaSourceFile sourceFile) {
120+
final GeneralFormatStyle generalFormatStyle =
121+
Style.from(GeneralFormatStyle.class, sourceFile, () -> {
122+
return AutodetectGeneralFormatStyle
123+
.autodetectGeneralFormatStyle(sourceFile);
124+
});
125+
return generalFormatStyle.newLine();
126+
}
127+
128+
private static List<Comment> mapLast(List<Comment> comments,
129+
UnaryOperator<Comment> mapper) {
130+
List<Comment> result = comments;
131+
132+
if (comments != null && !comments.isEmpty()) {
133+
final int lastIndex = comments.size() - 1;
134+
final Comment last = comments.get(lastIndex);
135+
final Comment newLast = mapper.apply(last);
136+
137+
if (last != newLast) {
138+
result = new ArrayList<>(comments);
139+
result.set(lastIndex, newLast);
140+
}
141+
}
142+
143+
return result;
144+
}
145+
146+
private boolean hasViolation(Path filePath) {
147+
return violations.stream()
148+
.anyMatch(violation -> violation.getFilePath().endsWith(filePath));
149+
}
150+
}
151+
}

‎src/test/java/org/checkstyle/autofix/generator/GenerateDiffFilesTest.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ private void createDiff(Path inputFile) throws IOException, InterruptedException
8484
}
8585

8686
final String diff = out.toString();
87-
Files.writeString(diffFile, diff);
87+
final String normalizedDiff = diff.replaceAll("\\r\\n?", "\n");
88+
Files.writeString(diffFile, normalizedDiff);
8889
}
8990
}

‎src/test/java/org/checkstyle/autofix/recipe/AbstractRecipeTestSupport.java‎

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -100,8 +100,9 @@ private void verify(Configuration config, Path reportPath, String inputPath, Str
100100
try {
101101
final Recipe mainRecipe = new CheckstyleAutoFix(reportPath.toString(),
102102
configPath.toString());
103-
final String beforeCode = readFile(getPath(inputPath));
104-
final String expectedAfterCode = readFile(getPath(outputPath));
103+
final String beforeCode = Files.readString(Path.of(getPath(inputPath)));
104+
final String expectedAfterCode = Files.readString(Path.of(getPath(outputPath)));
105+
105106
testRecipe(beforeCode, expectedAfterCode,
106107
getPath(inputPath), new InputClassRenamer(),
107108
mainRecipe, new RemoveViolationComments());
@@ -194,8 +195,14 @@ private Configuration getCheckConfigurations(String inputPath) throws Exception
194195
private String[] convertToExpectedMessages(List<CheckstyleViolation> violations) {
195196
return violations.stream()
196197
.map(violation -> {
197-
return violation.getLine() + ":"
198-
+ violation.getColumn() + ": " + violation.getMessage();
198+
String message = violation.getLine() + ":";
199+
if (violation.getColumn() != -1) {
200+
message += violation.getColumn() + ": ";
201+
}
202+
else {
203+
message += " ";
204+
}
205+
return message + violation.getMessage();
199206
})
200207
.toArray(String[]::new);
201208
}
@@ -205,7 +212,7 @@ private void testRecipe(String beforeCode, String expectedAfterCode,
205212
assertDoesNotThrow(() -> {
206213
rewriteRun(
207214
spec -> spec.recipes(recipes),
208-
java(beforeCode, expectedAfterCode, spec -> spec.path(filePath))
215+
java(beforeCode, expectedAfterCode, spec -> spec.path(filePath).noTrim())
209216
);
210217
});
211218
}

‎src/test/java/org/checkstyle/autofix/recipe/NewLineAtEndOfFileTest.java‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
///////////////////////////////////////////////////////////////////////////////////////////////
2+
// checkstyle-openrewrite-recipes: Automatically fix Checkstyle violations with OpenRewrite.
3+
// Copyright (C) 2025 The Checkstyle OpenRewrite Recipes Authors
4+
//
5+
// Licensed under the Apache License, Version 2.0 (the "License");
6+
// you may not use this file except in compliance with the License.
7+
// You may obtain a copy of the License at
8+
//
9+
// http://www.apache.org/licenses/LICENSE-2.0
10+
//
11+
// Unless required by applicable law or agreed to in writing, software
12+
// distributed under the License is distributed on an "AS IS" BASIS,
13+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
// See the License for the specific language governing permissions and
15+
// limitations under the License.
16+
///////////////////////////////////////////////////////////////////////////////////////////////
17+
18+
package org.checkstyle.autofix.recipe;
19+
20+
import org.checkstyle.autofix.parser.ReportParser;
21+
22+
public class NewLineAtEndOfFileTest extends AbstractRecipeTestSupport {
23+
@Override
24+
protected String getSubpackage() {
25+
return "newlineatendoffile";
26+
}
27+
28+
@RecipeTest
29+
void newLineCrlf(ReportParser parser) throws Exception {
30+
verify(parser, "NewlineAtEndOfFileCrlf");
31+
}
32+
33+
@RecipeTest
34+
void noNewLine(ReportParser parser) throws Exception {
35+
verify(parser, "NewlineAtEndOfFileNoNewLine");
36+
}
37+
38+
@RecipeTest
39+
void newLineComment(ReportParser parser) throws Exception {
40+
verify(parser, "NewlineAtEndOfFileComment");
41+
}
42+
43+
@RecipeTest
44+
void newLineLf(ReportParser parser) throws Exception {
45+
verify(parser, "NewlineAtEndOfFileLf");
46+
}
47+
}

‎src/test/resources/org/checkstyle/autofix/recipe/newlineatendoffile/newlineatendoffilecomment/DiffNewlineAtEndOfFileComment.diff‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
--- src/test/resources/org/checkstyle/autofix/recipe/newlineatendoffile/newlineatendoffilecomment/InputNewlineAtEndOfFileComment.java
2+
+++ src/test/resources/org/checkstyle/autofix/recipe/newlineatendoffile/newlineatendoffilecomment/OutputNewlineAtEndOfFileComment.java
3+
@@ -4,9 +4,8 @@
4+
fileExtensions = (default)""
5+
6+
*/
7+
-// violation 6 lines above 'File does not end with a newline.'
8+
9+
package org.checkstyle.autofix.recipe.newlineatendoffile.newlineatendoffilecomment;
10+
11+
-public class InputNewlineAtEndOfFileComment {
12+
-} // trailing comment
13+
\ No newline at end of file
14+
+public class OutputNewlineAtEndOfFileComment {
15+
+} // trailing comment

‎src/test/resources/org/checkstyle/autofix/recipe/newlineatendoffile/newlineatendoffilecomment/InputNewlineAtEndOfFileComment.java‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
/*
2+
com.puppycrawl.tools.checkstyle.checks.NewlineAtEndOfFileCheck
3+
lineSeparator = LF
4+
fileExtensions = (default)""
5+
6+
*/
7+
// violation 6 lines above 'File does not end with a newline.'
8+
9+
package org.checkstyle.autofix.recipe.newlineatendoffile.newlineatendoffilecomment;
10+
11+
public class InputNewlineAtEndOfFileComment {
12+
} // trailing comment

0 commit comments

Comments
 (0)