R/addins.R

In jr-packages/jrNotes: Jumping Rivers: Helper Package for Notes

#' Insert \code{#> } .
#'
#' Call this function as an addin to insert \code{#> } at the cursor position.
#' @export
insert_live_comment <- function() {
  rstudioapi::insertText("#> ")
}

#' Insert banner
#'
#' Call this function as an addin to insert a banner at the cursor position.
#' @export
insert_banner <- function() {
  rstudioapi::insertText("## ===============================================")
}

#' Inserts \code{#> }  in front of highlighted text.
#'
#' Call this function as insert \code{#> } at the start of highlighted text.
#' @export
live_comment_highlight <- function() {
  # Gets The active Document
  ctx <- rstudioapi::getActiveDocumentContext()

  # Checks that a document is active
  if (!is.null(ctx)) {
    selection = ctx$selection
    selection_start = selection[[1]]$range$start[1]
    selection_end = selection[[1]]$range$end[1]
    text = selection[[1]]$text
    code = unlist(strsplit(text, split = "\n"))
    # If code already prefaced by #>, then remove
    if (all(grepl("#> ", code))) {
      range = lapply(selection_start:selection_end,
                     function(x)
                       rstudioapi::document_range(
                         rstudioapi::document_position(x, 1),
                         rstudioapi::document_position(x, 4)
                       ))
      rstudioapi::modifyRange(range, "")
    } else{
      # otherwise add #>
      pos = Map(c, selection_start:selection_end, 1)
      rstudioapi::insertText(pos, "#> ")
    }
  }
}

#' Collapse minor versions of news
#'
#' Collapse minor versions of news into one list
#' To use, open NEWS.md, highlight the sections that you want to collapse, and click the addin.
#' @export
collapse_news = function() {
  ctx = rstudioapi::getActiveDocumentContext()

  if (!is.null(ctx)) {
    selection = ctx$selection
    selection_start = selection[[1]]$range$start[1]
    selection_end = selection[[1]]$range$end[1]
    text = selection[[1]]$text
    code = unlist(strsplit(text, split = "\n"))

    versions = code %>%
      stringr::str_subset("^#") %>%
      stringr::str_extract("[0-9]\\.[0-9]\\.[0-9]")
    package_versions = versions %>%
      package_version()

    minor = unique(package_versions$minor)
    major = unique(package_versions$major)

    package = code %>%
      stringr::str_subset("^#") %>%
      stringr::str_extract("jr[A-Z][a-z]*") %>%
      unique()

    new_title = glue::glue("# {package} {major}.{minor}.* _{Sys.Date()}_")

    keep = code %>%
      str_subset("^  *")

    collapsed = c(new_title, keep)

    range = lapply(selection_start:selection_end,
                   function(x)
                     rstudioapi::document_range(
                       rstudioapi::document_position(x, 1),
                       rstudioapi::document_position(x, 100)
                     ))

    rstudioapi::insertText(range[seq_len(length(collapsed))],
                           collapsed)
    rstudioapi::modifyRange(range[length(collapsed):length(range)],
                            "")
  }
}