Clean helpers & check mandatory arguments

R/add_badge.R

@@ -0,0 +1,76 @@
+#' **Add a badge to the README.Rmd**
+#'
+#' @param badge a Markdown expression.
+#' @param pattern a special tag (i.e. 'LifeCycle', 'Project Status',
+#'   'CRAN status', 'License', 'R-CMD-check')
+#'
+#' @noRd
+
+add_badge <- function(badge, pattern) {
+  path <- build_abs_path()
+
+  ## Checks ----
+
+  if (missing(badge)) {
+    stop("No badge to add in the 'README.Rmd'.")
+  }
+  if (missing(pattern)) {
+    stop("Argument 'pattern' is missing.")
+  }
+
+  if (!file.exists(file.path(path, "README.Rmd"))) {
+    stop("The file 'README.Rmd' cannot be found.")
+  }
+
+  ## Read README.Rmd ----
+
+  read_me <- readLines(con = file.path(path, "README.Rmd"))
+
+  ## Check if Badges Locations are present ----
+
+  badge_start <- grep("<!-- badges: start -->", read_me)
+  badge_end <- grep("<!-- badges: end -->", read_me)
+
+  if (!length(badge_start) || !length(badge_end)) {
+    stop(
+      "Unable to parse badges location in 'README.Rmd' file.\n",
+      "Did you remove the tag '<!-- badges: start -->' and/or ",
+      "'<!-- badges: end -->'?"
+    )
+  }
+
+  ## Extract existing badges (if exist) ----
+
+  if ((badge_start + 1) == badge_end) {
+    badges <- character(0)
+  } else {
+    badges <- paste0(
+      read_me[(badge_start + 1):(badge_end - 1)],
+      collapse = "\n"
+    )
+    badges <- unlist(strsplit(badges, "\n"))
+    badges <- badges[!(badges == "")]
+  }
+
+  ## Replace/Add badge ----
+
+  pos <- grep(paste0("^\\s{0,}\\[!\\[", pattern), badges)
+
+  if (length(pos)) {
+    badges[pos] <- badge
+  } else {
+    badges <- c(badges, badge)
+  }
+
+  read_me <- c(
+    read_me[1:badge_start],
+    badges,
+    read_me[badge_end:length(read_me)]
+  )
+
+  ## Replace README.Rmd ----
+
+  writeLines(read_me, con = file.path(path, "README.Rmd"))
+
+  invisible(NULL)
+}

R/add_citation.R

