[SPARK-7977] Disallow println

• Type: Sub-task
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 1.5.0
• Component/s: Project Infra
• Labels: starter
• Target Version/s: 1.5.0
• Assignee: Jon Alter
• Reporter: Reynold Xin
• Created: 31/May/15 05:02
• Updated: 05/Nov/15 09:41
• Resolved: 10/Jul/15 10:33

Description

Very often we see pull requests that added println from debugging, but the author forgot to remove it before code review.

We can use the regex checker to disallow println. For legitimate use of println, we can then disable the rule where they are used.

Add to scalastyle-config.xml file:

  <check customId="println" level="error" class="org.scalastyle.scalariform.TokenChecker" enabled="true">
    <parameters><parameter name="regex">^println$</parameter></parameters>
    <customMessage><![CDATA[Are you sure you want to println? If yes, wrap the code block with 
      // scalastyle:off println
      println(...)
      // scalastyle:on println]]></customMessage>
  </check>

Issue Links

• links to: [Github] Pull Request #7093 (jonalter)