Merge pull request #301 from lorenzwalthert/devel

- improve instructions

Author: lorenzwalthert

API

@@ -13,7 +13,7 @@ path_pre_commit_exec(check_if_exists = TRUE)
 path_precommit_exec(check_if_exists = TRUE)
 roxygen_assert_additional_dependencies()
 roxygenize_with_cache(key, dirs)
-snippet_generate(snippet, root = here::here())
+snippet_generate(snippet, open = rstudioapi::isAvailable(), root = here::here())
 uninstall_precommit(scope = "repo", ask = "user", root = here::here())
 update_precommit()
 use_precommit(config_source = getOption("precommit.config_source"), force = FALSE, legacy_hooks = "forbid", open = rstudioapi::isAvailable(), install_hooks = TRUE, root = here::here())

R/roxygen2.R

@@ -115,8 +115,9 @@ roxygen_assert_additional_dependencies <- function() {
         -    tidyr
         -    dplyr\n\n",
       "Call ",
-      "`precommit::snippet_generate('additional-deps-roxygenize')`",
-      "and paste the ",
+      "`precommit::snippet_generate('additional-deps-roxygenize')` ",
+      "(requires the dev version of {precommit}, install with with ",
+      "`remotes::install_github('lorenzwalthert/precommit')` and paste the ",
       "output into the file `.pre-commit-config.yaml`. This requires precommit",
       " > 0.1.3 and assumes you declared all dependencies in `DESCRIPTION`.",
       "\n\nContext: https://github.com/lorenzwalthert/precommit/issues/243",

R/setup.R

@@ -103,18 +103,28 @@ upstream_repo_url_is_outdated <- function() {
 #'   `.pre-commit-config.yaml` for the additional dependencies required by
 #'   roxygen2.
 #' @param snippet Name of the snippet.
+#' @param open Whether or not to open the .pre-commit-config.yaml. The default
+#' is `TRUE` when working in  RStudio. Otherwise, we recommend manually opening
+#' the file.
 #' @inheritParams fallback_doc
 #' @export
-snippet_generate <- function(snippet = "", root = here::here()) {
+snippet_generate <- function(snippet = "",
+                             open = rstudioapi::isAvailable(),
+                             root = here::here()) {
   rlang::arg_match(snippet, c("additional-deps-roxygenize"))
   if (snippet == "additional-deps-roxygenize") {
-    rlang::inform(
-      "Generating snippet using installed versions of all dependencies.\n"
-    )
+    rlang::inform(paste(
+      "Generating snippet using CRAN versions. If you need another source,",
+      "specify with syntax that `renv::install()` understands (see examples in",
+      "help file).",
+      "\n"
+    ))
     deps <- desc::desc_get_deps()
     deps <- deps[order(deps$package), ]
     snippet_generate_impl_additional_deps_roxygenize(deps$package) %>%
       cat(sep = "")
+    cat("\n")
+    cli::cli_ul("Copy the above into `.pre-commit-config.yaml`.")
     remote_deps <- rlang::with_handlers(
       desc::desc_get_field("Remotes"),
       error = function(e) character()
@@ -134,16 +144,20 @@ You need in your `.pre-commit-config.yaml`
 
         additional_dependencies:
         -    tidyverse/tidyr@2fd80d5
-      "
+
+"
       ))
     }
   }
+  if (open) {
+    precommit::open_config(root)
+  }
 }
 
-snippet_generate_impl_additional_deps_roxygenize <- function(packages) {
+snippet_generate_impl_additional_deps_roxygenize <- function(packages, with_version = FALSE) {
   out <- paste0(
-    "        -    ", packages, "@",
-    purrr::map_chr(packages, ~ as.character(packageVersion(.x))), "\n",
+    "        -    ", packages, if (with_version) "@",
+    if (with_version) purrr::map_chr(packages, ~ as.character(packageVersion(.x))), "\n",
     collapse = ""
   ) %>%
     sort()

man/snippet_generate.Rd

@@ -6,14 +6,14 @@ test_that("snippet generation works", {
     NA
   )
   expect_match(
-    out, "    -   id: roxygenize\n.*        -    styler@.+\n        -    testthat@.+$",
+    out, "    -   id: roxygenize\n.*        -    styler\n        -    testthat\n$",
   )
   desc::desc_set("Remotes", "r-lib/styler")
   expect_warning(
     out <- capture_output(snippet_generate("additional-deps-roxygenize")),
     "you have remote dependencies "
   )
   expect_match(
-    out, "    -   id: roxygenize\n.*        -    styler@.+\n        -    testthat@.+$",
+    out, "    -   id: roxygenize\n.*        -    styler\n        -    testthat\n$",
   )
 })