R/spellcheck_quarto.r

In supportR: Support Functions for Wrangling and Visualization

#' @title Check the Spelling of All Quarto Files in a Given Directory
#' 
#' @description Runs `spelling::spell_check_files` on all Quarto (.qmd) files in folders that would be rendered when rendering a Quarto project (i.e., folders that do not begin with an underscore). 
#' 
#' @param path (character) directory in which all Quarto files are to be identified and spell-checked. Recursively identifies Quarto files in folders within the top-level folder. Unrendered folders are ignored. Defaults to current working directory
#' @param quiet (logical) whether to message the name of the current file being spell-checked as it is checked. Defaults to `FALSE`
#' 
#' @return (dataframe) table containing a column for the Quarto file, its path, words flagged as typos by `spell_check_files`, and what line(s) of the file that typo was found. One row per typo. If found on multiple lines in a single file, concatenated with comma as separators.
#' 
#' @export
#' 
spellcheck_quarto <- function(path = getwd(), quiet = FALSE){
  # Squelch 'visible bindings' note
  files <- lines <- NULL

  # Error checks for 'path'
  if(is.null(path) || is.character(path) != TRUE || length(path) != 1)
    stop("'path' must be a single file path specified as a character")

  # Warning for bad value to 'quiet'
  if(is.logical(quiet) != TRUE){
    warning("'quiet' must be a logical. Defaulting to FALSE")
    quiet <- FALSE }

  # List files
  all_quarto <- data.frame("files" = dir(path = path, recursive = TRUE,
    pattern = "*.qmd"))

  # Remove any files in a folder with a pre-pended underscore
  ## These folders are not rendered
  rendered_quarto <- dplyr::filter(.data = all_quarto, 
    stringr::str_sub(string = files, start = 1, end = 1) != "_" &
      stringr::str_detect(string = files, pattern = "/_") != T & 
      stringr::str_detect(string = files, pattern = "\\\\_") != T)

  # List for spellcheck outputs
  spell_results <- list()

  # Loop across these
  for(qmd in rendered_quarto$files){
    
    # Progress message if not supposed to be quiet
    if(quiet != TRUE){ message("Checking spelling in ", qmd) }

    # Check spelling 
    check_raw <- as.data.frame(spelling::spell_check_files(path = qmd))

    # Strip useful stuff
    found_word <- check_raw$word
    found_lines <- unlist(check_raw$found)

    # If there are any typos, make a nice dataframe for them
    if(length(found_word) != 0){
      check_raw <- data.frame("lines" = found_lines,
      "word" = found_word)
    } else { check_raw <- data.frame("lines" = "", "word" = "No typos found!")}
    
    # Add file name/path as columns to that data object
    check_tidy <- dplyr::mutate(.data = check_raw,
      path = qmd,
      file = basename(path = qmd),
      .before = dplyr::everything())

    # And remove file name from the 'path' and 'lines' columns
    check_done <- dplyr::mutate(.data = check_tidy,
      path = gsub(pattern = unique(file), replacement = "", x = path),
      lines = gsub(pattern = paste0(unique(file), ":"), replacement = "", x = lines)) %>% 
      # Add a "." for empty paths that result from the above
      dplyr::mutate(path = ifelse(test = nchar(path) == 0, yes = ".", no = path))
    
    # Add to the list
    spell_results[[qmd]] <- check_done
  }

  # Unlist the spell check list
  spell_df <- purrr::list_rbind(x = spell_results)

  # Return that
  return(spell_df) }

# End ----