refactor!: adapt code to funky pkg

Author: salim-b

DESCRIPTION

@@ -22,10 +22,11 @@ Imports:
     cli (>= 3.0.0),
     dplyr (>= 1.0.7),
     fs (>= 1.4.1),
+    funky (>= 0.0.9000),
     knitr (>= 1.28),
     lifecycle (>= 1.0.1),
     magrittr (>= 2.0.0),
-    pal (>= 0.0.9098),
+    pal (>= 0.0.9102),
     purrr (>= 1.0.0),
     rlang (>= 0.4.11),
     stringr (>= 1.4.0),

NAMESPACE

@@ -2,11 +2,11 @@
 
 export(default_exclusions)
 export(default_linters)
+export(funky_config)
 export(gen_pkgdown_ref)
 export(lint_rmd)
 export(load_pkg)
 export(main_rmd)
-export(pkg_config)
 export(process_pkg)
 export(purl_rmd)
 export(run_nopurl_rmd)

R/pkgpurl-package.R

@@ -1,9 +1,9 @@
 #' @section Package configuration:
 #'
-#' `r pkgsnip::md_snip(id = "pkg_config", pkg = this_pkg)`
+#' `r pkgsnip::md_snip(id = "funky_config")`
 #'
 #' ```{r, echo = FALSE}
-#' pal::print_pkg_config()
+#' funky::print_config()
 #' ```
 #'
 #' @keywords internal

R/pkgpurl.gen.R

@@ -21,8 +21,6 @@ utils::globalVariables(names = c(".",
                                  "is_help_topic",
                                  "subnode_ix"))
 
