Remove excessive line breaks between top-level expressions

.pre-commit-config.yaml

@@ -1,12 +1,12 @@
 # All available hooks: https://pre-commit.com/hooks.html
 # R specific hooks: https://github.com/lorenzwalthert/precommit
-default_stages: [commit]
+default_stages: [pre-commit]
 default_language_version:
   python: python3
 
 repos:
   - repo: https://github.com/lorenzwalthert/precommit
-    rev: v0.4.2
+    rev: v0.4.3.9003
     hooks:
       - id: style-files
         args:

R/rules-line-breaks.R

@@ -447,3 +447,28 @@ 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
+
+  # Create a copy of lag_newlines to track modifications
+  modified_lag_newlines <- pd_flat$lag_newlines
+
+  # Iterate through the dataframe to reduce consecutive blank lines
+  for (i in seq_along(modified_lag_newlines)) {
+    if (modified_lag_newlines[i] > max_lag_newlines) {
+      modified_lag_newlines[i] <- max_lag_newlines
+    }
+  }
+
+  # Update the original data frame
+  pd_flat$lag_newlines <- modified_lag_newlines
+
+  return(pd_flat)
+}

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

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(

tests/testthat/indention_curly_brackets/custom-out.R

@@ -4,7 +4,6 @@ if (value > 0) {
 }
 
 
-
 if (value > 0) {
     print(value)
 }

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)

tests/testthat/line_breaks_and_other/curly-in.R

@@ -59,3 +59,12 @@ while (TRUE){
 
 while (TRUE){#
  }
+
+
+for (i in 1:10) {}
+
+
+
+
+
+while (TRUE) {}

tests/testthat/line_breaks_and_other/curly-out.R

@@ -53,3 +53,9 @@ while (TRUE) {
 
 while (TRUE) { #
 }
+
+
+for (i in 1:10) {}
+
+
+while (TRUE) {}

tests/testthat/line_breaks_and_other/pipe_and_comment-in.R

@@ -1,2 +1,11 @@
 1:10 %>% # sum
   sum()
+
+
+f %>% g()
+
+
+
+
+
+h %>% i()

tests/testthat/line_breaks_and_other/pipe_and_comment-out.R

@@ -1,2 +1,8 @@
 1:10 %>% # sum
   sum()
+
+
+f %>% g()
+
+
+h %>% i()

tests/testthat/line_breaks_fun_call/blank-non-strict-in.R

@@ -10,6 +10,10 @@ call(
   1
 )
 
+
+
+
+
 call(
   x = 2,
   1,

tests/testthat/line_breaks_fun_call/blank-non-strict-out.R

@@ -8,6 +8,7 @@ call(
   1
 )
 
+
 call(
   x = 2,
   1,

tests/testthat/line_breaks_fun_call/blank-strict-out.R

@@ -19,7 +19,6 @@ call(
   2,
 
 
-
   # comment
 
   1,

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

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

tests/testthat/parse_comments/with_indention-out.R

@@ -18,8 +18,6 @@ call(
 # new comment
 
 
-
-
 a()
 # I think it gets boring
 # new_line here

tests/testthat/roxygen-examples-complete/13-empty-lines-out.R

@@ -9,8 +9,6 @@
 #' # two
 #'
 #'
-#'
-#'
 #' (
 #'   # more
 #'   a <- 3

tests/testthat/roxygen-examples-complete/26-empty-trailing-lines-out.R

@@ -24,7 +24,6 @@ NULL
 NULL
 
 
-
 #' this
 #'
 #' empty line after example

tests/testthat/roxygen-examples-complete/30-multiple-empty-lines-between-in.R

@@ -0,0 +1,16 @@
+#' Empty line in examples
+#'
+#' @examples
+1
+
+
+
+
+
+
+#' Empty line in examples
+#'
+#' @examples
+#' \dontrun{
+#' }
+2

tests/testthat/roxygen-examples-complete/30-multiple-empty-lines-between-out.R

@@ -0,0 +1,13 @@
+#' Empty line in examples
+#'
+#' @examples
+1
+
+
+#' Empty line in examples
+#'
+#' @examples
+#' \dontrun{
+#'
+#' }
+2

tests/testthat/test-roxygen-examples-complete-30.R

@@ -0,0 +1,5 @@
+# NB: DO NOT EDIT. Auto-generated by ./tests/dev/generate_roxygen_tests.R.
+
+test_that("analogous to test-roxygen-examples-complete: 30", {
+  expect_warning(test_collection("roxygen-examples-complete", "^30-", transformer = style_text), NA)
+})

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",

tests/testthat/token_adding_removing/mixed_token-out.R

@@ -14,7 +14,6 @@ d
 'text with "quotes"'
 
 
-
 # adding brackets in pipes
 a %>%
   b() %>%