R/files.R

In todor: Find All TODO Comments and More

#' Find package
#'
#' @param path character with path to directory with R code files
#'
#' @return package path
find_package <- function(path = getwd()) {
  start_wd <- getwd()
  on.exit(setwd(start_wd))
  setwd(path)
  prev_path <- ""
  while (!file.exists(file.path(prev_path, "DESCRIPTION"))) {
    if (prev_path == getwd()) {
      return(NULL)
    }
    prev_path <- getwd()
    setwd("..")
  }
  prev_path
}

#' Process file
#'
#' It calls \code{find_pattern} on given file and return detected markers or NULL.
#'
#' @param filepath character with
#' @param patterns vector of characters with given patterns to detect,
#' e.g. c("TODO", "BUG")
#'
#' @return list of markers (which are lists describing properties
#' of detected item from find_pattern)
process_file <- function(filepath, patterns) {
  con <- file(filepath, "r")
  n <- 1
  markers <- list()
  while (TRUE) {
    line <- readLines(con, n = 1)
    if (length(line) == 0) {
      break
    }
    pattern_check <- find_pattern(line, patterns = patterns)
    if (!is.null(pattern_check)) {
      cleaned_line <- clean_comments(line, pattern_check)
      cleaned_line <- stringr::str_replace(cleaned_line, pattern_check, "")
      markers[[length(markers) + 1]] <- list(nr = n,
                                             type = pattern_check,
                                             text = cleaned_line)
    }
    n <- n + 1
  }
  close(con)
  markers
}

#' List files with given extension
#'
#' It lists recursively with full path names.
#'
#' @param extension character with extension
#' @param search_path character with path to start searching from
#'
#' @return list of files with specified extension
#' @import rex
list_files_with_extension <- function(extension, search_path) {
  dir(
    path = search_path,
    pattern = rex::rex(".", extension, end),
    recursive = TRUE,
    full.names = TRUE
  )
}