Add use_r_universe_badge()

NAMESPACE

@@ -158,6 +158,7 @@ export(use_pkgdown_github_pages)
 export(use_posit_cloud_badge)
 export(use_proprietary_license)
 export(use_r)
+export(use_r_universe_badge)
 export(use_rcpp)
 export(use_rcpp_armadillo)
 export(use_rcpp_eigen)

NEWS.md

@@ -9,6 +9,8 @@
 * `use_package(min_version = FALSE)` is treated the same as when `min_version`
   is not specified (#2117, @salim-b).
 
+* New `use_r_universe_badge()` to indicate which version of your package is available on [R-universe](https://r-universe.dev) (@olivroy, #1883).
+
 * usethis's criteria for recognizing a project have expanded to include (#2133):
   - a `.vscode/` directory, which Positron or VS Code might create
   - a `_quarto.yml` file, typical of a Quarto project

R/badge.R

@@ -17,6 +17,9 @@
 #' available on CRAN, powered by <https://www.r-pkg.org>
 #' * `use_lifecycle_badge()`: badge declares the developmental stage of a
 #' package according to <https://lifecycle.r-lib.org/articles/stages.html>.
+#' * `use_r_universe_badge()`: `r lifecycle::badge("experimental")`: badge
+#' indicates what version of your package is available on [R-universe
+#' ](https://r-universe.dev/search/).
 #' * `use_binder_badge()`: badge indicates that your repository can be launched
 #' in an executable environment on <https://mybinder.org/>
 #' * `use_posit_cloud_badge()`: badge indicates that your repository can be launched
@@ -37,6 +40,13 @@
 #' \dontrun{
 #' use_cran_badge()
 #' use_lifecycle_badge("stable")
+#' # If you don't have a GitHub repo, or needs something extra
+#' # you can create the r-universe badge
+#' use_badge(
+#'   "R-universe",
+#'   "https://{organization}.r-universe.dev/badges/{package})",
+#'   "https://{organization}.r-universe.dev/{package}"
+#' )
 #' }
 NULL
 
@@ -144,7 +154,28 @@ use_binder_badge <- function(ref = git_default_branch(), urlpath = NULL) {
 
   invisible(TRUE)
 }
+#' @rdname badges
+#' @export
+use_r_universe_badge <- function() {
+  check_is_package("use_r_universe_badge()")
+  # The r-universe link needs the package name + organization.
 
+  pkg <- project_name()
+  # Get organization to construct R-universe link
+  repo_owner <- tryCatch(target_repo()$repo_owner, error = function(e) NA)
+  gh_org <- repo_owner[!is.na(repo_owner)]
+  if (length(gh_org) != 1L) {
+    ui_abort(c(
+      "{.pkg {pkg}} must have a repo URL in DESCRITPION to create a badge.",
+      "Use {.fn usethis::use_badge} if you have a different configuration.",
+      "If {.pkg {pkg}} is on CRAN, you can also see {.url https://cran.dev/{pkg}}
+       for a redirect to the r-universe homepage."
+    ))
+  }
+  src <- glue("https://{gh_org}.r-universe.dev/badges/{pkg}")
+  href <- glue("https://{gh_org}.r-universe.dev/{pkg}")
+  use_badge("R-universe", href, src)
+}
 #' @rdname badges
 #' @param url A link to an existing [Posit Cloud](https://posit.cloud)
 #'   project. See the [Posit Cloud

tests/testthat/_snaps/badge.md

@@ -7,6 +7,16 @@
       ! `stage` must be one of "experimental", "stable", "superseded", or "deprecated", not "eperimental".
       i Did you mean "experimental"?
 
+# use_r_universe_badge() needs a repository
+
+    Code
+      use_r_universe_badge()
+    Condition
+      Error in `use_r_universe_badge()`:
+      x {TESTPKG} must have a repo URL in DESCRITPION to create a badge.
+      i Use `usethis::use_badge()` if you have a different configuration.
+      i If {TESTPKG} is on CRAN, you can also see <https://cran.dev/{TESTPKG}> for a redirect to the r-universe homepage.
+
 # use_posit_cloud_badge() handles bad and good input
 
     Code

tests/testthat/test-badge.R

@@ -24,6 +24,17 @@ test_that("use_binder_badge() needs a github repository", {
   )
 })
 
+test_that("use_r_universe_badge() needs a repository", {
+  skip_if_no_git_user()
+  create_local_package()
+  use_git()
+  expect_snapshot(
+    error = TRUE,
+    use_r_universe_badge(),
+    transform = scrub_testpkg
+  )
+})
+
 test_that("use_posit_cloud_badge() handles bad and good input", {
   create_local_project()
   expect_snapshot(use_posit_cloud_badge(), error = TRUE)