feat: improve text_file_paths_default__

Author: WetRobot

NAMESPACE

@@ -21,7 +21,5 @@ export(example_text_file_names)
 export(example_text_file_path)
 export(example_text_file_paths)
 export(extract_keyed_comment_blocks)
-export(pkg_doc_fun)
-export(pkg_doc_package_description)
 export(render_codedoc)
 export(render_codedoc_)

NEWS.md

@@ -1,5 +1,14 @@
 <!-- generated by R package codedoc; do not modify! -->
 
+## News for version 0.8.0
+
+### codedoc::extract_keyed_comment_blocks
+
+`codedoc::extract_keyed_comment_blocks` default for `text_file_paths`
+improved: It now excludes files ignored by `git` if it has been installed on
+the system.
+
+
 ## News for version 0.7.0
 
 ### codedoc::extract_keyed_comment_blocks

R/collect_raw.R

@@ -221,6 +221,9 @@ text_file_paths_default__ <- function() {
   #     winslash = "/",
   #     mustWork = FALSE
   #   )
+  #   if (git_is_installed__() && git_used_here__()) {
+  #     tfp <- tfp[!git_ignores__(tfp)]
+  #   }
   #   tfp <- tfp[!grepl("/renv/library/", tfp)]
   # }
   # ```
@@ -236,6 +239,11 @@ text_file_paths_default__ <- function() {
   # through files in installed R packages. That is the typical directory for
   # packages installed by package `renv`.
   # @codedoc_comment_block news("codedoc::extract_keyed_comment_blocks", "2025-04-10", "0.7.0")
+  # @codedoc_comment_block news("codedoc::extract_keyed_comment_blocks", "2025-04-16", "0.8.0")
+  # `codedoc::extract_keyed_comment_blocks` default for `text_file_paths`
+  # improved: It now excludes files ignored by `git` if it has been installed on
+  # the system.
+  # @codedoc_comment_block news("codedoc::extract_keyed_comment_blocks", "2025-04-16", "0.8.0")
   out <- {
     tfp <- dir(
       path = getwd(),
@@ -250,6 +258,9 @@ text_file_paths_default__ <- function() {
       mustWork = FALSE
     )
     tfp <- tfp[!grepl("/renv/library/", tfp)]
+    if (git_is_installed__() && git_used_here__()) {
+      tfp <- tfp[!git_ignores__(tfp)]
+    }
     tfp
   }
   return(out)

R/git.R

@@ -0,0 +1,39 @@
+git_is_installed__ <- function() {
+  tryCatch(
+    expr = is.character(
+      system2("git", "version", stdout = TRUE, stderr = TRUE)
+    ),
+    error = function(e) FALSE,
+    warning = function(w) FALSE
+  )
+}
+
+git_used_here__ <- function() {
+  tryCatch(
+    expr = is.character(
+      system2("git", "status", stdout = TRUE, stderr = TRUE)
+    ),
+    error = function(e) FALSE,
+    warning = function(w) FALSE
+  )
+}
+
+git_ignores__ <- function(file_paths) {
+  dbc::assert_prod_input_file_exists(file_paths)
+  not_ignored_file_paths <- system2(
+    "git",
+    c("ls-files", "--cached", "--others", "--exclude-standard"),
+    stdout = TRUE
+  )
+  not_ignored_file_paths <- normalizePath(
+    not_ignored_file_paths,
+    winslash = "/",
+    mustWork = FALSE
+  )
+  file_paths <- normalizePath(
+    file_paths,
+    winslash = "/",
+    mustWork = FALSE
+  )
+  !file_paths %in% not_ignored_file_paths
+}