-this_pkg <- utils::packageName()
-
 data_special_headings <-
   tibble::tibble(type = character(),
                  heading_texts = list(),
@@ -350,9 +348,9 @@ rmd_files <- function(path) {
 #' @family high_lvl
 #' @export
 process_pkg <- function(path = ".",
-                        add_copyright_notice = pal::pkg_config_val("add_copyright_notice"),
-                        add_license_notice = pal::pkg_config_val("add_license_notice"),
-                        gen_pkgdown_ref = pal::pkg_config_val("gen_pkgdown_ref"),
+                        add_copyright_notice = funky::config_val("add_copyright_notice"),
+                        add_license_notice = funky::config_val("add_license_notice"),
+                        gen_pkgdown_ref = funky::config_val("gen_pkgdown_ref"),
                         env = parent.frame(),
                         document = TRUE,
                         build_and_install = TRUE,
@@ -497,11 +495,11 @@ load_pkg <- function(path = ".",
 #' under `R/*.R` is generated. For the sake of clarity, it's generally advised to prefer the `.nopurl` suffix over hiding files.
 #'
 #' @param path Path to the root of the package directory.
-#' @param add_copyright_notice `r pkg_config$description[pkg_config$key == "add_copyright_notice"]` A logical scalar. Only applies if `path` [is actually an R
-#'   package directory][pal::is_pkg_dir].
-#' @param add_license_notice `r pkg_config$description[pkg_config$key == "add_license_notice"]` A logical scalar. Only applies if `path` [is actually an R
+#' @param add_copyright_notice `r funky_config$description[funky_config$key == "add_copyright_notice"]` A logical scalar. Only applies if `path` [is actually an
+#'   R package directory][pal::is_pkg_dir].
+#' @param add_license_notice `r funky_config$description[funky_config$key == "add_license_notice"]` A logical scalar. Only applies if `path` [is actually an R
 #'   package directory][pal::is_pkg_dir].
-#' @param gen_pkgdown_ref `r pkg_config$description[pkg_config$key == "gen_pkgdown_ref"]` A logical scalar. Only applies if `path` [is actually an R package
+#' @param gen_pkgdown_ref `r funky_config$description[funky_config$key == "gen_pkgdown_ref"]` A logical scalar. Only applies if `path` [is actually an R package
 #'   directory][pal::is_pkg_dir], [pkgdown is set up][pal::is_pkgdown_dir] and a [main R Markdown file][main_rmd()] exists.
 #' @param env Environment to evaluate R Markdown inline code expressions in when generating the pkgdown reference index. Only relevant if
 #'   `gen_pkgdown_ref = TRUE`.
@@ -510,9 +508,9 @@ load_pkg <- function(path = ".",
 #' @family high_lvl
 #' @export
 purl_rmd <- function(path = ".",
-                     add_copyright_notice = pal::pkg_config_val("add_copyright_notice"),
-                     add_license_notice = pal::pkg_config_val("add_license_notice"),
-                     gen_pkgdown_ref = pal::pkg_config_val("gen_pkgdown_ref"),
+                     add_copyright_notice = funky::config_val("add_copyright_notice"),
+                     add_license_notice = funky::config_val("add_license_notice"),
+                     gen_pkgdown_ref = funky::config_val("gen_pkgdown_ref"),
                      env = parent.frame()) {
 
   checkmate::assert_flag(add_copyright_notice)
@@ -1110,13 +1108,13 @@ default_exclusions <- function(excl_vignettes = TRUE) {
 #' names(pkgpurl::default_linters)
 "default_linters"
 
-#' `r pkgsnip::title_lbl("pkg_config", pkg = "pkgpurl")`
+#' `r pkgsnip::title_lbl("funky_config", pkg = "pkgpurl")`
 #'
-#' `r pkgsnip::description_lbl("pkg_config", pkg = "pkgpurl")`
+#' `r pkgsnip::description_lbl("funky_config", pkg = "pkgpurl")`
 #'
-#' @format `r pkgsnip::return_lbl("tibble_cols", cols = colnames(pkg_config))`
+#' @format `r pkgsnip::return_lbl("tibble_cols", cols = colnames(funky_config))`
 #' @export
 #'
 #' @examples
-#' pkgpurl::pkg_config
-"pkg_config"
+#' pkgpurl::funky_config
+"funky_config"

R/sysdata.rda

@@ -22,12 +22,6 @@ utils::globalVariables(names = c(".",
 
 ## Constants
 
-### `this_pkg`
-
-```{r}
-this_pkg <- utils::packageName()
-```
-
 ### `data_special_headings`
 
 ```{r}
@@ -442,9 +436,9 @@ NOTES:
 #' @family high_lvl
 #' @export
 process_pkg <- function(path = ".",
-                        add_copyright_notice = pal::pkg_config_val("add_copyright_notice"),
-                        add_license_notice = pal::pkg_config_val("add_license_notice"),
-                        gen_pkgdown_ref = pal::pkg_config_val("gen_pkgdown_ref"),
+                        add_copyright_notice = funky::config_val("add_copyright_notice"),
+                        add_license_notice = funky::config_val("add_license_notice"),
+                        gen_pkgdown_ref = funky::config_val("gen_pkgdown_ref"),
                         env = parent.frame(),
                         document = TRUE,
                         build_and_install = TRUE,
@@ -628,11 +622,11 @@ NOTES:
 #' under `R/*.R` is generated. For the sake of clarity, it's generally advised to prefer the `.nopurl` suffix over hiding files.
 #'
 #' @param path Path to the root of the package directory.
-#' @param add_copyright_notice `r pkg_config$description[pkg_config$key == "add_copyright_notice"]` A logical scalar. Only applies if `path` [is actually an R
-#'   package directory][pal::is_pkg_dir].
-#' @param add_license_notice `r pkg_config$description[pkg_config$key == "add_license_notice"]` A logical scalar. Only applies if `path` [is actually an R
+#' @param add_copyright_notice `r funky_config$description[funky_config$key == "add_copyright_notice"]` A logical scalar. Only applies if `path` [is actually an
+#'   R package directory][pal::is_pkg_dir].
+#' @param add_license_notice `r funky_config$description[funky_config$key == "add_license_notice"]` A logical scalar. Only applies if `path` [is actually an R
 #'   package directory][pal::is_pkg_dir].
-#' @param gen_pkgdown_ref `r pkg_config$description[pkg_config$key == "gen_pkgdown_ref"]` A logical scalar. Only applies if `path` [is actually an R package
+#' @param gen_pkgdown_ref `r funky_config$description[funky_config$key == "gen_pkgdown_ref"]` A logical scalar. Only applies if `path` [is actually an R package
 #'   directory][pal::is_pkg_dir], [pkgdown is set up][pal::is_pkgdown_dir] and a [main R Markdown file][main_rmd()] exists.
 #' @param env Environment to evaluate R Markdown inline code expressions in when generating the pkgdown reference index. Only relevant if
 #'   `gen_pkgdown_ref = TRUE`.
@@ -641,9 +635,9 @@ NOTES:
 #' @family high_lvl
 #' @export
 purl_rmd <- function(path = ".",
-                     add_copyright_notice = pal::pkg_config_val("add_copyright_notice"),
-                     add_license_notice = pal::pkg_config_val("add_license_notice"),
-                     gen_pkgdown_ref = pal::pkg_config_val("gen_pkgdown_ref"),
+                     add_copyright_notice = funky::config_val("add_copyright_notice"),
+                     add_license_notice = funky::config_val("add_license_notice"),
+                     gen_pkgdown_ref = funky::config_val("gen_pkgdown_ref"),
                      env = parent.frame()) {
   
   checkmate::assert_flag(add_copyright_notice)
@@ -1279,17 +1273,17 @@ default_exclusions <- function(excl_vignettes = TRUE) {
 "default_linters"
 ```
 
-### `pkg_config`
+### `funky_config`
 
 ```{r}
-#' `r pkgsnip::title_lbl("pkg_config", pkg = "pkgpurl")`
+#' `r pkgsnip::title_lbl("funky_config", pkg = "pkgpurl")`
 #'
-#' `r pkgsnip::description_lbl("pkg_config", pkg = "pkgpurl")`
+#' `r pkgsnip::description_lbl("funky_config", pkg = "pkgpurl")`
 #'
-#' @format `r pkgsnip::return_lbl("tibble_cols", cols = colnames(pkg_config))`
+#' @format `r pkgsnip::return_lbl("tibble_cols", cols = colnames(funky_config))`
 #' @export
 #'
 #' @examples
-#' pkgpurl::pkg_config
-"pkg_config"
+#' pkgpurl::funky_config
+"funky_config"
 ```

Rmd/pkgpurl.Rmd

@@ -132,13 +132,11 @@ default_linters <- lintr::linters_with_defaults(
 )
 ```
 
-## `pkg_config`
+## `funky_config`
 
 ```{r}
-pkg_config <-
-  tibble::tibble(key = character(),
-                 default_value = list(),
-                 description = character()) |>
+funky_config <-
+  funky::ptype_config |>
   tibble::add_row(key = "add_copyright_notice",
                   default_value = list(TRUE),
                   description = paste0("Whether or not to add a **copyright notice** at the beginning of the generated `.R` files as recommended by e.g. the ",
@@ -166,7 +164,7 @@ to package users.
 
 ```{r}
 usethis::use_data(default_linters,
-                  pkg_config,
+                  funky_config,
                   internal = TRUE,
                   overwrite = TRUE,
                   compress = "xz",