Deprecate path and ... arguments

Author: lionel-

DESCRIPTION

@@ -29,6 +29,7 @@ Imports:
     glue,
     grDevices,
     htmltools,
+    lifecycle,
     purrr (>= 0.2.0),
     rlang,
     R6,

NAMESPACE

@@ -5,6 +5,7 @@ export(write_svg)
 import(rlang)
 importFrom(R6,R6Class)
 importFrom(glue,glue)
+importFrom(lifecycle,deprecated)
 importFrom(purrr,compact)
 importFrom(purrr,every)
 importFrom(purrr,keep)

R/testthat-ui.R

@@ -20,7 +20,7 @@
 #'   If you need to test a plot with non-printable objects (e.g. base
 #'   plots), `fig` can be a function that generates and prints the
 #'   plot, e.g. `fig = function() plot(1:3)`.
-#' @param path,... TODO: Deprecated
+#' @param path,... `r lifecycle::badge('deprecated')`.
 #' @param writer A function that takes the plot, a target SVG file,
 #'   and an optional plot title. It should transform the plot to SVG
 #'   in a deterministic way and write it to the target file. See
@@ -95,6 +95,19 @@ expect_doppelganger <- function(title,
   testcase <- make_testcase_file(fig_name)
   writer(fig, testcase, title)
 
+  if (!missing(...)) {
+    lifecycle::deprecate_soft(
+      "1.0.0",
+      "vdiffr::expect_doppelganger(... = )",
+    )
+  }
+  if (lifecycle::is_present(path)) {
+    lifecycle::deprecate_soft(
+      "1.0.0",
+      "vdiffr::expect_doppelganger(cran = )",
+    )
+  }
+
   if (is_graphics_engine_stale()) {
     testthat::skip(paste_line(
       "The R graphics engine is too old.",

R/vdiffr.R renamed to R/vdiffr-package.R

@@ -3,6 +3,7 @@
 #' @importFrom purrr map map_chr keep walk every partial map2_chr compact
 #' @importFrom R6 R6Class
 #' @useDynLib vdiffr, .registration = TRUE
+#' @keywords internal
 "_PACKAGE"
 
 SVG_ENGINE_VER <- "2.0"
@@ -14,3 +15,8 @@ svg_engine_ver <- function() {
 .onLoad <- function(lib, pkg) {
   set_engine_version(SVG_ENGINE_VER)
 }
+
+## usethis namespace: start
+#' @importFrom lifecycle deprecated
+## usethis namespace: end
+NULL