Make cyclocomp_linter() optional

DESCRIPTION

@@ -25,7 +25,6 @@ Depends:
 Imports:
     backports (>= 1.1.7),
     codetools,
-    cyclocomp,
     digest,
     glue,
     knitr,
@@ -37,6 +36,7 @@ Imports:
 Suggests:
     bookdown,
     cli,
+    cyclocomp,
     jsonlite,
     patrick (>= 0.2.0),
     rlang,

NAMESPACE

@@ -171,7 +171,6 @@ export(with_id)
 export(xml_nodes_to_lints)
 export(xp_call_name)
 export(yoda_test_linter)
-importFrom(cyclocomp,cyclocomp)
 importFrom(glue,glue)
 importFrom(glue,glue_collapse)
 importFrom(rex,character_class)

R/cyclocomp_linter.R

@@ -2,10 +2,10 @@
 #'
 #' Check for overly complicated expressions. See [cyclocomp::cyclocomp()].
 #'
-#' @param complexity_limit Maximum cyclomatic complexity, default 15. Expressions more complex
+#' @param complexity_limit Maximum cyclomatic complexity, default `15`. Expressions more complex
 #' than this are linted. See [cyclocomp::cyclocomp()].
 #'
-#' @examples
+#' @examplesIf requireNamespace("cyclocomp", quietly = TRUE)
 #' # will produce lints
 #' lint(
 #'   text = "if (TRUE) 1 else 2",
@@ -23,6 +23,12 @@
 #' @export
 cyclocomp_linter <- function(complexity_limit = 15L) {
   Linter(linter_level = "expression", function(source_expression) {
+    # nocov start
+    if (!requireNamespace("cyclocomp", quietly = TRUE)) {
+      cli::cli_abort("'cyclocomp' package needs to be installed for this linter.")
+    }
+    # nocov end
+
     complexity <- try_silently(
       cyclocomp::cyclocomp(parse(text = source_expression$content))
     )

R/lintr-package.R

@@ -8,7 +8,6 @@
 "_PACKAGE"
 
 ## lintr namespace: start
-#' @importFrom cyclocomp cyclocomp
 #' @importFrom glue glue glue_collapse
 #' @importFrom rex rex regex re_matches re_substitutes character_class
 #' @importFrom stats na.omit

R/zzz.R

@@ -17,7 +17,6 @@ default_linters <- modify_defaults(
   brace_linter(),
   commas_linter(),
   commented_code_linter(),
-  cyclocomp_linter(),
   equals_na_linter(),
   function_left_parentheses_linter(),
   indentation_linter(),

inst/lintr/linters.csv

@@ -17,7 +17,7 @@ conjunct_test_linter,package_development best_practices readability configurable
 consecutive_assertion_linter,style readability consistency
 consecutive_mutate_linter,consistency readability configurable efficiency
 consecutive_stopifnot_linter,style readability consistency deprecated
-cyclocomp_linter,style readability best_practices default configurable
+cyclocomp_linter,style readability best_practices configurable
 duplicate_argument_linter,correctness common_mistakes configurable
 empty_assignment_linter,readability best_practices
 equals_na_linter,robustness correctness common_mistakes default

tests/testthat/test-cache.R

@@ -434,6 +434,8 @@ test_that("it works outside of a package", {
 })
 
 test_that("cache = TRUE workflow works", {
+  skip_if_not_installed("cyclocomp")
+
   # Need a test structure with a safe to load .lintr
   pkg <- "dummy_packages/package"
   files <- normalizePath(list.files(pkg, recursive = TRUE, full.names = TRUE))

tests/testthat/test-cyclocomp_linter.R

@@ -1,4 +1,6 @@
 test_that("returns the correct linting", {
+  skip_if_not_installed("cyclocomp")
+
   cc_linter_1 <- cyclocomp_linter(1L)
   cc_linter_2 <- cyclocomp_linter(2L)
   lint_msg <- rex::rex("Reduce the cyclomatic complexity of this function")

tests/testthat/test-get_source_expressions.R

@@ -414,6 +414,8 @@ param_df$.test_name <- with(param_df, sprintf("%s on expression %d", linter, exp
 patrick::with_parameters_test_that(
   "linters pass with xml_missing() content",
   {
+    skip_if_not_installed("cyclocomp")
+
     if (linter == "backport_linter") {
       # otherwise we test the trivial linter (#2339)
       linter <- backport_linter(r_version = "3.6.0")