R/make_new_package.R

In meerapatelmd/suzyBakeOven: Helpers for Package Authoring

#' @title
#' Start a New Package
#'
#' @description
#' Starts a new package using a designated path to a local
#' directory, where the folder is created and the DESCRIPTION,
#' /R, LICENSE, NAMESPACE, and README are written. Additional
#' documentation such as the Code of Conduct can be generated
#' using `setup_package_docs()`.
#'
#' @inheritParams usethis::create_package
#' @inheritParams usethis::use_mit_license
#' @param include_github Include GitHub features?
#' @param include_pkgdown Setup pkgdown?
#'
#'
#' @rdname make_new_package
#' @export
#' @import usethis


make_new_package <-
  function(path,
           copyright_holder = NULL,
           include_github = TRUE,
           include_pkgdown = TRUE) {

    if (dir.exists(paths = path)) {

      cli::cli_alert_warning(
        "Package '{basename(path)}' already exists at path '{dirname(path)}'."
      )


    } else {

      # Set working directory back to what it initially was
      # after `local_project` is called on the new path
      calling_wd <- getwd()
      on.exit(setwd(calling_wd))

      path <- create_package(path, rstudio = TRUE, open = FALSE)
      local_project(path)
      use_testthat()
      use_mit_license(copyright_holder)
      use_tidy_description()
      usethis::use_package_doc(open = FALSE)
      usethis::use_readme_rmd(open = FALSE)
      usethis::use_code_of_conduct()
      usethis::use_news_md(open = FALSE)
      use_lifecycle_badge("experimental")
      use_cran_badge()
      use_cran_comments(open = FALSE)
      use_tidy_release_test_env()
      usethis::use_pipe(export = FALSE)
      usethis::use_tibble()
      usethis::use_tidy_eval()
      usethis::use_tidy_style(strict = TRUE)

      if (include_github) {
        use_git()
        use_github()
        use_tidy_github_actions()
        git_vaccinate()

      }

      if (include_pkgdown) {

        use_pkgdown()

      }

    }

  }

#' @title
#' Setup Package Documentation
#'
#' @description
#' Adds the package doc `R/<package>-package.R`,
#' `README.Rmd`, Code of Conduct, and `NEWS.md` documents.
#' Spellcheck is also added usig this function.
#'
#' @inheritParams usethis::use_package_doc
#'
#' @param spellcheck_vignettes Spell check is automatically
#' enabled for the new package, but if TRUE, will also
#' spellcheck all rmd and rnw files in the vignettes/ folder.
#' @rdname setup_package_docs
#' @export
#' @importFrom usethis use_package_doc use_readme_rmd use_code_of_conduct use_news_md use_spell_check
#' @importFrom utils install.packages

setup_package_docs <-
  function(open = FALSE,
           spellcheck_vignettes = TRUE) {
    usethis::use_package_doc(open = open)
    usethis::use_readme_rmd(open = open)
    usethis::use_code_of_conduct()
    usethis::use_news_md(open = open)

    if (!("spelling" %in% installed.packages()[, "Package"])) {
      utils::install.packages("spelling")
    }
    usethis::use_spell_check(vignettes = spellcheck_vignettes)
  }

#' @title
#' Setup Tidy Git
#' @description
#' Setup both GitHub and tidy style settings in the usethis package.
#' @inheritParams usethis::use_github
#' @seealso
#'  \code{\link[usethis]{use_git}},\code{\link[usethis]{git_vaccinate}},
#'  \code{\link[usethis]{use_github}},\code{\link[usethis]{use_pipe}},
#'  \code{\link[usethis]{use_tibble}},
#'  \code{\link[usethis]{use_tidy_github_actions}}
#' @rdname setup_tidy_git
#' @export
#' @importFrom usethis use_git git_vaccinate use_github use_pipe use_tibble
#' use_tidy_eval use_tidy_style git_protocol

setup_tidy_git <-
  function(initial_commit_message = "initial commit",
           organisation = NULL,
           private = FALSE,
           protocol = usethis::git_protocol(),
           host = NULL,
           steps = c("use_git",
                     "git_vaccinate",
                     "use_github",
                     "use_pipe",
                     "use_tibble",
                     "use_tidy_eval",
                     "use_tidy_style")) {

    if ("use_git" %in% steps) {
      usethis::use_git(message = initial_commit_message)
    }

    if ("git_vaccinate" %in% steps) {
    usethis::git_vaccinate()
    }

    if ("use_github" %in% steps) {
    usethis::use_github(
      organisation = organisation,
      private = private,
      protocol = protocol,
      host = host
    )
    }

    if ("use_pipe" %in% steps) {
    usethis::use_pipe(export = FALSE)
    }

    if ("use_tibble" %in% steps) {
    usethis::use_tibble()
    }

    if ("use_tidy_eval" %in% steps) {
    usethis::use_tidy_eval()
    }

    if ("use_tidy_style" %in% steps) {
    usethis::use_tidy_style(strict = TRUE)
    }
  }