@@ -43,23 +43,25 @@ add_citation <- function(
 ) {
   stop_if_not_project()
 
-  stop_if_not_logical(open, overwrite, quiet)
+  stop_if_not_logical(open)
+  stop_if_not_logical(overwrite)
+  stop_if_not_logical(quiet)
 
   path <- build_abs_path("inst", "CITATION")
 
-  assert_file_not_exists_or_overwrite(path, overwrite)
+  stop_if_file_exists(path, overwrite)
 
   meta <- resolve_project_meta(
     given = given,
     family = family,
     organisation = organisation
   )
 
-  stop_if_null_or_empty(meta$given, "given")
-  stop_if_null_or_empty(meta$family, "family")
+  stop_if_not_string(meta$given)
+  stop_if_not_string(meta$family)
 
   if (should_create_file(path, overwrite)) {
-    ensure_dir_exists(dirname(path))
+    create_folder_if_needed(dirname(path))
 
     create_template("package/CITATION", path, meta)
 

R/add_code_of_conduct.R

@@ -27,20 +27,22 @@ add_code_of_conduct <- function(
 ) {
   stop_if_not_project()
 
-  stop_if_not_logical(open, overwrite, quiet)
+  stop_if_not_logical(open)
+  stop_if_not_logical(overwrite)
+  stop_if_not_logical(quiet)
 
   path <- build_abs_path("CODE_OF_CONDUCT.md")
 
-  assert_file_not_exists_or_overwrite(path, overwrite)
+  stop_if_file_exists(path, overwrite)
 
   meta <- resolve_project_meta(
     email = email
   )
 
-  stop_if_null_or_empty(meta$email, "email")
+  stop_if_not_string(meta$email)
 
   if (should_create_file(path, overwrite)) {
-    ensure_dir_exists(dirname(path))
+    create_folder_if_needed(dirname(path))
 
     create_template("contributing/CODE_OF_CONDUCT.md", path, meta)
 

R/add_codeowners.R

@@ -27,20 +27,22 @@ add_codeowners <- function(
 ) {
   stop_if_not_project()
 
-  stop_if_not_logical(open, overwrite, quiet)
+  stop_if_not_logical(open)
+  stop_if_not_logical(overwrite)
+  stop_if_not_logical(quiet)
 
   path <- build_abs_path(".github", "CODEOWNERS")
 
-  assert_file_not_exists_or_overwrite(path, overwrite)
+  stop_if_file_exists(path, overwrite)
 
   meta <- resolve_project_meta(
     github_user = github_user
   )
 
-  stop_if_null_or_empty(meta$github_user, "github_user")
+  stop_if_not_string(meta$github_user)
 
   if (should_create_file(path, overwrite)) {
-    ensure_dir_exists(dirname(path))
+    create_folder_if_needed(dirname(path))
 
     writeLines(
       text = paste0("* @", meta$github_user),

R/add_contributing.R

@@ -27,21 +27,23 @@ add_contributing <- function(
 ) {
   stop_if_not_project()
 
-  stop_if_not_logical(open, overwrite, quiet)
+  stop_if_not_logical(open)
+  stop_if_not_logical(overwrite)
+  stop_if_not_logical(quiet)
 
   path <- build_abs_path("CONTRIBUTING.md")
 
-  assert_file_not_exists_or_overwrite(path, overwrite)
+  stop_if_file_exists(path, overwrite)
 
   meta <- resolve_project_meta(
     email = email,
     organisation = organisation
   )
 
-  stop_if_null_or_empty(meta$email, "email")
+  stop_if_not_string(meta$email)
 
   if (should_create_file(path, overwrite)) {
-    ensure_dir_exists(dirname(path))
+    create_folder_if_needed(dirname(path))
 
     create_template("contributing/CONTRIBUTING.md", path, meta)
 

R/add_dependabot.R

@@ -29,14 +29,15 @@ add_dependabot <- function(
 ) {
   stop_if_not_project()
 
-  stop_if_not_logical(overwrite, quiet)
+  stop_if_not_logical(overwrite)
+  stop_if_not_logical(quiet)
 
   path <- build_abs_path(".github", "dependabot.yaml")
 
   meta <- resolve_project_meta()
 
   if (should_create_file(path, overwrite)) {
-    ensure_dir_exists(dirname(path))
+    create_folder_if_needed(dirname(path))
 
     create_template(paste0("actions/", basename(path)), path, meta)
 

R/add_description.R

@@ -34,11 +34,13 @@ add_description <- function(
 ) {
   stop_if_not_project()
 
-  stop_if_not_logical(open, overwrite, quiet)
+  stop_if_not_logical(open)
+  stop_if_not_logical(overwrite)
+  stop_if_not_logical(quiet)
 
   path <- build_abs_path("DESCRIPTION")
 
-  assert_file_not_exists_or_overwrite(path, overwrite)
+  stop_if_file_exists(path, overwrite)
 
   meta <- resolve_project_meta(
     given = given,
@@ -48,12 +50,12 @@ add_description <- function(
     organisation = organisation
   )
 
-  stop_if_null_or_empty(meta$given, "given")
-  stop_if_null_or_empty(meta$family, "family")
-  stop_if_null_or_empty(meta$email, "email")
+  stop_if_not_string(meta$given)
+  stop_if_not_string(meta$family)
+  stop_if_not_string(meta$email)
 
   if (should_create_file(path, overwrite)) {
-    ensure_dir_exists(dirname(path))
+    create_folder_if_needed(dirname(path))
 
     create_template("package/DESCRIPTION", path, meta)
 

R/add_dockerfile.R

@@ -57,7 +57,9 @@ add_dockerfile <- function(
   overwrite = FALSE,
   quiet = FALSE
 ) {
-  stop_if_not_logical(open, overwrite, quiet)
+  stop_if_not_logical(open)
+  stop_if_not_logical(overwrite)
+  stop_if_not_logical(quiet)
 
   path <- build_abs_path("Dockerfile")
 
@@ -70,7 +72,7 @@ add_dockerfile <- function(
         "replace it, please use `overwrite = TRUE`."
       )
     } else {
-      edit_file(path)
+      open_file_if_needed(path, open)
       return(invisible(NULL))
     }
   }
@@ -87,7 +89,9 @@ add_dockerfile <- function(
     email <- getOption("email")
   }
 
-  stop_if_not_string(given, family, email)
+  stop_if_not_string(given)
+  stop_if_not_string(family)
+  stop_if_not_string(email)
 
   r_version <- paste(
     utils::sessionInfo()$"R.version"$"major",
@@ -202,9 +206,7 @@ add_dockerfile <- function(
   add_to_buildignore("Dockerfile", quiet = quiet)
   add_to_buildignore(".dockerignore", quiet = quiet)
 
-  if (open) {
-    edit_file(path)
-  }
+  open_file_if_needed(path, open)
 
   invisible(NULL)
 }

R/add_github_action.R

@@ -88,18 +88,21 @@ add_github_action <- function(
 ) {
   stop_if_not_project()
 
-  stop_if_not_logical(open, overwrite, quiet)
+  stop_if_not_logical(open)
+  stop_if_not_logical(overwrite)
+  stop_if_not_logical(quiet)
+
   stop_if_not_string(name)
-  assert_valid_gh_action_name(name)
+  stop_if_invalid_gh_action_name(name)
 
   path <- build_abs_path(".github", "workflows", paste0(name, ".yaml"))
 
-  assert_file_not_exists_or_overwrite(path, overwrite)
+  stop_if_file_exists(path, overwrite)
 
   meta <- resolve_project_meta()
 
   if (should_create_file(path, overwrite)) {
-    ensure_dir_exists(dirname(path))
+    create_folder_if_needed(dirname(path))
 
     create_template(paste0("actions/", basename(path)), path, meta)
 

R/add_issue_template.R

@@ -31,18 +31,21 @@ add_issue_template <- function(
 ) {
   stop_if_not_project()
 
-  stop_if_not_logical(open, overwrite, quiet)
+  stop_if_not_logical(open)
+  stop_if_not_logical(overwrite)
+  stop_if_not_logical(quiet)
+
   stop_if_not_string(name)
-  assert_valid_issue_template_name(name)
+  stop_if_invalid_issue_template_name(name)
 
   path <- build_abs_path(".github", "ISSUE_TEMPLATE", paste0(name, ".md"))
 
-  assert_file_not_exists_or_overwrite(path, overwrite)
+  stop_if_file_exists(path, overwrite)
 
   meta <- resolve_project_meta()
 
   if (should_create_file(path, overwrite)) {
-    ensure_dir_exists(dirname(path))
+    create_folder_if_needed(dirname(path))
 
     create_template(paste0("issues/", basename(path)), path, meta)
 

R/add_license.R

@@ -31,8 +31,7 @@ add_license <- function(
   stop_if_not_project()
 
   stop_if_not_logical(quiet)
-  stop_if_not_string(license)
-  assert_valid_license_name(license)
+  stop_if_invalid_license_name(license)
 
   path <- build_abs_path("LICENSE.md")
 
@@ -41,7 +40,7 @@ add_license <- function(
     family = family
   )
 
-  assert_valid_mit_meta(license, meta)
+  stop_if_invalid_mit_meta(license, meta)
 
   if (should_update_license(license)) {
     update_license_field_in_desc(license, quiet)

R/add_makefile.R

@@ -30,24 +30,26 @@ add_makefile <- function(
 ) {
   stop_if_not_project()
 
-  stop_if_not_logical(open, overwrite, quiet)
+  stop_if_not_logical(open)
+  stop_if_not_logical(overwrite)
+  stop_if_not_logical(quiet)
 
   path <- build_abs_path("make.R")
 
-  assert_file_not_exists_or_overwrite(path, overwrite)
+  stop_if_file_exists(path, overwrite)
 
   meta <- resolve_project_meta(
     given = given,
     family = family,
     email = email
   )
 
-  stop_if_null_or_empty(meta$given, "given")
-  stop_if_null_or_empty(meta$family, "family")
-  stop_if_null_or_empty(meta$email, "email")
+  stop_if_not_string(meta$given)
+  stop_if_not_string(meta$family)
+  stop_if_not_string(meta$email)
 
   if (should_create_file(path, overwrite)) {
-    ensure_dir_exists(dirname(path))
+    create_folder_if_needed(dirname(path))
 
     create_template("others/make.R", path, meta)