add use_extendr_badge()

Author: JosiahParry

R/badge.R

@@ -0,0 +1,34 @@
+#' extendr README badge
+#'
+#' Add the version of extendr being used by an R package to its README.
+#'
+#' Requires `usethis` to be available.
+#'
+#' @examples
+#' \dontrun{
+#' use_extendr_badge()
+#' }
+#'
+#' @inheritParams use_extendr
+use_extendr_badge <- function(path = ".") {
+  rlang::check_installed("usethis")
+  meta <- read_cargo_metadata(path)
+  deps <- meta[[c("packages", "dependencies")]][[1]]
+
+  if (rlang::is_null(deps)) {
+    cli::cli_abort("Unable to determine version of `extendr-api`")
+  }
+
+  is_extendr <- which(deps$name == "extendr-api")
+  if (!rlang::is_bare_numeric(is_extendr, 1)) {
+    cli::cli_abort("Unable to determine version of `extendr-api`")
+  }
+
+  extendr_version <- deps$req[is_extendr]
+
+  usethis::use_badge(
+    "extendr",
+    "https://extendr.github.io/extendr/extendr_api/",
+    sprintf("https://img.shields.io/badge/extendr-%s-276DC2", extendr_version)
+  )
+}

R/use_extendr.R

@@ -206,6 +206,9 @@ use_extendr <- function(path = ".",
     Sys.chmod("configure", "0755")
   }
 
+  # Set the minimum version of R to 4.2 as now required by libR-sys 0.7
+  usethis::use_package("R", "Depends", "4.2")
+
   # the temporary cargo directory must be ignored
   usethis::use_build_ignore("src/.cargo")
 
@@ -225,6 +228,9 @@ use_extendr <- function(path = ".",
   usethis::use_build_ignore("src/Makevars.win")
   usethis::use_git_ignore("src/Makevars.win")
 
+
+  use_extendr_badge()
+
   if (!isTRUE(quiet)) {
     cli::cli_alert_success("Finished configuring {.pkg extendr} for package {.pkg {pkg_name}}.")
     cli::cli_ul(

README.Rmd

@@ -22,6 +22,7 @@ knitr::opts_chunk$set(
 [![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
 [![R build status](https://github.com/extendr/rextendr/workflows/R-CMD-check/badge.svg)](https://github.com/extendr/rextendr/actions)
 [![Codecov test coverage](https://codecov.io/gh/extendr/rextendr/graph/badge.svg)](https://app.codecov.io/gh/extendr/rextendr)
+[![extendr](https://img.shields.io/badge/extendr-^0.7.1-276DC2)](https://extendr.github.io/extendr/extendr_api/)
 <!-- badges: end -->
 
 ## Installation

man/use_extendr_badge.Rd

@@ -410,6 +410,13 @@
       > File 'tools/msrv.R' already exists. Skip writing the file.
       > File 'configure' already exists. Skip writing the file.
       > File 'configure.win' already exists. Skip writing the file.
+      ! Can't find a README for the current project.
+      i See `usethis::use_readme_rmd()` for help creating this file.
+      i Badge link will only be printed to screen.
+      [ ] Copy and paste the following lines into 'README':
+        <!-- badges: start -->
+        [![extendr](https://img.shields.io/badge/extendr-*-276DC2)](https://extendr.github.io/extendr/extendr_api/)
+        <!-- badges: end -->
       v Finished configuring extendr for package testpkg.wrap.
       * Please run `rextendr::document()` for changes to take effect.
 
@@ -430,6 +437,13 @@
       v Writing 'tools/msrv.R'
       v Writing 'configure'
       v Writing 'configure.win'
+      ! Can't find a README for the current project.
+      i See `usethis::use_readme_rmd()` for help creating this file.
+      i Badge link will only be printed to screen.
+      [ ] Copy and paste the following lines into 'README':
+        <!-- badges: start -->
+        [![extendr](https://img.shields.io/badge/extendr-*-276DC2)](https://extendr.github.io/extendr/extendr_api/)
+        <!-- badges: end -->
       v Finished configuring extendr for package testpkg.
       * Please run `rextendr::document()` for changes to take effect.