Merge pull request #500 from lorenzwalthert/addin-select-style

- More flexibility with Addin (#500).

Author: lorenzwalthert

.Rbuildignore

@@ -16,3 +16,4 @@ CONTRIBUTING.md
 ^gitsum$
 revdep
 ^cran-comments\.md$
+^tests/testmanual$

R/addins.R

@@ -1,29 +1,55 @@
 #' Stylers for RStudio Addins
 #'
 #' Helper functions for styling via RStudio Addins.
-#'
+#' @section Addins:
+#' - Set style: Select the style transformers to use. For flexibility, the user
+#'   input is passed to the `transformers` argument, not the `style` argument, so
+#'   entering `styler::tidyverse_style(scope = "spaces")` in the Addin is
+#'   equivalent to `styler::style_text("1+1", scope = "spaces")` and
+#'   `styler::style_text("1+1", transformers = styler::tidyverse_style(scope = "spaces"))`
+#'   if the text to style is `1+1`. The style transformers are memorized
+#'   within an R session via the R option `styler.addins_style_transformer` so
+#'   if you want it to persist over sessions, set the option
+#'   `styler.addins_style_transformer` in your `.Rprofile`.
+#' - Style active file: Styles the active file, by default with
+#'   [tidyverse_style()] or the value of the option
+#'   `styler.addins_style_transformer` if specified.
+#' - Style selection: Same as *Style active file*, but styles the highlighted
+#'   code instead of the whole file.
 #' @section Auto-Save Option:
 #' By default, both of the RStudio Addins will apply styling to the (selected)
 #' file contents without saving changes. Automatic saving can be enabled by
 #' setting the environment variable `save_after_styling` to `TRUE`.
-#'
 #' Consider setting this in your `.Rprofile` file if you want to persist
 #' this setting across multiple sessions. Untitled files will always need to be
 #' saved manually after styling.
-#'
+#' @section Life cycle:
+#' The way of specifying the style in the Addin as well as the auto-save option
+#' (see below) are experimental. We are currently considering letting the user
+#' specify the defaults for other style APIs like [styler::style_text()],
+#' either via R options, config files or other ways as well.
+#' See [r-lib/styler#319](https://github.com/r-lib/styler/issues/319) for
+#' the current status of this.
 #' @name styler_addins
 #' @family stylers
-#' @seealso [Sys.setenv()]
+#' @examples
+#' \dontrun{
+#' # save after styling when using the Addin
+#' Sys.setenv(save_after_styling = TRUE)
+#' # only style with scope = "spaces" when using the Addin
+#' options(
+#'   styler.addins_style_transformer = "styler::tidyverse_style(scope = 'spaces')"
+#' )
+#' }
 NULL
 
-#' @describeIn styler_addins Styles the active file with [tidyverse_style()] and
-#'   `strict = TRUE`.
+
 #' @importFrom rlang abort
 #' @keywords internal
 style_active_file <- function() {
-  communicate_addins_style()
+  communicate_addins_style_transformers()
   context <- get_rstudio_context()
-  transformer <- make_transformer(get_addins_style_fun()(),
+  transformer <- make_transformer(get_addins_style_transformer(),
     include_roxygen_examples = TRUE, warn_empty = is_plain_r_file(context$path)
   )
 
@@ -47,96 +73,106 @@ style_active_file <- function() {
   rstudioapi::setCursorPosition(context$selection[[1]]$range)
 }
 
-#' Style a file as if it was an .R file
-#'
-#' If not successful, the file is most
-#' likely not a .R file, so saving the file and try styling again will work if
-#' the file is an .Rmd file. Otherwise, we can throw an error that the file must
-#' be a .R or .Rmd file.
-#' @param context The context from `styler:::get_rstudio_context()`.
-#' @param transformer A transformer function most conveniently constructed with
-#'   [make_transformer()].
-#' @importFrom rlang with_handlers abort
+#' Wrapper around [style_pkg()] for access via Addin.
 #' @keywords internal
-try_transform_as_r_file <- function(context, transformer) {
-  with_handlers(
-    transformer(context$contents),
-    error = function(e) {
-      preamble_for_unsaved <- paste(
-        "Styling of unsaved files is only supported for R files with valid code.",
-        "Please save the file (as .R or .Rmd) and make sure that the R code in it",
-        "can be parsed. Then, try to style again."
-      )
-
-      if (context$path == "") {
-        abort(paste0(preamble_for_unsaved, " The error was \n", e$message))
-      } else {
-        abort(e$message)
-      }
-    }
-  )
+style_active_pkg <- function() {
+  communicate_addins_style_transformers()
+  style_pkg(transformers = get_addins_style_transformer())
 }
 
-#' @describeIn styler_addins Styles the highlighted selection in a `.R` or
-#'   `.Rmd` file.
+#' Styles the highlighted selection in a `.R` or `.Rmd` file.
 #' @importFrom rlang abort
 #' @keywords internal
 style_selection <- function() {
-  communicate_addins_style()
+  communicate_addins_style_transformers()
   context <- get_rstudio_context()
   text <- context$selection[[1]]$text
   if (all(nchar(text) == 0)) abort("No code selected")
-  out <- style_text(text, style = get_addins_style_fun())
+  out <- style_text(text, transformers = get_addins_style_transformer())
   rstudioapi::modifyRange(
     context$selection[[1]]$range, paste0(out, collapse = "\n"),
     id = context$id
   )
   if (Sys.getenv("save_after_styling") == TRUE && context$path != "") {
-    rstudioapi::documentSave(context$id)
+    invisible(rstudioapi::documentSave(context$id))
   }
 }
 
 get_rstudio_context <- function() {
   rstudioapi::getActiveDocumentContext()
 }
 
-#' Ask the user to supply a style
-#'
+#' Asks the user to supply a style
 #' @importFrom rlang abort
 #' @keywords internal
 #' @importFrom rlang with_handlers abort
-prompt_style <- function() {
-  current_style <- get_addins_style_name()
+set_style_transformers <- function() {
+  current_style <- get_addins_style_transformer_name()
   new_style <-
     rstudioapi::showPrompt(
       "Select a style",
-      "Enter the name of a style function, e.g. `styler::tidyverse_style`",
+      "Enter the name of a style transformer, e.g. `styler::tidyverse_style()`",
       current_style
     )
-  parsed_new_style <- with_handlers(
-    eval(parse(text = new_style)),
+  parsed_new_style <- with_handlers({
+    transformers <- eval(parse(text = new_style))
+    style_text(c("a = 2", "function() {", "NULL", "}"))
+    },
     error = function(e) {
-      abort(paste0("The selected style \"", new_style, "\" is not valid: ", e$message))
+      abort(paste0(
+        "The selected style transformers \"",
+        new_style, "\" is not valid: ", e$message
+      ))
     }
   )
-  options(styler.addins.style = new_style)
+  options(styler.addins_style_transformer = new_style)
   invisible(current_style)
 }
 
 #' Return the style function or name
 #'
 #' @keywords internal
-get_addins_style_name <- function() {
-  getOption("styler.addins.style", default = "styler::tidyverse_style")
+get_addins_style_transformer_name <- function() {
+  getOption("styler.addins_style_transformer", default = "styler::tidyverse_style()")
 }
 
-#' @rdname get_addins_style_name
+#' @rdname get_addins_style_transformer_name
 #' @keywords internal
-get_addins_style_fun <- function() {
-  eval(parse(text = get_addins_style_name()))
+get_addins_style_transformer <- function() {
+  eval(parse(text = get_addins_style_transformer_name()))
+}
+
+communicate_addins_style_transformers <- function() {
+  style_name <- get_addins_style_transformer_name()
+  cat("Using style transformers `", style_name, "`\n", sep = "")
 }
 
-communicate_addins_style <- function() {
-  style_name <- get_addins_style_name()
-  cat("Using style `", style_name, "`\n", sep = "")
+#' Style a file as if it was an .R file
+#'
+#' If not successful, the file is most
+#' likely not a .R file, so saving the file and try styling again will work if
+#' the file is an .Rmd file. Otherwise, we can throw an error that the file must
+#' be a .R or .Rmd file.
+#' @param context The context from `styler:::get_rstudio_context()`.
+#' @param transformer A transformer function most conveniently constructed with
+#'   [make_transformer()].
+#' @importFrom rlang with_handlers abort
+#' @keywords internal
+try_transform_as_r_file <- function(context, transformer) {
+  with_handlers(
+    transformer(context$contents),
+    error = function(e) {
+      preamble_for_unsaved <- paste(
+        "Styling of unsaved files is only supported for R files with valid code.",
+        "Please save the file (as .R or .Rmd) and make sure that the R code in it",
+        "can be parsed. Then, try to style again."
+      )
+
+      if (context$path == "") {
+        abort(paste0(preamble_for_unsaved, " The error was \n", e$message))
+      } else {
+        abort(e$message)
+      }
+    }
+  )
 }

R/style-guides.R

@@ -29,7 +29,6 @@ NULL
 #' @inheritParams create_style_guide
 #' @param math_token_spacing A list of parameters that define spacing around
 #'   math token, conveniently constructed using [specify_math_token_spacing()].
-
 #' @details The following options for `scope` are available.
 #'
 #' * "none": Performs no transformation at all.

inst/rstudio/addins.dcf

@@ -1,14 +1,19 @@
 Name: Set style
-Description: Prompt for and set the style used by all STYLER addins
-Binding: prompt_style
+Description: Prompt for and set the style transformers used by all styler addins
+Binding: set_style_transformers
+Interactive: true
+
+Name: Style selection
+Description: Pretty-print selection
+Binding: style_selection
 Interactive: true
 
 Name: Style active file
 Description: Pretty-print active file
 Binding: style_active_file
 Interactive: true
 
-Name: Style selection
-Description: Pretty-print selection
-Binding: style_selection
+Name: Style active package
+Description: Pretty-print active package
+Binding: style_active_pkg
 Interactive: true