I'm working with a Maven (jar) Project in Netbeans (Windows), which creates Checkstyle reports with the Maven Checkstyle plugin.
No matter what I do, I always get the message: File does not end with a newline for Java class files.
What can I do/configure in either Netbeans or Checkstyle to get rid of the message ?
Versions of used software:
In my case that was a problem with improper configuration of that checker. By default it uses system default convention of line endings. I was working on windows and the project was using unix-style line endings. I don't think ignoring the warning is the best strategy, so what I've done is:
<module name="Checker">
<module name="NewlineAtEndOfFile">
<property name="lineSeparator" value="lf" />
</module>
</module>
Put a newline at the end of the file
or
configure CheckStyle not to care.
<module name="Checker">
<!-- stuff deleted -->
<module name="NewlineAtEndOfFile">
<property name="severity" value="ignore" />
</module>
You also have to tell the Maven Checkstyle plugin to use your checkstyle config file.
<plugin>
<artifactId>maven-checkstyle-plugin</artifactId>
<configuration>
<configLocation>${basedir}/yourCheckstyle.xml</configLocation>
</configuration>
</plugin>
I run into this problem when files are saved as UNIX format instead of DOS. (or other way around if you do your work in Unix)
To fix it, I use a program do convert from UNIX format to DOS and save the file in that format.
In eclipse: File -> Convert Line Delimiters To -> Windows
There's a simpler way to do this. You can specify a suppressions file without overriding the sun checkstyle config file:
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<configuration>
<suppressionsLocation>suppressions.xml</suppressionsLocation>
<configLocation>config/sun_checks.xml</configLocation>
</configuration>
</plugin>
Where your suppressions.xml is:
<?xml version="1.0"?>
<!DOCTYPE suppressions PUBLIC
"-//Puppy Crawl//DTD Suppressions 1.1//EN"
"http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
<suppressions>
<suppress checks="NewlineAtEndOfFile" files=".java" />
</suppressions>
Just put A LINE AT END OF THE FILE. It will solve.
Eclipse ..Window >> Preferences >> Checkstyle >> Select the configuration file >>
"Properties" button >> Uncheck the Protect Checkstyle Configuration file."Configure" button >> search for "New Line At End Of File" >> Uncheck the checkbox which you see next to New Line At End Of File. Add a new line(press enter) at the end of the class where the issue is observed
The most effective way would be to change the line separator on your side. The problem looks like you have a CRLF line separator, but checkstyle expects macOS Unix style\n For example, for Intellij Idea you can use this guide
//Here is the brute force solution:
import java.io.BufferedReader;
import java.io.File;
import java.io.FileReader;
import java.io.FileWriter;
import java.util.ArrayList;
/**
*
* @author hMueller
*/
public class UnixToWindowsEncoding {
//rewrites all .java files in Windows encoding
//a[0] = parent directory
//loops through all subdirectories and fixes whatever .java file it finds
public static void main(String[] a){
String startdir = a[0];
fixDir(startdir);
}
private static void fixDir(String dirname){
try{
File f = new File(dirname);
File[] list = f.listFiles();
for(int i = 0; i < list.length; i++){
if(list[i].isDirectory()){
fixDir(list[i].getAbsolutePath());
}else{
if(list[i].getName().endsWith(".java")){
ArrayList<String> l = new ArrayList<String>();
FileReader fr = new FileReader(list[i]);
BufferedReader br = new BufferedReader(fr);
String line = "";
while( (line = br.readLine()) != null){
l.add(line);
}
br.close();
fr.close();
list[i].delete();
FileWriter fwr = new FileWriter(list[i]);
for(String s : l){
fwr.write(s + "\r\n");
}
fwr.flush();
fwr.close();
}
}
}
}catch(Exception ioe){
ioe.printStackTrace();
}
}
}
