Add rule to reduce blank lines between scopes

IndrajeetPatil · IndrajeetPatil · commit 2530f99e4883 · 2024-11-28T20:20:08.000+01:00
diff --git a/R/rules-line-breaks.R b/R/rules-line-breaks.R
@@ -447,3 +447,21 @@ remove_empty_lines_after_opening_and_before_closing_braces <- function(pd) {
 
   pd
 }
+
+
+#' Reduce multiple blank lines to a maximum number of allowed blank lines
+#' @param pd_flat A flat parse table.
+#' @param allowed_blank_lines The maximum number of allowed blank lines between code elements. Default is `2L`.
+#' @keywords internal
+reduce_extra_blank_lines_between_scopes <- function(pd_flat, allowed_blank_lines = 2L) {
+  # Calculate the maximum allowed lag_newlines
+  max_lag_newlines <- allowed_blank_lines + 1L  # +1 accounts for the line with the previous token
+
+  # Identify positions where lag_newlines exceed the maximum allowed
+  idx <- which(pd_flat$lag_newlines > max_lag_newlines)
+
+  # Reduce lag_newlines to the maximum allowed at those positions
+  pd_flat$lag_newlines[idx] <- max_lag_newlines
+
+  return(pd_flat)
+}
diff --git a/R/style-guides.R b/R/style-guides.R
@@ -139,6 +139,7 @@ tidyverse_style <- function(scope = "tokens",
         if (strict) remove_line_break_before_round_closing_after_curly,
       remove_line_breaks_in_fun_dec =
         if (strict) remove_line_breaks_in_fun_dec,
+      reduce_extra_blank_lines_between_scopes = reduce_extra_blank_lines_between_scopes,
       style_line_break_around_curly = partial(
         style_line_break_around_curly,
         strict
diff --git a/tests/testthat/alignment/named-out.R b/tests/testthat/alignment/named-out.R
@@ -102,7 +102,6 @@ call(
 )
 
 
-
 # if all col1 arguments are named, col1 must also be aligned
 # not aligned
 fell(
diff --git a/tests/testthat/indention_curly_brackets/custom-out.R b/tests/testthat/indention_curly_brackets/custom-out.R
@@ -4,7 +4,6 @@ if (value > 0) {
 }
 
 
-
 if (value > 0) {
     print(value)
 }
diff --git a/tests/testthat/line_breaks_and_other/assignment-out.R b/tests/testthat/line_breaks_and_other/assignment-out.R
@@ -22,7 +22,6 @@ x <-
   3
 
 
-
 ImportantDataFrame$ImportantColumn1 <-
   ImportantDataFrame$ImportantColumn2 <-
   ComplicatedFunction(ImportantDataFrame$InputColumn)
@@ -32,6 +31,5 @@ ImportantDataFrame$ImportantColumn1 <-
   ImportantDataFrame$ImportantColumn2 <- ComplicatedFunction(ImportantDataFrame$InputColumn)
 
 
-
 ImportantDataFrame$ImportantColumn1 <-
   ImportantDataFrame$ImportantColumn2 <- ComplicatedFunction(ImportantDataFrame$InputColumn)
diff --git a/tests/testthat/line_breaks_fun_call/blank-strict-out.R b/tests/testthat/line_breaks_fun_call/blank-strict-out.R
@@ -19,7 +19,6 @@ call(
   2,
 
 
-
   # comment
 
   1,
diff --git a/tests/testthat/line_breaks_fun_call/switch_ifelse_etc_no_line_break-out.R b/tests/testthat/line_breaks_fun_call/switch_ifelse_etc_no_line_break-out.R
@@ -16,7 +16,6 @@ switch( #
 )
 
 
-
 switch(x,
   a = 2, #
   y = 3
diff --git a/tests/testthat/line_breaks_fun_call/token_dependent_mixed-out.R b/tests/testthat/line_breaks_fun_call/token_dependent_mixed-out.R
@@ -16,7 +16,6 @@ call(call(
 ))
 
 
-
 # no more barcket on same line ->
 call(call(
   3, 4
diff --git a/tests/testthat/parse_comments/with_indention-out.R b/tests/testthat/parse_comments/with_indention-out.R
@@ -18,8 +18,6 @@ call(
 # new comment
 
 
-
-
 a()
 # I think it gets boring
 # new_line here
diff --git a/tests/testthat/roxygen-examples-complete/13-empty-lines-out.R b/tests/testthat/roxygen-examples-complete/13-empty-lines-out.R
@@ -9,8 +9,6 @@
 #' # two
 #'
 #'
-#'
-#'
 #' (
 #'   # more
 #'   a <- 3
diff --git a/tests/testthat/roxygen-examples-complete/26-empty-trailing-lines-out.R b/tests/testthat/roxygen-examples-complete/26-empty-trailing-lines-out.R
@@ -24,7 +24,6 @@ NULL
 NULL
 
 
-
 #' this
 #'
 #' empty line after example
diff --git a/tests/testthat/test-transformers-drop.R b/tests/testthat/test-transformers-drop.R
@@ -72,6 +72,7 @@ test_that("tidyverse transformers are correctly dropped", {
 
   names_line_break <- c(
     "remove_empty_lines_after_opening_and_before_closing_braces",
+    "reduce_extra_blank_lines_between_scopes",
     "set_line_break_around_comma_and_or",
     "set_line_break_after_assignment",
     "set_line_break_after_opening_if_call_is_multi_line",
diff --git a/tests/testthat/token_adding_removing/mixed_token-out.R b/tests/testthat/token_adding_removing/mixed_token-out.R
@@ -14,7 +14,6 @@ d
 'text with "quotes"'
 
 
-
 # adding brackets in pipes
 a %>%
   b() %>%

Original file line number	Diff line number	Diff line change
`@@ -102,7 +102,6 @@ call(`
`102`	`102`	`)`
`103`	`103`
`104`	`104`
`105`		`-`
`106`	`105`	`# if all col1 arguments are named, col1 must also be aligned`
`107`	`106`	`# not aligned`
`108`	`107`	`fell(`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,6 @@ if (value > 0) {`
`4`	`4`	`}`
`5`	`5`
`6`	`6`
`7`		`-`
`8`	`7`	`if (value > 0) {`
`9`	`8`	`print(value)`
`10`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,6 @@ x <-`
`22`	`22`	`3`
`23`	`23`
`24`	`24`
`25`		`-`
`26`	`25`	`ImportantDataFrame$ImportantColumn1 <-`
`27`	`26`	`ImportantDataFrame$ImportantColumn2 <-`
`28`	`27`	`ComplicatedFunction(ImportantDataFrame$InputColumn)`
`@@ -32,6 +31,5 @@ ImportantDataFrame$ImportantColumn1 <-`
`32`	`31`	`ImportantDataFrame$ImportantColumn2 <- ComplicatedFunction(ImportantDataFrame$InputColumn)`
`33`	`32`
`34`	`33`
`35`		`-`
`36`	`34`	`ImportantDataFrame$ImportantColumn1 <-`
`37`	`35`	`ImportantDataFrame$ImportantColumn2 <- ComplicatedFunction(ImportantDataFrame$InputColumn)`
-Original file line number
+Diff line change
 ,
+-
   # comment
 ,
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,6 @@ switch( #`
`16`	`16`	`)`
`17`	`17`
`18`	`18`
`19`		`-`
`20`	`19`	`switch(x,`
`21`	`20`	`a = 2, #`
`22`	`21`	`y = 3`