Issue #17681: Fix multiple blank line separation

DakshRJain737 · romani · commit c2fe3c4ddd8f · 2025-10-25T07:13:48.000-07:00
diff --git a/config/google-java-format/excluded/compilable-input-paths.txt b/config/google-java-format/excluded/compilable-input-paths.txt
@@ -38,6 +38,7 @@ src/it/resources/com/google/checkstyle/test/chapter4formatting/rule451wheretobre
 src/it/resources/com/google/checkstyle/test/chapter4formatting/rule451wheretobreak/InputNoWrappingAfterRecordName2.java
 src/it/resources/com/google/checkstyle/test/chapter4formatting/rule452indentcontinuationlines/InputClassWithChainedMethods2.java
 src/it/resources/com/google/checkstyle/test/chapter4formatting/rule461verticalwhitespace/InputVerticalWhitespace.java
+src/it/resources/com/google/checkstyle/test/chapter4formatting/rule461verticalwhitespace/InputEmptyLineSeparator3.java
 src/it/resources/com/google/checkstyle/test/chapter4formatting/rule462horizontalwhitespace/InputWhitespaceAroundBasic.java
 src/it/resources/com/google/checkstyle/test/chapter4formatting/rule462horizontalwhitespace/InputWhitespaceAfterBad.java
 src/it/resources/com/google/checkstyle/test/chapter4formatting/rule462horizontalwhitespace/InputWhitespaceAfterGood.java
diff --git a/src/it/resources/com/google/checkstyle/test/chapter3filestructure/rule333orderingandspacing/InputOrderingAndSpacing4.java b/src/it/resources/com/google/checkstyle/test/chapter3filestructure/rule333orderingandspacing/InputOrderingAndSpacing4.java
@@ -12,7 +12,6 @@
 import com.google.common.reflect.Invokable;
 import java.util.List;
 
-
 import java.util.StringTokenizer;
 // violation above 'Extra separation in import group before 'java.util.StringTokenizer''
 
diff --git a/src/it/resources/com/google/checkstyle/test/chapter3filestructure/rule333orderingandspacing/InputOrderingAndSpacing5.java b/src/it/resources/com/google/checkstyle/test/chapter3filestructure/rule333orderingandspacing/InputOrderingAndSpacing5.java
@@ -4,7 +4,6 @@
 import static java.io.File.createTempFile;
 // comments
 
-
 // comments
 import static javax.swing.WindowConstants.DISPOSE_ON_CLOSE;
 // violation above 'Extra separation .* before 'javax.swing.WindowConstants.DISPOSE_ON_CLOSE''
diff --git a/src/it/resources/com/google/checkstyle/test/chapter3filestructure/rule333orderingandspacing/InputOrderingAndSpacingValid.java b/src/it/resources/com/google/checkstyle/test/chapter3filestructure/rule333orderingandspacing/InputOrderingAndSpacingValid.java
@@ -1,8 +1,5 @@
 package com.google.checkstyle.test.chapter3filestructure.rule333orderingandspacing;
 
-// it is not forbidden to have extra lines (more than one) between package and import group
-
-
 import static com.puppycrawl.tools.checkstyle.utils.AnnotationUtil.containsAnnotation;
 import static com.puppycrawl.tools.checkstyle.utils.AnnotationUtil.getAnnotation;
 
diff --git a/src/it/resources/com/google/checkstyle/test/chapter4formatting/rule43onestatement/InputOneStatementPerLine.java b/src/it/resources/com/google/checkstyle/test/chapter4formatting/rule43onestatement/InputOneStatementPerLine.java
@@ -242,15 +242,13 @@ private void foo2() {
     // 'Only one statement per line allowed.'
   }
 
-
   /**
    * While theoretically being distributed over two lines, this is a sample
    * of 2 statements on one line.
    */
   int var9 = 1, var10 = 5 // violation 'Each variable declaration must be in its own statement.'
       ; int var11 = 2; // violation 'Only one statement per line allowed.'
 
-
   /**
    * Multiline for loop statement is legal.
    */
diff --git a/src/it/resources/com/google/checkstyle/test/chapter4formatting/rule461verticalwhitespace/InputEmptyLineSeparator3.java b/src/it/resources/com/google/checkstyle/test/chapter4formatting/rule461verticalwhitespace/InputEmptyLineSeparator3.java
@@ -0,0 +1,27 @@
+/*
+EmptyLineSeparator
+allowNoEmptyLineBetweenFields = (default)false
+allowMultipleEmptyLines = false
+allowMultipleEmptyLinesInsideClassMembers = (default)true
+tokens = (default)PACKAGE_DEF, IMPORT, STATIC_IMPORT, CLASS_DEF, INTERFACE_DEF, ENUM_DEF, \
+         STATIC_INIT, INSTANCE_INIT, METHOD_DEF, CTOR_DEF, VARIABLE_DEF, RECORD_DEF, \
+         COMPACT_CTOR_DEF
+
+
+*/
+
+
+
+
+package com.google.checkstyle.test.chapter4formatting.rule461verticalwhitespace; //violation ''package' has more than 1 empty lines before'
+
+
+
+
+public class InputEmptyLineSeparator3 {
+// violation above ''CLASS_DEF' has more than 1 empty lines before.'
+
+
+    String s = "Hello"; // violation ''VARIABLE_DEF' has more than 1 empty lines before.'
+
+}
diff --git a/src/it/resources/com/google/checkstyle/test/chapter4formatting/rule461verticalwhitespace/InputFormattedEmptyLineSeparator3.java b/src/it/resources/com/google/checkstyle/test/chapter4formatting/rule461verticalwhitespace/InputFormattedEmptyLineSeparator3.java
@@ -0,0 +1,21 @@
+/*
+EmptyLineSeparator
+allowNoEmptyLineBetweenFields = (default)false
+allowMultipleEmptyLines = false
+allowMultipleEmptyLinesInsideClassMembers = (default)true
+tokens = (default)PACKAGE_DEF, IMPORT, STATIC_IMPORT, CLASS_DEF, INTERFACE_DEF, ENUM_DEF, \
+         STATIC_INIT, INSTANCE_INIT, METHOD_DEF, CTOR_DEF, VARIABLE_DEF, RECORD_DEF, \
+         COMPACT_CTOR_DEF
+
+
+*/
+
+package com.google.checkstyle.test.chapter4formatting.rule461verticalwhitespace;
+
+// violation above ''package' has more than 1 empty lines before.'
+
+public class InputFormattedEmptyLineSeparator3 {
+  // violation above ''CLASS_DEF' has more than 1 empty lines before.'
+
+  String s = "Hello"; // violation ''VARIABLE_DEF' has more than 1 empty lines before.'
+}
diff --git a/src/it/resources/com/google/checkstyle/test/chapter4formatting/rule462horizontalwhitespace/InputNoWhitespaceBeforeEllipsis.java b/src/it/resources/com/google/checkstyle/test/chapter4formatting/rule462horizontalwhitespace/InputNoWhitespaceBeforeEllipsis.java
@@ -3,7 +3,7 @@
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Target;
 
