R/createPackageProject.R

In stephlocke/pRojects: One-Liners to Setup R Projects

#' Create a package the usethis way with a number of infrastructure
#' commands executed to save you hassle
#'
#' @param name Project / package name
#' @param title "What the Project Does (One Line, Title Case)"
#'              If NULL, a random one will be generated.
#' @param folder Folder under which to create the project
#' @param initial_status initial repostatus.org status for the project,
#'                       whose badge will be added to the README.
#' @param git Configure Git
#' @param pkgdown Add a pkgdown config file
#' @param coverage What code coverage platform to use, NULL, "codecov" or "coveralls".
#' @param external_setup How to do the partly interactive setup
#'  of online git, CI and coverage platforms. If NULL, no setup.
#'  \itemize{
#'  \item \code{git_service} Only "GitHub" is supported at the moment.
#'  \item \code{login} username or organization name to use for the git service.
#'                If NULL, no GitHub repo is created.
#'  \item \code{private} whether to make the created repo private
#'  \item \code{protocol} "ssh" or "https", protocol to use for GitHub
#'  \item \code{ci_activation} Only NULL, and "travis" are supported at the moment.
#'  "travis" means calling \code{usethis::use_travis()} and adding the Travis
#'  badge to the README.
#'  }
#' @param reset Whether to reset the project to current project
#' @param open Whether to open the newly created project (in another RStudio session)
#'
#' @export
#'
#' @examples
#' \dontrun{
#' folder <- tempdir()
#' createPackageProject(
#'   name = "doggos", title = "Counting cute dogs",
#'   folder = folder,
#'   git = TRUE, external_setup = NULL,
#'   reset = TRUE,
#'   open = FALSE
#' )
#' list.files(file.path(folder, "doggos"))
#' unlink(file.path(folder, "doggos"))
#' }
createPackageProject <- function(name, title = NULL,
                                 folder = getwd(),
                                 initial_status = "wip",
                                 coverage = "codecov",
                                 git = TRUE,
                                 pkgdown = TRUE,
                                 external_setup = list(
                                   git_service = "GitHub",
                                   login = gh::gh_whoami()$login,
                                   private = FALSE,
                                   protocol = "ssh",
                                   ci_activation = "travis"
                                 ),
                                 reset = TRUE,
                                 open = FALSE) {
  validate_name(name)

  # create title
  if (is.null(title)) {
    title <- cool_stuff()
  }
  # only go on if available pkg name
  if (is_available(name)) {
    current_proj <- get_current_proj()
    current_wd <- getwd()
    tryCatch({
      # create package skeleton
      usethis::create_package(file.path(folder, name),
                              open = FALSE,
                              rstudio = TRUE,
                              fields = list(License = "MIT + file LICENSE")
      )

      usethis::proj_set(file.path(folder, name),
                        force = TRUE
      )

      desc::desc_set("Title", title,
                     file = usethis::proj_get()
      )

      usethis::use_code_of_conduct()

      maintainer <- try(whoami::fullname(), silent = TRUE)

      if (inherits(maintainer, "try-error")) {
        maintainer <- "Jane Doe"
      }

      usethis::use_template("license-mit.md",
                            "LICENSE.md",
                            ignore = TRUE,
                            data = list(
                              year = format(Sys.Date(), "%Y"),
                              name = maintainer,
                              project = name
                            )
      )
      usethis::use_template("year-copyright.txt",
                            "LICENSE",
                            data = list(
                              year = format(Sys.Date(), "%Y"),
                              name = maintainer,
                              project = name
                            )
      )
      usethis::use_package_doc()
      # README stuff
      use_readme(name)
      # status
      add_repo_status(initial_status)

      usethis::use_testthat()
      usethis::use_vignette(gsub("\\.", "-", name))
      if (git) {
        usethis::use_git(message = cool_first_commit())
        add_styler_hook()
      }

      usethis::use_template("NEWS.md",
                            data = usethis:::package_data(),
                            open = FALSE)

      if (pkgdown) {
        file.create(file.path(usethis::proj_get(),
                              "_pkgdown.yml"))
        usethis::use_build_ignore("_pkgdown.yml")
      }

      if (!is.null(external_setup$git_service)) {
        setup_repo(
          name = name,
          title = title,
          git_service = external_setup$git_service,
          login = external_setup$login,
          private = external_setup$private,
          protocol = external_setup$protocol,
          ci_activation = external_setup$ci_activation,
          project_type = "package",
          coverage = coverage
        )
      }

      # README
      knit_readme()

      # dummy test
      usethis::use_testthat()
      usethis::use_test(name = "sample", open = FALSE)

      # add everything
      git_add_infrastructure()

      if (open) {
        rstudioapi::openProject(file.path(folder, name), newSession=TRUE)
      }
    },
    error = function(e) {
      message(paste("Error:", e$message))
      e
      # delete folder created earlier
      unlink(file.path(folder, name), recursive = TRUE)
      message(sprintf("Oops! An error was found and the `%s` directory was deleted", name)) # nolint
    }
    )
  }

  if (reset) {
    reset_proj(current_proj, current_wd)
  }

  invisible(TRUE)
}

#' @export

#' @describeIn createPackageProject aesthetic addition for continuity purposes
create_package_project = createPackageProject