Add param require_multi_line to brace_linter()

NEWS.md

@@ -20,6 +20,7 @@
 * `object_name_linter()` no longer attempts to lint strings in function calls on the LHS of assignments (#1466, @MichaelChirico).
 * `infix_spaces_linter()` allows finer control for linting `=` in different scenarios using parse tags `EQ_ASSIGN`, `EQ_SUB`, and `EQ_FORMALS` (#1977, @MichaelChirico).
 * `equals_na_linter()` checks for `x %in% NA`, which is a more convoluted form of `is.na(x)` (#2088, @MichaelChirico).
+* `brace_linter()` does not require functions spanning multiple lines to be wrapped in curly braces anymore if `require_multi_line = FALSE` (#1807, #?, @salim-b).
 
 ## New and improved features
 

R/brace_linter.R

@@ -10,7 +10,8 @@
 #' does.
 #' - Functions spanning multiple lines use curly braces.
 #'
-#' @param allow_single_line if `TRUE`, allow an open and closed curly pair on the same line.
+#' @param allow_single_line If `TRUE`, allow an open and closed curly pair on the same line.
+#' @param require_multi_line If `TRUE`, require functions spanning multiple lines to be wrapped in curly braces.
 #'
 #' @examples
 #' # will produce lints
@@ -50,7 +51,8 @@
 #' - <https://style.tidyverse.org/syntax.html#indenting>
 #' - <https://style.tidyverse.org/syntax.html#if-statements>
 #' @export
-brace_linter <- function(allow_single_line = FALSE) {
+brace_linter <- function(allow_single_line = FALSE,
+ require_multi_line = TRUE) {
  xp_cond_open <- xp_and(c(
  # matching } is on same line
  if (isTRUE(allow_single_line)) {
@@ -192,14 +194,16 @@ brace_linter <- function(allow_single_line = FALSE) {
  )
  )
 
- lints <- c(
- lints,
- xml_nodes_to_lints(
- xml_find_all(xml, xp_function_brace),
- source_expression = source_expression,
- lint_message = "Any function spanning multiple lines should use curly braces."
+ if (isTRUE(require_multi_line)) {
+ lints <- c(
+ lints,
+ xml_nodes_to_lints(
+ xml_find_all(xml, xp_function_brace),
+ source_expression = source_expression,
+ lint_message = "Any function spanning multiple lines should use curly braces."
+ )
  )
- )
+ }
 
  lints <- c(
  lints,

tests/testthat/test-brace_linter.R

@@ -318,6 +318,11 @@ test_that("brace_linter lints function expressions correctly", {
  rex::rex("Any function spanning multiple lines should use curly braces."),
  linter
  )
+ expect_lint(
+ lines,
+ NULL,
+ brace_linter(require_multi_line = FALSE)
+ )
 })
 
 test_that("brace_linter lints if/else matching braces correctly", {