R/rename.R

In waldronlab/newsfeed: Compilies NEWS files from different packages

#' Change the NEWS.md file headings
#'
#' Some `NEWS.md` files have the package name in the heading. This is not
#' yet supported in the `collect` code. This convenience function will help
#' the user modify those headings to exclude the package name and include
#' the keywords `Changes in version` for aggregating news files across
#' packages. Version control of the NEWS files is highly recommended.
#' By default, the function saves a `*.bak` backup NEWS file in the package
#' directory.
#'
#' @inheritParams reformat
#'
#' @return Saves a "NEWS.md" file with substituted headers
#'
#' @examples
#'
#' # create phony DESC for usethis
#' # otherwise temp 'package' is not recognized
#' desc <- usethis:::build_description(
#'     basename(tempdir()), roxygen = TRUE, fields = list()
#' )
#' lines <- desc$str(by_field = TRUE, normalize = FALSE, mode = "file")
#' usethis:::write_over(
#'     file.path(tempdir(), "DESCRIPTION"), lines, quiet = TRUE
#' )
#'
#' tempNews <- file.path(tempdir(), "NEWS.md")
#' writeLines("# TempPackage 0.99.0", con = file(tempNews))
#' rename(pkg = tempdir())
#' readLines(tempNews)
#'
#' @export
rename <- function(pkg, backup = ".bak", dry.run = TRUE) {
    if (missing(pkg))
        stop("Provide a valid package name and directory: 'pkg'")

    newsfile <- .findNEWSfile(pkg)
    newslines <- readLines(newsfile)
    file.copy(newsfile, paste0(newsfile, backup))
    upnews <- gsub(
        "(^\\#+)(.*)([0-9].[0-9]{1,2}.[0-9]+)",
        "\\1 Changes in version \\3",
        newslines
    )
    if (identical(newslines, upnews))
        stop(basename(newsfile), " already in the correct format")

    msg <- if (dry.run)
        "NEWS file not changed: set 'dry.run=FALSE'"
    else
        paste0("Writing NEWS file with backup at ", backup)

    message(msg)
    if (!dry.run) {
        writeLines(upnews, newsfile)
    }

    newslines
}