HeaderMatchesChecker appends blank line to expected header about scalastyle

[matthewfarwell]

This is an interesting one. It took me a while to work this out, because I couldn't get my tests to fail. I couldn't reproduce it. After digging, I found something: you seem to be adding the blank line yourself:

<?xml version="1.0" encoding="UTF-8"?>
<scalastyle>
 <name>Some test Scalastyle config</name>
  <check class="org.scalastyle.file.HeaderMatchesChecker" enabled="true"
  level="error">
    <parameters>
      <parameter name="header"><![CDATA[/*
This is some standard boilerplate that our boring lawyers force us to add to
every file whether we like it or not. Unfortunately, Scalastyle doesn't seem to
treat the header "as is" and appends a blank line to it, so that it fails the
header check. Any ideas?]]>    <!-- this carriage return is also taken as part of the header -->
      </parameter>    <!-- same for the whitespace at the beginning of the line -->
    </parameters>
  </check>
</scalastyle>

Scalastyle takes all of the text in the parameter element. You've got a CDATA section, but it also includes the carriage return at the end of the line. The fix should be simple: remove the blank line:

<?xml version="1.0" encoding="UTF-8"?>
<scalastyle>
 <name>Some test Scalastyle config</name>
  <check class="org.scalastyle.file.HeaderMatchesChecker" enabled="true"
  level="error">
    <parameters>
      <parameter name="header"><![CDATA[/*
This is some standard boilerplate that our boring lawyers force us to add to
every file whether we like it or not. Unfortunately, Scalastyle doesn't seem to
treat the header "as is" and appends a blank line to it, so that it fails the
header check. Any ideas?]]></parameter>
    </parameters>
  </check>
</scalastyle>

This should work. If it does, please close this issue.

[Facsimiler]

Doh! You're quite right! It's obvious when you look at it that way.

Thanks for taking the time to investigate this, Matthew!