R/shellcheckr.R

In sambrightman/shellcheckr: Run ShellCheck From Within RStudio

markerMessage <- function(message, code) {
    as.character(htmltools::span(message,
                    htmltools::a(href = paste0('https://www.shellcheck.net/wiki/SC', code),
                                 paste0('SC', code))))
}


#' Run `shellcheck` on a document and parse to markers
#'
#' Runs [`shellcheck`](https://www.shellcheck.net/) and parses output into markers with
#' [ShellCheck wiki](https://www.shellcheck.net/wiki/) links for the problematic codes.
#'
#' Intended for use as an [RStudio Addin](https://rstudio.github.io/rstudioaddins/).
#'
#' @param path path of file to check. The active document is used if this is missing.
#'
#' @importFrom magrittr %>%
#' @importFrom rlang .data
#' @export
shellcheckrMarkers <- function(path) {
  results <- shellcheckr(path)
  if (length(results$comments) != 0) {
    markers <- results$comments %>%
      dplyr::transmute(type = .data$level,
                       file = .data$file,
                       line = .data$line,
                       column = .data$column,
                       message = purrr::map2(.data$message, .data$code, markerMessage) %>%
                         unlist %>%
                         structure(class = c('html', 'character')))
    rstudioapi::sourceMarkers('ShellCheck', markers, autoSelect = 'error')
  }
}


#' Run `shellcheck` on a document
#'
#' Runs [`shellcheck`](https://www.shellcheck.net/) on a document and returns the JSON output.
#'
#' @param path path of file to check. The active document is used if this is missing.
#'
#' @return JSON output of [`shellcheck`](https://www.shellcheck.net/).
#' @export
shellcheckr <- function(path) {
  if (missing(path)) {
    context <- rstudioapi::getActiveDocumentContext()
    path <- context$path
  }
  result <- suppressWarnings(system2('shellcheck', c('-f', 'json1', path), stdout = TRUE))
  jsonlite::fromJSON(result)
}