Merge pull request #1068 from r-lib/check_examples

Check if all examples run successfully

Author: IndrajeetPatil

.github/workflows/check-all-examples.yaml

@@ -0,0 +1,42 @@
+# Make sure all examples run successfully, even the ones that are not supposed
+# to be run or tested on CRAN machines by default.
+#
+# The examples that fail should use
+#  - `if (FALSE) { ... }` (if example is included only for illustrative purposes)
+#  - `try({ ... })` (if the intent is to show the error)
+#
+# This workflow helps find such failing examples that need to be modified.
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+
+name: check-all-examples
+
+jobs:
+  check-all-examples:
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          pak-version: devel
+          extra-packages: |
+            any::devtools
+            local::.
+
+      - name: Run examples
+        run: |
+          options(crayon.enabled = TRUE)
+          devtools::run_examples(fresh = TRUE, run_dontrun = TRUE, run_donttest = TRUE)
+        shell: Rscript {0}

R/parse.R

@@ -8,12 +8,11 @@
 #' @param ... Parameters passed to [base::parse()].
 #' @keywords internal
 #' @examples
-#' \dontrun{
-#' styler:::parse_safely("a + 3 -4 -> x\r\n glück + 1")
+#' try(styler:::parse_safely("a + 3 -4 -> x\r\n glück + 1"))
 #' # This cannot be detected as a EOL style problem because the first
 #' # line ends as expected with \n
-#' styler:::parse_safely("a + 3 -4 -> x\nx + 2\r\n glück + 1")
-#' }
+#' try(styler:::parse_safely("a + 3 -4 -> x\nx + 2\r\n glück + 1"))
+#'
 #' styler:::parse_safely("a + 3 -4 -> \n glück + 1")
 parse_safely <- function(text, ...) {
   tried_parsing <- rlang::with_handlers(

R/rules-line-breaks.R

@@ -10,48 +10,48 @@
 #'   line trigger.
 #' @keywords internal
 #' @examples
-#' \dontrun{
-#' tryCatch(
-#'   {
-#'     f(8)
-#'   },
-#'   error = function(e) NULL
-#' )
-#' # last-argument case
-#' testthat("braces braces are cool", {
-#'   code(to = execute)
-#' })
-#' call2(
-#'   x = 2, {
+#' if (FALSE) {
+#'   tryCatch(
+#'     {
+#'       f(8)
+#'     },
+#'     error = function(e) NULL
+#'   )
+#'   # last-argument case
+#'   testthat("braces braces are cool", {
 #'     code(to = execute)
-#'   },
-#'   c = {
-#'     # this is the named case
-#'     g(x = 7)
-#'   }
-#' )
-#' tryGugus(
-#'   {
-#'     g5(k = na)
-#'   },
-#'   a + b # line break also here because
-#'   # preceded by brace expression
-#' )
+#'   })
+#'   call2(
+#'     x = 2, {
+#'       code(to = execute)
+#'     },
+#'     c = {
+#'       # this is the named case
+#'       g(x = 7)
+#'     }
+#'   )
+#'   tryGugus(
+#'     {
+#'       g5(k = na)
+#'     },
+#'     a + b # line break also here because
+#'     # preceded by brace expression
+#'   )
 #'
-#' # brace expressions go on new line if part of a pipe, in function call...
-#' c(
+#'   # brace expressions go on new line if part of a pipe, in function call...
+#'   c(
+#'     data %>%
+#'       filter(bar) %>%
+#'       {
+#'         cor(.$col1, .$col2, use = "complete.obs")
+#'       }
+#'   )
+#'   # ... or outside
 #'   data %>%
 #'     filter(bar) %>%
 #'     {
 #'       cor(.$col1, .$col2, use = "complete.obs")
 #'     }
-#' )
-#' # ... or outside
-#' data %>%
-#'   filter(bar) %>%
-#'   {
-#'     cor(.$col1, .$col2, use = "complete.obs")
-#'   }
 #' }
 set_line_break_before_curly_opening <- function(pd) {
   line_break_to_set_idx <- which(

R/set-assert-args.R

@@ -56,9 +56,7 @@ assert_transformers <- function(transformers) {
 #'   standard format.
 #' @examples
 #' styler:::set_and_assert_arg_filetype("rMd")
-#' \dontrun{
-#' styler:::set_and_assert_arg_filetype("xyz")
-#' }
+#' try(styler:::set_and_assert_arg_filetype("xyz"))
 #' @keywords internal
 set_and_assert_arg_filetype <- function(filetype) {
   without_dot <- gsub("^\\.", "", tolower(filetype))

R/transform-files.R

@@ -397,9 +397,7 @@ parse_tree_must_be_identical <- function(transformers) {
 #' @examples
 #' styler:::verify_roundtrip("a+1", "a + 1")
 #' styler:::verify_roundtrip("a+1", "a + 1 # comments are dropped")
-#' \dontrun{
-#' styler:::verify_roundtrip("a+1", "b - 3")
-#' }
+#' try(styler:::verify_roundtrip("a+1", "b - 3"))
 #' @keywords internal
 verify_roundtrip <- function(old_text, new_text, parsable_only = FALSE) {
   if (parsable_only) {

R/ui-styling.R

@@ -49,21 +49,21 @@
 #' @inheritSection transform_files Value
 #' @family stylers
 #' @examples
-#' \dontrun{
-#' # the following is identical (because of ... and defaults)
-#' # but the first is most convenient:
-#' style_pkg(strict = TRUE)
-#' style_pkg(style = tidyverse_style, strict = TRUE)
-#' style_pkg(transformers = tidyverse_style(strict = TRUE))
+#' if (FALSE) {
+#'   # the following is identical (because of ... and defaults)
+#'   # but the first is most convenient:
+#'   style_pkg(strict = TRUE)
+#'   style_pkg(style = tidyverse_style, strict = TRUE)
+#'   style_pkg(transformers = tidyverse_style(strict = TRUE))
 #'
-#' # more options from `tidyverse_style()`
-#' style_pkg(
-#'   scope = "line_breaks",
-#'   math_token_spacing = specify_math_token_spacing(zero = "'+'")
-#' )
+#'   # more options from `tidyverse_style()`
+#'   style_pkg(
+#'     scope = "line_breaks",
+#'     math_token_spacing = specify_math_token_spacing(zero = "'+'")
+#'   )
 #'
-#' # don't write back and fail if input is not already styled
-#' style_pkg("/path/to/pkg/", dry = "fail")
+#'   # don't write back and fail if input is not already styled
+#'   style_pkg("/path/to/pkg/", dry = "fail")
 #' }
 #' @export
 style_pkg <- function(pkg = ".",
@@ -236,14 +236,14 @@ style_text <- function(text,
 #' @inheritSection style_pkg Round trip validation
 #' @family stylers
 #' @examples
-#' \dontrun{
-#' style_dir("path/to/dir", filetype = c("rmd", ".R"))
+#' if (FALSE) {
+#'   style_dir("path/to/dir", filetype = c("rmd", ".R"))
 #'
-#' # the following is identical (because of ... and defaults)
-#' # but the first is most convenient:
-#' style_dir(strict = TRUE)
-#' style_dir(style = tidyverse_style, strict = TRUE)
-#' style_dir(transformers = tidyverse_style(strict = TRUE))
+#'   # the following is identical (because of ... and defaults)
+#'   # but the first is most convenient:
+#'   style_dir(strict = TRUE)
+#'   style_dir(style = tidyverse_style, strict = TRUE)
+#'   style_dir(transformers = tidyverse_style(strict = TRUE))
 #' }
 #' @export
 style_dir <- function(path = ".",