Merge pull request #640 from michaelquinn32/communication

- Add option for suppressing styler communication (#640).

Author: lorenzwalthert

NEWS.md

@@ -8,6 +8,8 @@
   to not directly modify test files in the current directory (#548).
 - `style_file()` and friends gain argument `dry` to control if changes should 
   be applied to files or not (#634).
+- added an option for disabling all communication when using the package
+  (`styler.quiet`) (#640).
 
 ## Minor chnages and fixes
 
@@ -439,3 +441,4 @@ specify_reindention(
 )
 initialize_default_attributes(pd_flat)
 ```
+

R/addins.R

@@ -153,7 +153,9 @@ get_addins_style_transformer <- function() {
 
 communicate_addins_style_transformers <- function() {
   style_name <- get_addins_style_transformer_name()
-  cat("Using style transformers `", style_name, "`\n", sep = "")
+  if (!getOption("styler.quiet", FALSE)) {
+    cat("Using style transformers `", style_name, "`\n", sep = "")
+  }
 }
 
 #' Style a file as if it was an .R file

R/communicate.R

@@ -7,7 +7,10 @@
 #' @inheritParams can_verify_roundtrip
 #' @keywords internal
 communicate_warning <- function(changed, transformers) {
-  if (any(changed, na.rm = TRUE) && !can_verify_roundtrip(transformers)) {
+  if (any(changed, na.rm = TRUE) && 
+    !can_verify_roundtrip(transformers) &&
+    !getOption("styler.quiet", FALSE)
+  ) {
     cat("Please review the changes carefully!", fill = TRUE)
   }
 }
@@ -19,12 +22,14 @@ communicate_warning <- function(changed, transformers) {
 #' @param ruler_width Integer used to determine the width of the ruler.
 #' @keywords internal
 communicate_summary <- function(changed, ruler_width) {
-  cli::cat_rule(width = max(40, ruler_width))
-  cat("Status\tCount\tLegend \n")
-  cli::cat_bullet("\t", sum(!changed, na.rm = TRUE), "\tFile unchanged.", bullet = "tick")
-  cli::cat_bullet("\t", sum(changed, na.rm = TRUE), "\tFile changed.", bullet = "info")
-  cli::cat_bullet(bullet = "cross", "\t", sum(is.na(changed)), "\tStyling threw an error.")
-  cli::cat_rule(width = max(40, ruler_width))
+  if (!getOption("styler.quiet", FALSE)) {
+    cli::cat_rule(width = max(40, ruler_width))
+    cat("Status\tCount\tLegend \n")
+    cli::cat_bullet("\t", sum(!changed, na.rm = TRUE), "\tFile unchanged.", bullet = "tick")
+    cli::cat_bullet("\t", sum(changed, na.rm = TRUE), "\tFile changed.", bullet = "info")
+    cli::cat_bullet(bullet = "cross", "\t", sum(is.na(changed)), "\tStyling threw an error.")
+    cli::cat_rule(width = max(40, ruler_width))
+  }
 }
 
 #' @importFrom rlang abort

R/transform-files.R

@@ -15,7 +15,7 @@ transform_files <- function(files, transformers, include_roxygen_examples, dry)
   transformer <- make_transformer(transformers, include_roxygen_examples)
   max_char <- min(max(nchar(files), 0), getOption("width"))
   len_files <- length(files)
-  if (len_files > 0L) {
+  if (len_files > 0L && !getOption("styler.quiet", FALSE)) {
     cat("Styling ", len_files, " files:\n")
   }
 
@@ -51,16 +51,20 @@ transform_file <- function(path,
   max_char_after_message_path <- nchar(message_before) + max_char_path + 1
   n_spaces_before_message_after <-
     max_char_after_message_path - char_after_path
-  cat(
-    message_before, path,
-    rep_char(" ", max(0L, n_spaces_before_message_after)),
-    append = FALSE
-  )
+  if (!getOption("styler.quiet", FALSE)) {
+      cat(
+        message_before, path,
+        rep_char(" ", max(0L, n_spaces_before_message_after)),
+        append = FALSE
+      )
+    }
   changed <- transform_code(path, fun = fun, ..., dry = dry)
 
   bullet <- ifelse(is.na(changed), "warning", ifelse(changed, "info", "tick"))
 
-  cli::cat_bullet(bullet = bullet)
+  if (!getOption("styler.quiet", FALSE)) {
+    cli::cat_bullet(bullet = bullet)
+  }
   invisible(changed)
 }
 

R/zzz.R

@@ -7,6 +7,7 @@
     styler.addins_style_transformer = "styler::tidyverse_style()",
     styler.ignore_start = "# styler: off",
     styler.ignore_stop = "# styler: on",
+    styler.quiet = FALSE,
     styler.test_dir_writable = TRUE
   )
   toset <- !(names(op.styler) %in% names(op))

tests/testthat/test-public_api.R

@@ -197,6 +197,20 @@ test_that("messages (via cat()) of style_file are correct", {
   }
 })
 
+test_that("Messages can be suppressed", {
+  for (encoding in ls_testable_encodings()) {
+    withr::with_options(
+      list(cli.unicode = encoding == "utf8", styler.quiet = TRUE),
+      {
+        output <- catch_style_file_output(c(
+          "public-api", "xyzdir-dirty", "dirty-sample-with-scope-spaces.R"
+        ), encoding = encoding)
+        expect_equal(output, character(0))
+      }
+    )
+  }
+})
+
 context("public API - Rmd in style_dir()")
 
 test_that("styler can style R and Rmd files via style_dir()", {