Make cyclocomp_linter() optional

closes #2554
r-lib · Apr 13, 2024 · ad71db5 · ad71db5
1 parent d86738f
commit ad71db5
Show file tree

Hide file tree

Showing 8 changed files with 13 additions and 12 deletions.
diff --git a/DESCRIPTION b/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,

diff --git a/R/cyclocomp_linter.R b/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",

diff --git a/R/zzz.R b/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(),

diff --git a/inst/lintr/linters.csv b/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

diff --git a/man/cyclocomp_linter.Rd b/man/cyclocomp_linter.Rd
diff --git a/man/default_linters.Rd b/man/default_linters.Rd
diff --git a/man/linters.Rd b/man/linters.Rd
diff --git a/tests/testthat/test-cyclocomp_linter.R b/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")