Handle styling of an unsaved active file

R/addins.R

@@ -1,25 +1,47 @@
-#' Style the active file
+
+#' Stylers for RStudio Addins
+#'
+#' Helper functions for styling via RStudio Addins.
+#'
+#' @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`.
 #'
-#' Helper function for RStudio Addin.
+#' 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.
+#'
+#' @name styler_addins
+#' @family stylers
+#' @seealso [Sys.setenv()]
+NULL
+
+#' @describeIn styler_addins Styles the active file
 style_active_file <- function() {
   context <- get_rstudio_context()
-  style_file(context$path, style = tidyverse_style)
+  out <- style_text(context$contents)
+  rstudioapi::modifyRange(
+    c(1, 1, length(out) + 1, 1),
+    paste0(out, collapse = "\n"), id = context$id
+  )
+  if (Sys.getenv("save_after_styling") == TRUE && context$path != "") {
+    rstudioapi::documentSave(context$id)
+  }
 }
 
-
-#' Style the highlighted region
-#'
-#' Helper function for RStudio Addin. This function is complicated because of
-#' one thing: You can highlight also just parts of lines.
-#' @importFrom rlang seq2
-style_active_region <- function() {
+#' @describeIn styler_addins Styles the highlighted region
+style_selection <- function() {
   context <- get_rstudio_context()
   text <- context$selection[[1]]$text
   if (all(nchar(text) == 0)) stop("No code selected")
   out <- style_text(text)
   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)
+  }
 }
 
 get_rstudio_context <- function() {

R/styler.R

@@ -7,7 +7,8 @@
 #'  * [style_file()] to style a single .R file.
 #'  * [style_dir()] to style all .R files in a directory.
 #'  * [style_pkg()] to style the source files of an R package.
-#'  * An RStudio Addin to style the active file .R file and the current package.
+#'  * [styler_addins] (RStudio Addins) to style either selected code or the
+#'  active file.
 #' @examples
 #' style_text("call( 1)")
 #' style_text("1    + 1", strict = FALSE)

inst/rstudio/addins.dcf

@@ -8,7 +8,7 @@ Description: Pretty-print active file
 Binding: style_active_file
 Interactive: true
 
-Name: Style active region
-Description: Pretty-print active region
-Binding: style_active_region
+Name: Style selection
+Description: Pretty-print selection
+Binding: style_selection
 Interactive: true