r-lib · lorenzwalthert · Dec 26, 2022 · Nov 8, 2022 · Nov 9, 2022 · Nov 9, 2022
diff --git a/R/roxygen-examples.R b/R/roxygen-examples.R
@@ -77,8 +77,7 @@ style_roxygen_code_example_segment <- function(one_dont,
   }
   dont_seqs <- find_dont_seqs(one_dont)
   split_segments <- split_roxygen_segments(one_dont, unlist(dont_seqs))
-  is_dont <-
-    seq2(1L, length(split_segments$separated)) %in% split_segments$selectors
+  is_dont <- seq2(1L, length(split_segments$separated)) %in% split_segments$selectors
 
   map2(split_segments$separated, is_dont,
     style_roxygen_example_snippet,

diff --git a/R/transform-block.R b/R/transform-block.R
@@ -51,7 +51,10 @@ parse_transform_serialize_r_block <- function(pd_nested,
     ) %>%
       unlist(use.names = FALSE)
   }
-  c(rep("", start_line - 1L), serialized_transformed_text)
+  c(
+    rep("", if (start_line == 0L) start_line else start_line - 1L),
+    serialized_transformed_text
+  )
 }
 
 #' Find the groups of expressions that should be processed together

diff --git a/R/transform-files.R b/R/transform-files.R
@@ -53,8 +53,8 @@ transform_file <- function(path,
                            message_after_if_changed = " *",
                            ...,
                            dry) {
-  char_after_path <- nchar(message_before) + nchar(path) + 1
-  max_char_after_message_path <- nchar(message_before) + max_char_path + 1
+  char_after_path <- nchar(message_before) + nchar(path) + 1L
+  max_char_after_message_path <- nchar(message_before) + max_char_path + 1L
   n_spaces_before_message_after <-
     max_char_after_message_path - char_after_path
   if (!getOption("styler.quiet", FALSE)) {
@@ -256,14 +256,21 @@ parse_transform_serialize_r <- function(text,
     transformers
   )
 
+  strict <- transformers$more_specs_style_guide$strict
   pd_split <- unname(split(pd_nested, pd_nested$block))
   pd_blank <- find_blank_lines_to_next_block(pd_nested)
 
+  start_line <- if (strict) {
+    1L # FIXME: should be 0L for roxygen examples
+  } else {
+    pd_blank[[i]]
+  }
+
   text_out <- vector("list", length(pd_split))
   for (i in seq_along(pd_split)) {
     text_out[[i]] <- parse_transform_serialize_r_block(
       pd_split[[i]],
-      pd_blank[[i]],
+      start_line = start_line,
       transformers = transformers,
       base_indention = base_indention
     )

diff --git a/tests/testthat/curly-curly/mixed-out.R b/tests/testthat/curly-curly/mixed-out.R
@@ -1,4 +1,3 @@
-
 ##  ............................................................................
 ##  line breaks                                                             ####
 # not inserting line breaks

diff --git a/tests/testthat/escaping/basic-escape-out.R b/tests/testthat/escaping/basic-escape-out.R
@@ -1,28 +1,24 @@
 #' things
 #'
-#' @examples
-#' call("\\.")
+#' @examples call("\\.")
 NULL
 
 
 #' things
 #'
-#' @examples
-#' call("\n")
+#' @examples call("\n")
 NULL
 
 #' things
 #'
-#' @examples
-#' call("\n")
+#' @examples call("\n")
 #' ano("\\.", further = X)
 NULL
 
 
 #' things
 #'
-#' @examples
-#' call("\n")
+#' @examples call("\n")
 #' ano("\\.", further = X)
 NULL
 

diff --git a/tests/testthat/indention_curly_brackets/custom-out.R b/tests/testthat/indention_curly_brackets/custom-out.R
@@ -1,4 +1,3 @@
-
 value <- 5
 if (value > 0) {
     print(value)

diff --git a/tests/testthat/indention_square_brackets/square_brackets_double_line_break-in_tree b/tests/testthat/indention_square_brackets/square_brackets_double_line_break-in_tree
diff --git a/tests/testthat/line_breaks_and_other/base-pipe-line-breaks-out.R b/tests/testthat/line_breaks_and_other/base-pipe-line-breaks-out.R
@@ -1,4 +1,3 @@
-
 c(a |> b())
 
 c(a + b |> c())

diff --git a/tests/testthat/public-api/renvpkg/tests/testthat/test-package-xyz.R b/tests/testthat/public-api/renvpkg/tests/testthat/test-package-xyz.R
@@ -1,5 +1,3 @@
-
-
 test_that("hi there", {
   I(am(a(package(x))))
 })
diff --git a/tests/testthat/public-api/xyzpackage-qmd/tests/testthat/test-package-xyz.R b/tests/testthat/public-api/xyzpackage-qmd/tests/testthat/test-package-xyz.R
@@ -1,5 +1,3 @@
-
-
 test_that("hi there", {
   I(am(a(package(x))))
 })
diff --git a/tests/testthat/public-api/xyzpackage-rmd/tests/testthat/test-package-xyz.R b/tests/testthat/public-api/xyzpackage-rmd/tests/testthat/test-package-xyz.R
@@ -1,5 +1,3 @@
-
-
 test_that("hi there", {
   I(am(a(package(x))))
 })
diff --git a/tests/testthat/public-api/xyzpackage-rnw/tests/testthat/test-package-xyz.R b/tests/testthat/public-api/xyzpackage-rnw/tests/testthat/test-package-xyz.R
@@ -1,5 +1,3 @@
-
-
 test_that("hi there", {
   I(am(a(package(x))))
 })
diff --git a/tests/testthat/public-api/xyzpackage/tests/testthat/test-package-xyz.R b/tests/testthat/public-api/xyzpackage/tests/testthat/test-package-xyz.R
@@ -1,5 +1,3 @@
-
-
 test_that("hi there", {
   I(am(a(package(x))))
 })
diff --git a/tests/testthat/roxygen-examples-complete/10-styler-r-ui-out.R b/tests/testthat/roxygen-examples-complete/10-styler-r-ui-out.R
@@ -113,8 +113,7 @@ prettify_pkg <- function(transformers,
 #' @param text A character vector with text to style.
 #' @inheritParams style_pkg
 #' @family stylers
-#' @examples
-#' style_text("call( 1)")
+#' @examples style_text("call( 1)")
 #' style_text("1    + 1", strict = FALSE)
 #' style_text("a%>%b", scope = "spaces")
 #' style_text("a%>%b; a", scope = "line_breaks")
@@ -199,8 +198,7 @@ prettify_any <- function(transformers,
 #' @inheritSection transform_files Value
 #' @inheritSection style_pkg Warning
 #' @inheritSection style_pkg Roundtrip Validation
-#' @examples
-#' # the following is identical but the former is more convenient:
+#' @examples # the following is identical but the former is more convenient:
 #' file <- tempfile("styler", fileext = ".R")
 #' xfun::write_utf8("1++1", file)
 #' style_file(file, style = tidyverse_style, strict = TRUE)

diff --git a/tests/testthat/roxygen-examples-complete/12-dontshow-dontrun-donttest-out.R b/tests/testthat/roxygen-examples-complete/12-dontshow-dontrun-donttest-out.R
@@ -1,10 +1,8 @@
-
 #' Create a style guide
 #'
 #' @param reindention A list of parameters for regex re-indention, most
 #'   conveniently constructed using [specify_reindention()].
-#' @examples
-#' set_line_break_before_crly_opening <- function(pd_flat) {
+#' @examples set_line_break_before_crly_opening <- function(pd_flat) {
 #'   op <- pd_flat$token %in% "'{'"
 #'   pd_flat$lag_newlines[op] <- 1L
 #'   pd_flat
@@ -51,8 +49,7 @@ create_style_guide <- function(initialize = default_style_guide_attributes,
 #'
 #' @param reindention A list of parameters for regex re-indention, most
 #'   conveniently constructed using [specify_reindention()].
-#' @examples
-#' set_line_break_before_crly_opening <- function(pd_flat) {
+#' @examples set_line_break_before_crly_opening <- function(pd_flat) {
 #'   op <- pd_flat$token %in% "'{'"
 #'   pd_flat$lag_newlines[op] <- 1L
 #'   pd_flat

diff --git a/tests/testthat/roxygen-examples-complete/12-fun-decs-in-examples-out.R b/tests/testthat/roxygen-examples-complete/12-fun-decs-in-examples-out.R
@@ -1,10 +1,8 @@
-
 #' Create a style guide
 #'
 #' @param reindention A list of parameters for regex re-indention, most
 #'   conveniently constructed using [specify_reindention()].
-#' @examples
-#' set_line_break_before_crly_opening <- function(pd_flat) {
+#' @examples set_line_break_before_crly_opening <- function(pd_flat) {
 #'   op <- pd_flat$token %in% "'{'"
 #'   pd_flat$lag_newlines[op] <- 1L
 #'   pd_flat

diff --git a/tests/testthat/roxygen-examples-complete/13-empty-lines-out.R b/tests/testthat/roxygen-examples-complete/13-empty-lines-out.R
@@ -1,10 +1,8 @@
-
 #' Create a style guide
 #'
 #' @param reindention A list of parameters for regex re-indention, most
 #'   conveniently constructed using [specify_reindention()].
-#' @examples
-#' # empty
+#' @examples # empty
 #'
 #'
 #' # two

diff --git a/tests/testthat/roxygen-examples-complete/14-pipe-dontrun-out.R b/tests/testthat/roxygen-examples-complete/14-pipe-dontrun-out.R
@@ -1,8 +1,7 @@
 #' Hi
 #'
 #' x
-#' @examples
-#' a %>%
+#' @examples a %>%
 #'   x(b = 3) %>%
 #'   ff()
 #' \dontrun{

diff --git a/tests/testthat/roxygen-examples-complete/16-dont-warn-empty-out.R b/tests/testthat/roxygen-examples-complete/16-dont-warn-empty-out.R
@@ -1,8 +1,7 @@
 #' Do stuff
 #'
 #' Some things we do
-#' @examples
-#' g()
+#' @examples g()
 #' \dontrun{
 #' f(x)
 #' }

diff --git a/tests/testthat/roxygen-examples-complete/17-two-no-non-comment-out.R b/tests/testthat/roxygen-examples-complete/17-two-no-non-comment-out.R
@@ -1,5 +1,4 @@
-#' @examples
-#' my_fun <- function() {
+#' @examples my_fun <- function() {
 #'   print("hello world!")
 #' }
 #' # before this comment is a left-over space

diff --git a/tests/testthat/roxygen-examples-complete/19-escaped-slash-out.R b/tests/testthat/roxygen-examples-complete/19-escaped-slash-out.R
@@ -1,7 +1,6 @@
 #' Data frame and Tables Pretty Formatting
 #'
-#' @examples
-#' c("\nA \\nyellow \\\nline", "yellow")
+#' @examples c("\nA \\nyellow \\\nline", "yellow")
 #' c("\ A \\ nyellow \\\ nline", "yellow")
 #' \dontrun{
 #' c("\nA \\nyellow \\\nline", "yellow")

diff --git a/tests/testthat/roxygen-examples-complete/2-one-function-examples-last-proper-run-out.R b/tests/testthat/roxygen-examples-complete/2-one-function-examples-last-proper-run-out.R
@@ -3,8 +3,7 @@
 #' Performs various substitutions in all `.R` files in a package
 #' (code and tests).
 #' Carefully examine the results after running this function!
-#' @examples
-#' style_pkg(style = tidyverse_style, strict = TRUE)
+#' @examples style_pkg(style = tidyverse_style, strict = TRUE)
 #' style_pkg(
 #'   scope = "line_breaks",
 #'   math_token_spacing = specify_math_token_spacing(zero = "'+'")

diff --git a/tests/testthat/roxygen-examples-complete/22-exampleIf-example-mixed-out.R b/tests/testthat/roxygen-examples-complete/22-exampleIf-example-mixed-out.R
@@ -4,8 +4,7 @@
 #' @family some
 #' @examplesIf TRUE
 #' c()
-#' @examples
-#' x <- 2
+#' @examples x <- 2
 #' @importFrom purrr partial
 #' @export
 x <- 3
@@ -14,8 +13,7 @@ x <- 3
 #'
 #' Style code according to the bli blauuu2 guide.
 #' @family not
-#' @examples
-#' x <- 2
+#' @examples x <- 2
 #' @examplesIf TRUE
 #' c()
 #' @export