R/snippet.R

In gsmolinski/shinybreakpoint: Set Breakpoint in 'Shiny'

#' Write (Append) Basic Shiny App With Shinybreakpoint Functionality
#'
#' Append code skeleton with `shinybreakpoint` functionality to the
#' active (opened) file in RStudio.
#'
#' @return
#' Appends code skeleton to the file.
#'
#' @details
#' `shinybreakpoint` needs server logic to be included in the function separated
#' from the `server` part of app, was also developed having Bootstrap
#' version 5 in mind and some functionalities needs [shiny::reactlog] enabled
#' as well as managing temporary files (`shinybreakpoint::set_filtering_by_id()`)
#' is responsible for this. This snippet takes care of all of that.
#'
#' Snippet is also available as the addin, under the name `snippet`.
#'
#' @export
#'
#' @examples
#'
#' \dontrun{
#' # use shinybreakpoint::snippet() in the Console in RStudio
#' # (or find `snippet` addin in Addins menu)
#' # if there is an opened file (in Source Editor),
#' # then this skeleton should be added to the file:
#' library(shiny)
#'
#' shinybreakpoint::set_filtering_by_id() # TODO: remove
#'
#' ui <- fluidPage(
#'   theme = bslib::bs_theme(5),
#'
#' )
#'
#' appServer <- function(input, output, session) {
#'
#' }
#'
#' server <- function(input, output, session) {
#'   shinybreakpoint::shinybreakpointServer() # TODO: remove
#'   appServer(input, output, session)
#' }
#'
#' shinyApp(ui, server)
#' }
snippet <- function() {
  id <- tryCatch(rstudioapi::getSourceEditorContext()$id,
                   error = function(e) NULL)
  if (is.null(id)) {
    stop("Can't find opened file in RStudio.", call. = FALSE)
  } else {
    snippet_template <- readLines(file.path(system.file("snippet", package = "shinybreakpoint"),
                                            "snippet_template.R"))
    invisible(rstudioapi::insertText(text = snippet_template, id = id))
  }
}