-
+//
 /** some javadoc. */
 public class InputNoWhitespaceBeforeEllipsis {
 
diff --git a/src/it/resources/com/google/checkstyle/test/chapter4formatting/rule487modifiers/InputModifierOrder.java b/src/it/resources/com/google/checkstyle/test/chapter4formatting/rule487modifiers/InputModifierOrder.java
@@ -49,7 +49,6 @@ strictfp private void doStuff() {}
   // violation below ''static' modifier out of order with the JLS suggestions.'
   @MyAnnotation2 strictfp static final synchronized private void fooMethod4() {}
 
-
   // violation below ''final' modifier out of order with the JLS suggestions.'
   synchronized final strictfp @MyAnnotation2 static public void fooMethod5() {}
 
diff --git a/src/it/resources/com/google/checkstyle/test/chapter5naming/rule522classnames/InputClassNames.java b/src/it/resources/com/google/checkstyle/test/chapter5naming/rule522classnames/InputClassNames.java
@@ -23,7 +23,6 @@ class $NoValidName {}
   class NoValidName$ {}
   // violation above 'Type name 'NoValidName\$' must match pattern'
 
-
   class ValidName {}
 
   class _ValidName {} // violation 'Type name '_ValidName' must match pattern'
diff --git a/src/main/resources/google_checks.xml b/src/main/resources/google_checks.xml
@@ -206,6 +206,7 @@
                     STATIC_INIT, INSTANCE_INIT, METHOD_DEF, CTOR_DEF, VARIABLE_DEF, RECORD_DEF,
                     COMPACT_CTOR_DEF"/>
       <property name="allowNoEmptyLineBetweenFields" value="true"/>
+      <property name="allowMultipleEmptyLines" value="false"/>
     </module>
     <module name="SeparatorWrap">
       <property name="id" value="SeparatorWrapDot"/>
diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/checks/whitespace/EmptyLineSeparatorCheckTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/checks/whitespace/EmptyLineSeparatorCheckTest.java
@@ -728,4 +728,17 @@ public void testMultipleLines3() throws Exception {
                 expected);
     }
 
+    @Test
+    public void testEmptyLineSeparator() throws Exception {
+        final String[] expected = {
+            "16:1: " + getCheckMessage(MSG_MULTIPLE_LINES, "package"),
+            "21:1: " + getCheckMessage(MSG_MULTIPLE_LINES, "CLASS_DEF"),
+            "25:5: " + getCheckMessage(MSG_MULTIPLE_LINES, "VARIABLE_DEF"),
+        };
+        verifyWithInlineConfigParser(
+                getPath("InputEmptyLineSeparator3.java"),
+                expected
+        );
+    }
+
 }
diff --git a/src/test/resources/com/puppycrawl/tools/checkstyle/checks/whitespace/emptylineseparator/InputEmptyLineSeparator3.java b/src/test/resources/com/puppycrawl/tools/checkstyle/checks/whitespace/emptylineseparator/InputEmptyLineSeparator3.java
@@ -0,0 +1,27 @@
+/*
+EmptyLineSeparator
+allowNoEmptyLineBetweenFields = (default)false
+allowMultipleEmptyLines = false
+allowMultipleEmptyLinesInsideClassMembers = (default)true
+tokens = (default)PACKAGE_DEF, IMPORT, STATIC_IMPORT, CLASS_DEF, INTERFACE_DEF, ENUM_DEF, \
+         STATIC_INIT, INSTANCE_INIT, METHOD_DEF, CTOR_DEF, VARIABLE_DEF, RECORD_DEF, \
+         COMPACT_CTOR_DEF
+
+
+*/
+
+
+
+
+package com.puppycrawl.tools.checkstyle.checks.whitespace.emptylineseparator; //violation ''package' has more than 1 empty lines before'
+
+
+
+
+public class InputEmptyLineSeparator3 {
+// violation above ''CLASS_DEF' has more than 1 empty lines before.'
+
+
+    String s = "Hello"; // violation ''VARIABLE_DEF' has more than 1 empty lines before.'
+
+}
