options for strict tests; few enhancements (#193)

- part of
insightsengineering/coredev-tasks#478
- please read this for more info about the implementation:
insightsengineering/coredev-tasks#478 (comment)
- added more excludes in spelling hook
- removed unnecessary empty first line in examples as this is actually
being rendered

Please review the changes carefully and let me know if there is
something you don't like.

---------

Co-authored-by: 27856297+dependabot-preview[bot]@users.noreply.github.com <27856297+dependabot-preview[bot]@users.noreply.github.com>

.pre-commit-config.yaml

@@ -43,7 +43,11 @@ repos:
           (.*/|)\.Rprofile|
           (.*/|)\.travis\.y[a]?ml|
           (.*/|)appveyor\.y[a]?ml|
+          (.*/|)CODEOWNERS|
+          (.*/|)DESCRIPTION|
+          (.*/|)LICENSE|
           (.*/|)NAMESPACE|
+          (.*/|)staged_dependencies\.y[a]?ml|
           (.*/|)renv/settings\.dcf|
           (.*/|)renv\.lock|
           (.*/|)WORDLIST|

DESCRIPTION

@@ -33,14 +33,15 @@ Imports:
 Suggests:
     dplyr (>= 1.0.0),
     knitr (>= 1.42),
-    lifecycle  (>= 0.2.0),
+    lifecycle (>= 0.2.0),
     stringi (>= 1.6),
-    testthat (>= 3.0.4)
+    testthat (>= 3.0.4),
+    withr (>= 2.0.0)
 VignetteBuilder:
     knitr
 Config/Needs/verdepcheck: insightsengineering/formatters,
     tidyverse/tibble, mllg/checkmate, tidyverse/dplyr, yihui/knitr,
-    r-lib/lifecycle, r-lib/testthat
+    r-lib/lifecycle, gogolewski/stringi, r-lib/testthat, r-lib/withr
 Config/Needs/website: insightsengineering/nesttemplate
 Config/testthat/edition: 3
 Encoding: UTF-8

R/listing_export.R

@@ -2,7 +2,6 @@
 #'
 #' @export
 #' @examples
-#'
 #' dat <- ex_adae
 #' lsting <- as_listing(dat[1:25, ], key_cols = c("USUBJID", "AESOC")) %>%
 #'   add_listing_col("AETOXGR") %>%

R/rlistings_methods.R

@@ -245,7 +245,6 @@ setMethod(
 #' the relevant element of the listing updated.
 #'
 #' @examples
-#'
 #' lsting <- as_listing(mtcars)
 #' main_title(lsting) <- "Hi there"
 #'

tests/testthat/setup-options.R

@@ -0,0 +1,20 @@
+# `opts_partial_match_old` is left for exclusions due to partial matching in dependent packages (i.e. not fixable here)
+# it might happen that it is not used right now, but it is left for possible future use
+# use with: `withr::with_options(opts_partial_match_old, { ... })` inside the test
+opts_partial_match_old <- list(
+  warnPartialMatchDollar = getOption("warnPartialMatchDollar"),
+  warnPartialMatchArgs = getOption("warnPartialMatchArgs"),
+  warnPartialMatchAttr = getOption("warnPartialMatchAttr")
+)
+opts_partial_match_new <- list(
+  warnPartialMatchDollar = TRUE,
+  warnPartialMatchArgs = TRUE,
+  warnPartialMatchAttr = TRUE
+)
+
+if (isFALSE(getFromNamespace("on_cran", "testthat")()) && requireNamespace("withr", quietly = TRUE)) {
+  withr::local_options(
+    opts_partial_match_new,
+    .local_envir = testthat::teardown_env()
+  )
+}