Merge pull request #1235 from r-lib/f-single-indent

Adapt to single indent semantics in style guide

Author: lorenzwalthert

R/rules-indention.R

@@ -15,36 +15,38 @@ indent_braces <- function(pd, indent_by) {
 #'
 #' Necessary for consistent indention of the function declaration header.
 #' @param pd A parse table.
-#' @inheritParams is_double_indent_function_declaration
+#' @inheritParams is_single_indent_function_declaration
 #' @seealso set_unindention_child update_indention_ref_fun_dec
 #' @keywords internal
 unindent_fun_dec <- function(pd, indent_by = 2L) {
   if (is_function_declaration(pd)) {
     idx_closing_brace <- which(pd$token == "')'")
     fun_dec_head <- seq2(2L, idx_closing_brace)
-    if (is_double_indent_function_declaration(pd, indent_by = indent_by)) {
-      pd$indent[fun_dec_head] <- 2L * indent_by
+    if (is_single_indent_function_declaration(pd, indent_by = indent_by)) {
+      pd$indent[fun_dec_head] <- indent_by
+      pd$indent[idx_closing_brace] <- 0L
     } else {
       pd$indent[fun_dec_head] <- 0L
     }
   }
   pd
 }
 
-#' Is the function declaration double indented?
+#' Is the function declaration single indented?
 #'
 #' Assumes you already checked if it's a function with
-#' `is_function_declaration`. It is double indented if the first token
+#' `is_function_declaration`. It is single indented if the first token
 #' after the first line break that is a `"SYMBOL_FORMALS"`.
 #' @param pd A parse table.
 #' @inheritParams tidyverse_style
 #' @keywords internal
-is_double_indent_function_declaration <- function(pd, indent_by = 2L) {
+is_single_indent_function_declaration <- function(pd, indent_by = 2L) {
   head_pd <- vec_slice(pd, -nrow(pd))
   line_break_in_header <- which(head_pd$lag_newlines > 0L & head_pd$token == "SYMBOL_FORMALS")
   if (length(line_break_in_header) > 0L) {
     # indent results from applying the rules, spaces is the initial spaces
     # (which is indention if a newline is ahead)
+    # The 2L factor is kept to convert double indent to single indent
     pd$spaces[line_break_in_header[1L] - 1L] <= 2L * indent_by
   } else {
     FALSE
@@ -132,7 +134,7 @@ NULL
 #'
 #' @keywords internal
 update_indention_ref_fun_dec <- function(pd_nested) {
-  if (is_function_declaration(pd_nested) && !is_double_indent_function_declaration(pd_nested)) {
+  if (is_function_declaration(pd_nested) && !is_single_indent_function_declaration(pd_nested)) {
     seq <- seq2(3L, nrow(pd_nested) - 2L)
     pd_nested$indention_ref_pos_id[seq] <- pd_nested$pos_id[2L]
   }

R/rules-line-breaks.R

@@ -236,15 +236,17 @@ remove_line_break_before_round_closing_after_curly <- function(pd) {
 
 remove_line_breaks_in_fun_dec <- function(pd) {
   if (is_function_declaration(pd)) {
-    is_double_indention <- is_double_indent_function_declaration(pd)
+    is_single_indention <- is_single_indent_function_declaration(pd)
     round_after <- (
       pd$token == "')'" | pd$token_before == "'('"
     ) &
       pd$token_before != "COMMENT"
     pd$lag_newlines[pd$lag_newlines > 1L] <- 1L
-    pd$lag_newlines[round_after] <- 0L
-    if (is_double_indention) {
+    if (is_single_indention) {
       pd$lag_newlines[lag(pd$token == "'('")] <- 1L
+      pd$lag_newlines[round_after] <- 1L
+    } else {
+      pd$lag_newlines[round_after] <- 0L
     }
   }
   pd

man/is_double_indent_function_declaration.Rd renamed to man/is_single_indent_function_declaration.Rd

@@ -40,8 +40,9 @@ a <- function(x,
 }
 
 a <- function(
-    #
-    x,
-    y) {
+  #
+  x,
+  y
+) {
   x - 1
 }

tests/testthat/fun_dec/line_break_fun_dec-out.R

@@ -1,27 +1,27 @@
 function(a =
-      33,
-    b
-    ) {}
+    33,
+  b
+) {}
 
 function(a =
-      33,
-    b) {}
+    33,
+  b) {}
 
 function(a,
-    b,
-    c
-    ) {}
+  b,
+  c
+) {}
 
 function(a,
-    b,
-    c) {}
+  b,
+  c) {}
 
 function(ss,
-    a =
-      3,
-    er =
-      4
-    ) {}
+  a =
+    3,
+  er =
+    4
+) {}
 
 function(a =
            b,

tests/testthat/indention_operators/eq_formals_complex_indention-out.R

@@ -1,29 +1,34 @@
 function(
-    a =
-      33,
-    b) {}
+  a =
+    33,
+  b
+) {}
 
 function(
-    a =
-      33,
-    b) {}
+  a =
+    33,
+  b
+) {}
 
 function(
-    a,
-    b,
-    c) {}
+  a,
+  b,
+  c
+) {}
 
 function(
-    a,
-    b,
-    c) {}
+  a,
+  b,
+  c
+) {}
 
 function(
-    ss,
-    a =
-      3,
-    er =
-      4) {}
+  ss,
+  a =
+    3,
+  er =
+    4
+) {}
 
 function(a =
            b,

tests/testthat/indention_operators/eq_formals_complex_tokens-out.R

@@ -10,8 +10,8 @@ b
 # multiple nested levels
 {
   v <- function(x =
-        122,
-      y) {
+      122,
+    y) {
   }
 }
 

tests/testthat/indention_operators/eq_sub_complex_indention-out.R

@@ -37,29 +37,33 @@ function(x,
 
 # double
 function(
-    x,
-    y) {
+  x,
+  y
+) {
   1
 }
 
 
 function(
-    x,
-    y,
-    k) {
+  x,
+  y,
+  k
+) {
   1
 }
 
 
 function(
-    x,
-    y) {
+  x,
+  y
+) {
   1
 }
 
 
 function(
-    x, y) {
+  x, y
+) {
   1
 }
 
@@ -72,23 +76,23 @@ function(x,
 
 # last brace
 function(
-    x, y) {
+  x, y) {
   NULL
 }
 
 function(
-    x, y) {
+  x, y) {
   NULL
 }
 
 function(
-    x,
-    y) {
+  x,
+  y) {
   NULL
 }
 
 function(
-    x,
-    y) {
+  x,
+  y) {
   NULL
 }