Deprecate outdated workflows (#2650)

Fixes #2427

Author: hadley

NEWS.md

@@ -1,5 +1,6 @@
 # devtools (development version)
 
+* `bash()`, `create()`, `missing_s3()`, `reload()`, `show_news()`, and `wd()` are now deprecated. These functions are all historical parts of our workflow that we no longer use or recommend. `create()` is superseded by `usethis::create_package()`.
 * `build_manual()` reports more details on failure (#2586).
 * `build_vignettes()` and `clean_vignettes()` are now deprecated. We no longer recommend building vignettes in this way; instead use `pkgdown::build_article()` to render articles locally (#2488).
 * `build_site()` now just calls `pkgdown::build_site()`, meaning that you will get more (informative) output by default (#2578).

R/bash.R

@@ -1,8 +1,16 @@
 #' Open bash shell in package directory
 #'
+#' @description
+#' `r lifecycle::badge("deprecated")`
+#'
+#' `bash()` is deprecated because we no longer use or recommend this workflow.
+#' Open bash shell in package directory
+#'
 #' @template devtools
 #' @export
+#' @keywords internal
 bash <- function(pkg = ".") {
+  lifecycle::deprecate_warn("2.5.0", "bash()")
   pkg <- as.package(pkg)
 
   withr::with_dir(pkg$path, system("bash"))

R/create.R

@@ -1,11 +1,19 @@
 #' Create a package
 #'
+#' @description
+#' `r lifecycle::badge("deprecated")`
+#'
+#' `create()` is deprecated. Please use [usethis::create_package()] directly
+#' instead.
+#'
 #' @param path A path. If it exists, it is used. If it does not exist, it is
 #'   created, provided that the parent path exists.
 #' @param ... Additional arguments passed to [usethis::create_package()]
 #' @inheritParams usethis::create_package
 #' @return The path to the created package, invisibly.
 #' @export
+#' @keywords internal
 create <- function(path, ..., open = FALSE) {
+  lifecycle::deprecate_warn("2.5.0", "create()", "usethis::create_package()")
   usethis::create_package(path, ..., open = open)
 }

R/missing-s3.R

@@ -1,10 +1,17 @@
 #' Find missing s3 exports
 #'
-#' The method is heuristic - looking for objs with a period in their name.
+#' @description
+#' `r lifecycle::badge("deprecated")`
+#'
+#' `missing_s3()` is deprecated because roxygen2 now provides the same
+#' functionality. Run `devtools::document()` and look for
+#' `"Missing documentation for S3 method"` warnings.
 #'
 #' @template devtools
 #' @export
+#' @keywords internal
 missing_s3 <- function(pkg = ".") {
+  lifecycle::deprecate_warn("2.5.0", "missing_s3()")
   pkg <- as.package(pkg)
   loaded <- load_all(pkg$path)
 

R/reload.R

@@ -1,28 +1,19 @@
 #' Unload and reload package
 #'
-#' This attempts to unload and reload an _installed_ package. If the package is
-#' not loaded already, it does nothing. It's not always possible to cleanly
-#' unload a package: see the caveats in [unload()] for some of the potential
-#' failure points. If in doubt, restart R and reload the package with
-#' [library()].
+#' @description
+#' `r lifecycle::badge("deprecated")`
+#'
+#' `reload()` is deprecated because we no longer use or recommend this
+#' workflow. Instead, we recommend [load_all()] to load a package for
+#' interactive development.
 #'
 #' @template devtools
 #' @param quiet if `TRUE` suppresses output from this function.
 #' @seealso [load_all()] to load a package for interactive development.
-#' @examples
-#' \dontrun{
-#' # Reload package that is in current directory
-#' reload(".")
-#'
-#' # Reload package that is in ./ggplot2/
-#' reload("ggplot2/")
-#'
-#' # Can use inst() to find the package path
-#' # This will reload the installed ggplot2 package
-#' reload(pkgload::inst("ggplot2"))
-#' }
 #' @export
+#' @keywords internal
 reload <- function(pkg = ".", quiet = FALSE) {
+  lifecycle::deprecate_warn("2.5.0", "reload()", "load_all()")
   pkg <- as.package(pkg)
 
   if (is_attached(pkg)) {

R/show-news.R

@@ -1,11 +1,19 @@
 #' Show package news
 #'
+#' @description
+#' `r lifecycle::badge("deprecated")`
+#'
+#' `show_news()` is deprecated because we no longer use or recommend this
+#' workflow.
+#'
 #' @template devtools
 #' @param latest if `TRUE`, only show the news for the most recent
 #'   version.
 #' @param ... other arguments passed on to `news`
 #' @export
+#' @keywords internal
 show_news <- function(pkg = ".", latest = TRUE, ...) {
+  lifecycle::deprecate_warn("2.5.0", "show_news()")
   pkg <- as.package(pkg)
   news_path <- find_news(pkg$path)
 

R/wd.R

@@ -1,10 +1,18 @@
 #' Set working directory
 #'
+#' @description
+#' `r lifecycle::badge("deprecated")`
+#'
+#' `wd()` is deprecated because we no longer use or recommend this workflow.
+#' Set working directory
+#'
 #' @template devtools
 #' @param path path within package. Leave empty to change working directory
 #'   to package directory.
 #' @export
+#' @keywords internal
 wd <- function(pkg = ".", path = "") {
+  lifecycle::deprecate_warn("2.5.0", "wd()")
   pkg <- as.package(pkg)
   path <- path(pkg$path, path)
 

_pkgdown.yml

@@ -24,10 +24,8 @@ reference:
   - build_site
   - starts_with("check_")
   - check
-  - create
   - document
   - load_all
-  - reload
   - spell_check
   - test
 
@@ -38,24 +36,27 @@ reference:
 
 - title: Utilities
   contents:
-  - bash
   - dev_sitrep
   - lint
-  - missing_s3
   - run_examples
   - session_info
-  - show_news
   - starts_with("source_")
-  - wd
   - save_all
-  
+
 - title: Deprecated
   contents:
+  - bash
   - build_vignettes
   - clean_vignettes
-  - release
+  - create
+  - dev_mode
   - install-deprecated
   - install_deps
+  - missing_s3
+  - reload
+  - release
+  - show_news
+  - wd
   - devtools-deprecated
 
 news: