extendr project template

R/create_extendr_package.R

@@ -0,0 +1,76 @@
+
+#' Create a project for R package development with Rust
+#'
+#' @description
+#' This function creates an R project directory for package development
+#' with Rust extensions.
+#'
+#' @param path a path to new directory
+#' @param ... arguments passed on to `usethis::create_package()` and
+#' `rextendr::use_extendr()`
+#'
+#' @return Path to the newly created project or package, invisibly.
+#' @keywords internal
+#'
+#' @examples
+create_extendr_package <- function(path, ...) {
+
+  # error if usethis is not installed
+  rlang::check_installed("usethis")
+
+  args <- rlang::list2(...)
+
+  # hunch is that rstudio project text input widgets return empty strings
+  # when no value is given, want to make sure it is NULL so `use_extendr()`
+  # handles it correctly
+  args <- lapply(args, function(x) if (x == "") return(NULL) else return(x))
+
+  # build package directory, but don't open yet!
+  usethis::create_package(
+    path,
+    fields = list(),
+    rstudio = TRUE,
+    roxygen = args[["roxygen"]],
+    check_name = args[["check_name"]],
+    open = FALSE
+  )
+
+  # add rust scaffolding to project dir
+  use_extendr(
+    path,
+    crate_name = args[["crate_name"]],
+    lib_name = args[["lib_name"]],
+    quiet = TRUE,
+    overwrite = TRUE,
+    edition = args[["edition"]]
+  )
+
+  # generate header for INDEX file
+  header <- c(
+    paste0("Package: ", basename(path)),
+    "",
+    "BUILD COMPLETE:",
+    "The project build successfully generated the necessary R package files.",
+    ""
+  )
+
+  text <- c(
+    "NOTE:",
+    "To use {rextendr} in any meaningful way, the user must have",
+    "Rust and Cargo available on their local machine. To check that you do,",
+    "please run `rextendr::rust_sitrep()`. This will provide a",
+    "detailed report of the current state of your Rust infrastructure, along",
+    "with some helpful advice about how to address any issues that may arise."
+  )
+
+  content <- paste(
+    paste(header, collapse = "\n"),
+    paste(text, collapse = "\n"),
+    sep = "\n"
+  )
+
+  writeLines(content, con = file.path(path, "INDEX"))
+
+  return(invisible(path))
+
+}

inst/rstudio/templates/project/extendr.dcf

@@ -0,0 +1,34 @@
+Binding: create_extendr_package
+Title: R package with extendr
+Subtitle: Create an R package with Rust extensions.
+Caption: Create an R package with Rust extensions.
+OpenFiles: INDEX
+
+Parameter: roxygen
+Widget: CheckboxInput
+Label: Use roxygen2
+Default: On
+Position: left
+
+Parameter: check_name
+Widget: CheckboxInput
+Label: Validate package name
+Default: On
+Position: left
+
+Parameter: crate_name
+Widget: TextInput
+Label: Rust crate name
+Position: right
+
+Parameter: lib_name
+Widget: TextInput
+Label: Rust library name
+Position: right
+
+Parameter: edition
+Widget: SelectInput
+Label: Rust edition
+Fields: 2021, 2018
+Default: 2021
+Position: right