Updates for latest lifecycle workflow (#1349)

Fixes #1323

Author: hadley

NEWS.md

@@ -1,12 +1,15 @@
 # usethis (development version)
 
+* `use_lifecycle()` has been updated for changes in our lifecycle workflow 
+  (#1323).
+
 * `use_tidy_pkgdown()` has been renamed to `use_pkgdown_github_pages()` since
   the function is useful for anyone who wants to automatically publish to GitHub
   pages, not just the tidyverse team (#1308).
 
 * All functions that require a package now ask you if you'd like to install it.
 
-`use_readme_rmd()`, `use_readme_md()`, `use_tidy_contributing()`, and `use_tidy_support()` use updated logic for determining the `OWNER/REPO` spec of the target repo (#1312).
+* `use_readme_rmd()`, `use_readme_md()`, `use_tidy_contributing()`, and `use_tidy_support()` use updated logic for determining the `OWNER/REPO` spec of the target repo (#1312).
 
 # usethis 2.0.0
 

R/badge.R

@@ -15,24 +15,15 @@
 #' * `use_cran_badge()`: badge indicates what version of your package is
 #' available on CRAN, powered by <https://www.r-pkg.org>
 #' * `use_lifecycle_badge()`: badge declares the developmental stage of a
-#' package (or argument or function) according to
-#' <https://lifecycle.r-lib.org/articles/lifecycle.html>:
-#'   - Experimental
-#'   - Maturing
-#'   - Stable
-#'   - Questioning
-#'   - Superseded
-#'   - Soft-deprecated (function or argument)
-#'   - Deprecated (function or argument)
-#'   - Defunct (function or argument)
+#' package according to <https://lifecycle.r-lib.org/articles/stages.html>.
 #'
 #' * `use_binder_badge()`: badge indicates that your repository can be launched
 #' in an executable environment on <https://mybinder.org/>
 #'
 #' @param badge_name Badge name. Used in error message and alt text
 #' @param href,src Badge link and image src
-#' @param stage Stage of the package lifecycle
-#'
+#' @param stage Stage of the package lifecycle. One of "experimental",
+#'   "stable", "superseded", or "deprecated".
 #' @seealso Functions that configure continuous integration, such as
 #'   [use_github_actions()], also create badges.
 #'
@@ -102,24 +93,22 @@ use_lifecycle_badge <- function(stage) {
   check_is_package("use_lifecycle_badge()")
   pkg <- project_name()
 
-  stage <- match.arg(tolower(stage), names(stages))
+  stage <- tolower(stage)
+  stage <- arg_match0(stage, names(stages))
   colour <- stages[[stage]]
 
   src <- glue("https://img.shields.io/badge/lifecycle-{stage}-{colour}.svg")
-  href <- glue("https://www.tidyverse.org/lifecycle/#{stage}")
+  href <- glue("https://lifecycle.r-lib.org/articles/stages.html#{stage}")
   use_badge(paste0("Lifecycle: ", stage), href, src)
 
   invisible(TRUE)
 }
 
 stages <- c(
   experimental = "orange",
-  maturing = "blue",
   stable = "brightgreen",
   superseded = "blue",
-  archived = "red",
-  dormant = "blue",
-  questioning = "blue"
+  deprecated = "orange"
 )
 
 #' @rdname badges

R/lifecycle.R

@@ -1,18 +1,13 @@
 #' Use lifecycle badges
 #'
 #' @description
+#' This helper adds lifecycle as a dependency, copies the lifecycle badges into
+#' the `man/figures` folder, and reminds you how to use the badge syntax.
 #'
-#' This helper copies the lifecycle badges in to the `man/figures`
-#' folder of your package. It also reminds you of the syntax to use
-#' them in the documentation of individual functions or arguments.
-#'
-#' See the [getting started
-#' vignette](https://lifecycle.r-lib.org/articles/lifecycle.html) of the
-#' lifecycle package.
+#' Learn more at <https://lifecycle.r-lib.org/articles/communicate.html>
 #'
 #' @seealso [use_lifecycle_badge()] to signal the [global lifecycle
 #'   stage](https://www.tidyverse.org/lifecycle/) of your package as a whole.
-#'
 #' @export
 use_lifecycle <- function() {
   check_is_package("use_lifecycle()")
@@ -22,6 +17,8 @@ use_lifecycle <- function() {
       Turn on roxygen2 markdown support {ui_code('use_roxygen_md()')}")
   }
 
+  use_package("lifecycle")
+
   dest_dir <- proj_path("man", "figures")
   create_directory(dest_dir)
 
@@ -33,15 +30,9 @@ use_lifecycle <- function() {
 
   ui_todo(c(
     "Add badges in documentation topics by inserting one of:",
-    "- `r lifecycle::badge('experimental')`",
-    "- `r lifecycle::badge('superseded')`",
-    "- `r lifecycle::badge('questioning')`",
-    "- `r lifecycle::badge('deprecated')`"
-  ))
-
-  ui_todo(c(
-    "If you want to use functions like `lifecycle::deprecate_soft()` in your package:",
-    "- `usethis::use_package(\"lifecycle\")`"
+    "#' `r lifecycle::badge('experimental')`",
+    "#' `r lifecycle::badge('superseded')`",
+    "#' `r lifecycle::badge('deprecated')`"
   ))
 
   invisible(TRUE)

README.Rmd

@@ -19,7 +19,7 @@ knitr::opts_chunk$set(
 [![R-CMD-check](https://github.com/r-lib/usethis/workflows/R-CMD-check/badge.svg)](https://github.com/r-lib/usethis/actions)
 [![Codecov test coverage](https://codecov.io/gh/r-lib/usethis/branch/master/graph/badge.svg)](https://codecov.io/gh/r-lib/usethis?branch=master)
 [![CRAN status](https://www.r-pkg.org/badges/version/usethis)](https://CRAN.R-project.org/package=usethis)
-[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://www.tidyverse.org/lifecycle/#stable)
+[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
 <!-- badges: end -->
 
 usethis is a workflow package: it automates repetitive tasks that arise during project setup and development, both for R packages and non-package projects.

README.md

@@ -11,7 +11,7 @@ coverage](https://codecov.io/gh/r-lib/usethis/branch/master/graph/badge.svg)](ht
 [![CRAN
 status](https://www.r-pkg.org/badges/version/usethis)](https://CRAN.R-project.org/package=usethis)
 [![Lifecycle:
-stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://www.tidyverse.org/lifecycle/#stable)
+stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
 <!-- badges: end -->
 
 usethis is a workflow package: it automates repetitive tasks that arise

man/badges.Rd

@@ -0,0 +1,12 @@
+# use_lifecycle_badge() handles bad and good input
+
+    Code
+      use_lifecycle_badge()
+    Error <simpleError>
+      argument "stage" is missing, with no default
+    Code
+      use_lifecycle_badge("eperimental")
+    Error <rlang_error>
+      `stage` must be one of "experimental", "stable", "superseded", or "deprecated".
+      Did you mean "experimental"?
+

man/use_lifecycle.Rd

@@ -6,8 +6,12 @@ test_that("use_[cran|bioc]_badge() don't error", {
 
 test_that("use_lifecycle_badge() handles bad and good input", {
   create_local_package()
-  expect_error(use_lifecycle_badge(), "argument \"stage\" is missing")
-  expect_error(use_lifecycle_badge("eperimental"), "'arg' should be one of ")
+
+  expect_snapshot(error = TRUE, {
+    use_lifecycle_badge()
+    use_lifecycle_badge("eperimental")
+  })
+
   expect_error_free(use_lifecycle_badge("stable"))
 })