R/settings--preferences.R

In mokymai/bs: Resources Manager for R, RStudio and Related Software

# Settings and Preferences ===================================================

# For auto-completion
user_setting_set_names <- c(
  "bio-default", "bio-dark-blue", "bio-black", "rstudio-default"
)

# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#' @name RStudio-settings
#' @title Reset RStudio settings
#' @description
#' Reset RStudio to use predefined set of settings/preferences.
#' Correctly works only with RStudio 1.3 or newer.
#' Recommended to use with RStudio 2022.07.1 or newer.
#'
#' @param to The name of pre-defined set of RStudio settings/preferences.
#'        Options: "rstudio-default",
#'                 "bio-default",
#'                 "bio-dark-blue",
#'                 "bio-black".
#' @param backup (logical)
#'        If `TRUE`, a backup copy of files with settings is created.
#' @param ask (logical)
#'       If `TRUE`, additional confirmation to reset settings is required.
#'
#' @details
#' Settings that can be used in `rstudio-prefs.json` file:
#' https://docs.rstudio.com/ide/server-pro/session-user-settings.html
#'
#' @seealso
#' [get_path_rstudio_config_file()]
#'
#'
#' On [Customizing RStudio](https://support.rstudio.com/hc/en-us/articles/200549016-Customizing-the-RStudio-IDE) using point-and-click method.
#'
#' On [Configuration and Settings](https://www.rstudio.com/blog/rstudio-1-3-preview-configuration/).
#'
#' A list of [Session User Settings](https://docs.rstudio.com/ide/server-pro/session_user_settings/session_user_settings.html) to be used with
#' [rstudioapi::writeRStudioPreference()].
#'
#' On [RStudio setting locations](https://docs.rstudio.com/ide/desktop-pro/settings/settings.html).
#'
#' On [Resetting RStudio Desktop's State](https://support.rstudio.com/hc/en-us/articles/200534577-Resetting-RStudio-Desktop-s-State).
#'
#' StackOverflow threads on export/import RStudio of user preferences:
#' - https://stackoverflow.com/a/55940249/4783029
#' - https://stackoverflow.com/a/54982341/4783029
#'
#' @concept r and rstudio settings
#'
#' @examples
#' \dontrun{\donttest{
#'
#' rstudio_reset_user_settings(to = "rstudio-default")
#'
#' rstudio_reset_user_settings(to = "bio-default")
#'
#' rstudio_reset_user_settings(to = "bio-dark-blue")
#'
#' rstudio_reset_user_settings(to = "bio-black")
#'
#' }}
#' @export
rstudio_reset_user_settings <- function(to, backup = TRUE, ask = TRUE) {

  # Check arguments
  if (missing(to)) {
    # If the set of RStudio user settings is not chosen
    ui_stop(paste0(
      "The value of argument '{yellow('to')}' is missing.\n",
      'Possible choices: {ui_value(user_setting_set_names)}.'
    ))
  }

  checkmate::assert_choice(to, user_setting_set_names)

  # Take user inputs
  if (isTRUE(ask)) {
    rstudio_clear_console_ask()

    if (rstudioapi::isAvailable(version_needed = "1.1.67")) {
      ans <-
        rstudioapi::showQuestion(
          "Change User Settings",
          glue::glue("Do you want to set RStudio user settings to '{to}'?"),
          "No", "Yes"
        )

    } else {
      ans <- usethis::ui_nope(
        "Do you want to set RStudio user settings to {ui_value(to)}?",
        yes = "Yes"
      )
    }

    if (ans) {
      usethis::ui_warn("Cancelled.")
      return(invisible(NULL))
    }
  }

  # Change settings
  file_current <- get_path_rstudio_config_file("current")

  # Backup
  if (isTRUE(backup)) {
    create_backup_copy(file_current, "user_settings", "RStudio settings")
  }

  # Delete current settings (use RStudio defaults)
  fs::file_delete(file_current)

  # All other setup files contain differences from the default settings
  rs_default <- get_path_rstudio_config_file(which = "rstudio-default")
  success <- rstudio_set_preferences(rs_default)

  # Change what is different from the defaults
  switch(
    to,

    "rstudio-default" = NULL,

    "bio-default" = ,
    "bio-dark-blue" = ,
    "bio-black" = {
      # Change the default dir, if default UI preferences change
      fs::dir_create("~/R/main", recurse = TRUE)

      file_default <- get_path_rstudio_config_file(which = "bio")
      success <- rstudio_set_preferences(file_default)

    },

    usethis::ui_stop(paste0(
      'Unknown option of user setting defaults: to = {usethis::ui_value(to[1])}. \n',
      "Possible options: {ui_value(user_setting_set_names)}."
    ))
  )


  # Change RStudio theme
  switch(
    to,
    "bio-default"   = rstudioapi::applyTheme("Textmate (default)"),
    "bio-dark-blue" = rstudioapi::applyTheme("Cobalt"),
    "bio-black"     = rstudioapi::applyTheme("Chaos")
  )

  if (isTRUE(success)) {
    usethis::ui_done("RStudio user settings were set to {green(to)}.")
    rstudio_reload_ui()
    ui_msg_restart_rstudio()

  } else {
    usethis::ui_oops("Failure to reset RStudio user settings.")
  }
}

# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# Read preference from JSON file and set them in RStudio
rstudio_set_preferences <- function(file) {
  if (rstudioapi::isAvailable("1.3.387")) {
    pref <- jsonlite::fromJSON(file)
    purrr::walk2(
      names(pref), unname(pref),
      ~ {
        tryCatch(
          rstudioapi::writeRStudioPreference(.x, .y),
          error = function(e) {
            e_msg <- e$message
            if (stringr::str_detect(e_msg, "expected <Integer>")) {
              rstudioapi::writeRStudioPreference(.x, as.integer(.y))
            } else if (stringr::str_detect(e_msg, "expected <Real>")) {
              rstudioapi::writeRStudioPreference(.x, as.numeric(.y))
            } else if (stringr::str_detect(e_msg, "expected <Array>")) {
              rstudioapi::writeRStudioPreference(.x, as.list(.y))
            } else {
              print(glue::glue("'In {.x}' = {.y}\n{e}\n"))
            }
          }
        )
      }
    )
    TRUE

  } else {
    FALSE
  }
}
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

#' Show differences in sets of settings
#'
#' @param to One of: "bio-default", "rstudio-default"
#'        (or an unambiguous abbreviation of these).
#'
#' @return Nothing. But prints the set differences between `to` list and
#'         current settings. Settings, which are not in `to` list, will
#'         not be displayed at all.
#' @export
#'
#' @examples
#' \dontrun{\donttest{
#' rstudio_compare_user_settings(to = "bio-default")
#' rstudio_compare_user_settings(to = "rstudio-default")
#' }}
rstudio_compare_user_settings <- function(to = "bio-default") {
  to <- match.arg(to, c("bio-default", "rstudio-default"))

  file <- get_path_rstudio_config_file(which = to)
  default_prefs <-
    jsonlite::fromJSON(file) %>%
    purrr::map_if(is.integer, as.numeric) |>
    purrr::map_at("busy_exclusion_list", as.list)

  pref_names <- names(default_prefs) %>% purrr::set_names(., .)
  current_prefs <-
    purrr::map(pref_names, ~rstudioapi::readRStudioPreference(., NULL)) %>%
    purrr::map_if(is.integer, as.numeric)

  usethis::ui_info(
    "Show differences between {green('current')} and {green(to)} setting lists.\n"
  )

  # Unify names and number of fields
  all_names <- unique(names(current_prefs), names(default_prefs))
  named_list <- setNames(vector("list", length(all_names)), all_names)

  default_prefs <- modifyList(named_list, default_prefs, keep.null = TRUE)
  current_prefs <- modifyList(named_list, current_prefs, keep.null = TRUE)

  # Compare
  waldo::compare(
    default_prefs, current_prefs,
    x_arg = to, y_arg = "current",
    max_diffs = Inf,
    list_as_map = TRUE
  )
}