R/findAndReplace.R

In acidgenomics/bb8: Acid Genomics Developer Tools

#' Find and replace in files across a directory
#'
#' @export
#' @note Updated 2023-05-22.
#'
#' @inheritParams params
#'
#' @param pattern `character(1)`.
#' Pattern string, supporting regular expressions.
#'
#' @param replacement `character(1)`.
#' Replacement string.
#'
#' @param filePattern `character(1)`.
#' File pattern matching string.
#' Defaults to matching against R files.
#'
#' @param recursive  `logical(1)`.
#' Search recursively?
#'
#' @return Invisibly return file paths.
#'
#' @examples
#' unlink("testdata", recursive = TRUE)
#' dir.create(file.path("testdata", "subdir"), recursive = TRUE)
#' writeLines(
#'     text = "print(\"foo\")",
#'     con = file.path("testdata", "aaa.R"),
#' )
#' writeLines(
#'     text = "print(\"foo\")",
#'     con = file.path("testdata", "subdir", "bbb.R"),
#' )
#' out <- findAndReplace(
#'     pattern = "foo",
#'     replacement = "bar",
#'     dir = "testdata",
#'     recursive = TRUE
#' )
#' print(out)
#' print(readLines(out[[1L]]))
#' unlink("testdata", recursive = TRUE)
findAndReplace <-
    function(pattern,
             replacement,
             filePattern = "\\.(r|R)$",
             dir = getwd(),
             recursive = FALSE) {
        stopifnot(.requireNamespaces("parallel"))
        dir <- .realpath(dir)
        files <- sort(list.files(
            path = dir,
            pattern = filePattern,
            full.names = TRUE,
            recursive = recursive
        ))
        stopifnot(.hasLength(files))
        out <- parallel::mclapply(
            X = files,
            FUN = function(file) {
                x <- readLines(con = file)
                x <- gsub(
                    pattern = pattern,
                    replacement = replacement,
                    x = x
                )
                writeLines(text = x, con = file)
                file
            }
        )
        out <- unlist(out, recursive = FALSE)
        invisible(out)
    }