document

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, open = interactive(), 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/setup.R

@@ -103,10 +103,13 @@ 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 = "",
-                             open = interactive(),
+                             open = rstudioapi::isAvailable(),
                              root = here::here()) {
   rlang::arg_match(snippet, c("additional-deps-roxygenize"))
   if (snippet == "additional-deps-roxygenize") {