R/set_vsc_setting.r

In MiguelRodo/alwaysloaded: Add desired .Rprofile settings

#' @title Set VSC workspace settings
#'
#' @param update logical.
#' If \code{TRUE}, then elements whose names
#' match \code{nm} are changed.
#' Default is \code{TRUE}.
#' @param create logical.
#' If \code{TRUE}, then if there is
#' no pre-existing element with a given
#' element of \code{nm},
#' then an element with that name is added.
#' Default is \code{TRUE}.
#' @param character file.
#' Path to the VSC settings file to edit.
#' Default is \code{here::here(".vscode/settings.json")}.
#' @param nm character vector.
#' Elements in JSON file to adjust.
#' @param val_or_fn what to change the element to.
#' If anything other than a function,
#' then the list element simply changes to this.
#' If a function, then it is the function to apply
#' to matching elements.
#' For functions passed to
#' elements with pre-existing values,
#' the first argument
#' takes that pre-existing value.
#' @param ... Passed on to fn.
#'
#' @export
.set_vsc_setting <- function(nm,
                             val_or_fn,
                             path_to_settings = here::here(".vscode/settings.json"), # nolint
                             update = TRUE,
                             create = TRUE,
                             ...) {

  if ("renv:shims" %in% search()) {
    install_pkg <- renv::install
  } else {
    install_pkg <- utils::install.packages
  }

  # install required packages
  if (!requireNamespace("rjson", quietly = TRUE)) {
    rv <- utils::sessionInfo()$R.version$major
    switch(
      rv,
      "3" = {
        if (!requireNamespace("versions", quietly = TRUE)) {
          install_pkg("versions")
        }
        versions::install.versions("rjson", versions = "0.2.20")
      },
      "4" = {

        install_pkg("rjson")
      },
      stop(
        paste0("R major version of ", rv, " not supported"),
        call. = FALSE
      )
    )
  }
  if (!requireNamespace("here", quietly = TRUE)) {
    install_pkg("here", quiet = TRUE)
  }

  # load settings, or create them
  if (file.exists(path_to_settings)) {
    settings_orig <- rjson::fromJSON(file = path_to_settings)
  } else {
    settings_orig <- list()
  }

  # get indices of settings that are affected
  settings <- settings_orig
  ind_replace_lgl <- vapply(
    nm,
    function(x) {
      x %in% names(settings)
    },
    logical(1)
  )
  nm_replace <- nm[ind_replace_lgl]
  nm_create <- nm[!ind_replace_lgl]

  if (update) {
    for (i in seq_along(nm_replace)) {
      x <- nm_replace[i]
      ind_x <- which(vapply(names(settings), function(y) {
        identical(y, x)
      }, logical(1)))
      settings[[ind_x]] <- switch(
        as.character(identical(class(val_or_fn), "function")),
        "FALSE" = val_or_fn,
        "TRUE" = val_or_fn(settings[[ind_x]], ...)
      )
    }
  }

  if (create) {
    for (i in seq_along(nm_create)) {
      x <- nm_create[i]
      val <- switch(as.character(identical(class(val_or_fn), "function")),
        "FALSE" = val_or_fn,
        "TRUE" = val_or_fn("~~unset~~", ...)
      )
      settings <- append(settings, setNames(list(val), x))
    }
  }

  # save settings
  # note that formatting of sub-lists doesn't work so well,
  # so don't save if nothing has changed
  if (identical(settings_orig, settings)) {
    return(invisible(TRUE))
  }
  settings_json <- rjson::toJSON(settings, indent = 2)
  if (!dir.exists(dirname(path_to_settings))) {
    dir.create(
      dirname(path_to_settings),
      recursive = TRUE
    )
  }
  write(settings_json, file = path_to_settings)

  invisible(TRUE)
}

#' @title Unset a VSC setting
#'
#' @description
#' Remove a setting entirely from the VSC JSON
#' settings file.
#'
#' @param nm character vector.
#' Names of settings to remove.
#' @inheritParams .set_vsc_setting
#'
#' @export
.unset_vsc_setting <- function(nm,
                               path_to_settings = here::here(".vscode/settings.json") # nolint
) {

  if (!file.exists(path_to_settings)) {
    return(invisible(TRUE))
  }

  if ("renv:shims" %in% search()) {
    install_pkg <- renv::install
  } else {
    install_pkg <- utils::install.packages
  }

  # install required packages
  if (!requireNamespace("rjson", quietly = TRUE)) {
    install_pkg("rjson", quiet = TRUE)
  }
  if (!requireNamespace("here", quietly = TRUE)) {
    install_pkg("here", quiet = TRUE)
  }

  # load settings, or create them
  settings_orig <- rjson::fromJSON(file = path_to_settings)

  if (!any(names(settings_orig) %in% nm)) {
    return(invisible(TRUE))
  }

  settings <- settings_orig[!names(settings_orig) %in% nm]

  settings_json <- rjson::toJSON(settings, indent = 2)
  write(settings_json, file = path_to_settings)

  invisible(TRUE)
}