add note about dependencies

Author: lorenzwalthert

R/setup.R

@@ -237,71 +237,79 @@ upstream_repo_url_is_outdated <- function() {
 #' * additional-deps-roxygenize: Code to paste into
 #'   `.pre-commit-config.yaml` for the additional dependencies required by
 #'   the roxygenize hook.
+#' * additional-deps-lintr: Code to paste into
+#'   `.pre-commit-config.yaml` for the additional dependencies required by
+#'   the lintr hook if you use `--load-package`.
 #' @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 = "",
+snippet_generate <- function(snippet = "additional-deps-roxygenize",
                              open = rstudioapi::isAvailable(),
                              root = here::here()) {
-  rlang::arg_match(snippet, c("additional-deps-roxygenize"))
-  if (snippet == "additional-deps-roxygenize") {
-    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()
-    hard_dependencies <- deps[(deps$type %in% c("Depends", "Imports")), "package"] %>%
-      setdiff("R")
-    if (length(hard_dependencies) < 1) {
-      cli::cli_alert_success(paste0(
-        "According to {.code DESCRIPTION}`, there are no hard dependencies of ",
-        "your package. You are set."
-      ))
-      return()
-    }
-    hard_dependencies %>%
-      snippet_generate_impl_additional_deps_roxygenize() %>%
-      cat(sep = "")
-    cat("\n")
-    cli::cli_ul(paste0(
-      "Replace the `id: roxygenize` key in `.pre-commit-config.yaml` with the ",
-      "above code."
-    ))
-    cli::cli_alert_info(paste0(
-      "Note that CI services like {.url pre-commit.ci} have build-time ",
-      "restrictions and installing the above dependencies may exceed those, ",
-      "resulting in a timeout. In addition, system dependencies are not ",
-      "supported for {.url pre-commit.ci}. See ",
-      '{.code vignette("ci", package = "precommit")} for details and solutions.'
+  snippet_generator <- if(snippet == 'additional-deps-roxygenize') {
+    snippet_generate_impl_additional_deps_roxygenize
+  } else if (snippet == 'additional-deps-lintr') {
+    snippet_generate_impl_additional_deps_lintr
+  } else {
+   rlang::abort(paste0('Snippet "', snippet, '" not supported'))
+  }
+  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()
+  hard_dependencies <- deps[(deps$type %in% c("Depends", "Imports")), "package"] %>%
+    setdiff("R")
+  if (length(hard_dependencies) < 1) {
+    cli::cli_alert_success(paste0(
+      "According to {.code DESCRIPTION}`, there are no hard dependencies of ",
+      "your package. You are set."
     ))
-    remote_deps <- rlang::try_fetch(
-      desc::desc_get_field("Remotes"),
-      error = function(e) character()
-    )
-    if (length(remote_deps) > 0) {
-      rlang::warn(paste0(
-        "It seems you have remote dependencies in your `DESCRIPTION`. You ",
-        "need to edit the above list manually to match the syntax `renv::install()` ",
-        "understands, i.e. if you have in your `DESCRIPTION`
+    return()
+  }
+  
+  hard_dependencies %>%
+    snippet_generator() %>%
+    cat(sep = "")
+  cat("\n")
+  cli::cli_ul(paste0(
+    "Replace the `id: roxygenize` key in `.pre-commit-config.yaml` with the ",
+    "above code."
+  ))
+  cli::cli_alert_info(paste0(
+    "Note that CI services like {.url pre-commit.ci} have build-time ",
+    "restrictions and installing the above dependencies may exceed those, ",
+    "resulting in a timeout. In addition, system dependencies are not ",
+    "supported for {.url pre-commit.ci}. See ",
+    '{.code vignette("ci", package = "precommit")} for details and solutions.'
+  ))
+  remote_deps <- rlang::try_fetch(
+    desc::desc_get_field("Remotes"),
+    error = function(e) character()
+  )
+  if (length(remote_deps) > 0) {
+    rlang::warn(paste0(
+      "It seems you have remote dependencies in your `DESCRIPTION`. You ",
+      "need to edit the above list manually to match the syntax `renv::install()` ",
+      "understands, i.e. if you have in your `DESCRIPTION`
 
 Imports:
-    tidyr
+  tidyr
 Remotes:
-    tidyverse/tidyr@2fd80d5
+  tidyverse/tidyr@2fd80d5
 
 You need in your `.pre-commit-config.yaml`
 
-        additional_dependencies:
-        -    tidyverse/tidyr@2fd80d5
+      additional_dependencies:
+      -    tidyverse/tidyr@2fd80d5
 
 "
-      ))
-    }
+    ))
   }
   if (open) {
     precommit::open_config(root)
@@ -318,3 +326,14 @@ snippet_generate_impl_additional_deps_roxygenize <- function(packages, with_vers
         # roxygen requires loading pkg -> add dependencies from DESCRIPTION
         additional_dependencies:\n", out)
 }
+
+snippet_generate_impl_additional_deps_lintr <- function(packages, with_version = FALSE) {
+  out <- paste0(
+    "        -    ", packages, "\n",
+    collapse = ""
+  ) %>%
+    sort()
+  paste0("    -   id: lintr
+        # lintr requires loading pkg -> add dependencies from DESCRIPTION
+        additional_dependencies:\n", out)
+}

man/snippet_generate.Rd

@@ -1,4 +1,4 @@
-test_that("snippet generation works", {
+test_that("snippet generation works for roxygen", {
   local_test_setup(
     git = FALSE, use_precommit = FALSE, package = TRUE, install_hooks = FALSE
   )
@@ -27,6 +27,36 @@ test_that("snippet generation works", {
   )
 })
 
+
+test_that("snippet generation works for lintr", {
+  local_test_setup(
+    git = FALSE, use_precommit = FALSE, package = TRUE, install_hooks = FALSE
+  )
+  usethis::use_package("R", "Depends", "3.6.0")
+  expect_error(
+    out <- capture_output(snippet_generate("additional-deps-lintr")),
+    NA,
+  )
+  expect_equal(out, "")
+  usethis::use_package("styler")
+  expect_error(
+    out <- capture_output(snippet_generate("additional-deps-lintr")),
+    NA,
+  )
+  
+  expect_match(
+    out, "    -   id: lintr\n.*        -    styler\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$",
+  )
+})
+
 test_that("snippet generation only includes hard dependencies", {
   local_test_setup(
     git = FALSE, use_precommit = FALSE, package = TRUE,

tests/testthat/test-setup.R

@@ -270,15 +270,21 @@ you should either make sure the version you use when you call {roxygen2}
 interactively matches the one from in {precommit} or simply not run
 {roxygen2} manually.
 
-If you specify additional roclets through the `Roxygen:` field in
-`DESCRIPTION`, e.g. from [{pkgapi}](https://github.com/r-lib/pkgapi) you
-must specify the dependencies explicitly such that `renv::install()`
-understands it, e.g.
+Note that your package's dependencies must be listed in
+`additional_dependencies:` in your `.pre-commit-config.yaml` as shown
+below. You can generate these for easy c/p with
+`snippet_generate("additional-deps-roxygenize")` .
+
+Similarly, if you specify additional roclets through the `Roxygen:`
+field in `DESCRIPTION`, e.g. from
+[{pkgapi}](https://github.com/r-lib/pkgapi) you must specify the
+dependencies explicitly such that `renv::install()` understands it.
 
 ```         
   id: roxygenize
   additional_dependencies:
   - r-lib/pkgapi
+  - dplyr
 ```
 
 **Arguments**
@@ -371,8 +377,10 @@ should set this with the field `verbose: true`.
 -   `load-package`: When linting a package, {lintr} uses
     `pkgload::load_all()` to load the package before running
     `lintr::lint()`. Note that you need to list all dependencies of the
-    package under `additional_dependencies:` in your
-    `.pre-commit-config.yaml`.
+    package under `additional_dependencies:` for the `lintr:`hook in
+    your `.pre-commit-config.yaml`. You can generate the code snip o for
+    c/p with `snippet_generate("additional-deps-lintr")`. This argument
+    was added in 0.4.3.9005.
 
 The `.lintr` config file as documented in the [`.lintr`
 documentation](https://github.com/r-lib/lintr#project-configuration) is