Skip to contents

List Documentation and Project Marker Files

Source: R/ls-docs.R
ls-docs.Rd

Recursive helpers to list documentation files and project marker files while ignoring selected directory names.

Usage

ls_docs(x = ".", ignore = c(".archive", ".git", "Rproj.user"), ext = "md")

ls_md(x = ".", ignore = c(".archive", ".git", "Rproj.user"))

ls_qmd(x = ".", ignore = c(".archive", ".git", "Rproj.user"))

ls_agent_docs(x = ".", ignore = c(".archive", ".git", ".old"))

ls_planning_docs(x = ".", ignore = c(".archive", ".git", "Rproj.user"))

ls_proj_quarto(x = ".", ignore = c(".archive", ".git", "Rproj.user"))

ls_proj_rpkg(x = ".", ignore = c(".archive", ".git", "Rproj.user"))

Arguments

x

Character. Root path to scan. Defaults to ".".

ignore

Character vector of directory names to ignore. Both dotted and undotted forms are supported (e.g. "Rproj.user" and ".Rproj.user").

ext

Character vector of file extensions for ls_docs(), with or without a leading dot.

Value

Character vector of absolute file paths for listing helpers, or absolute directory paths for project marker helpers.

Functions

  • ls_docs(): List files recursively by extension.

  • ls_md(): List markdown files recursively.

  • ls_qmd(): List Quarto markdown files recursively.

  • ls_agent_docs(): List AGENTS and CLAUDE instruction docs.

  • ls_planning_docs(): List planning docs by common planning file-name patterns.

  • ls_proj_quarto(): List directories containing _quarto.yml|yaml.

  • ls_proj_rpkg(): List directories containing DESCRIPTION.

See also

Other dev-utils: describe_env(), dev-helpers, get_repo_index(), list_art_packages(), path_artd()

Examples

ls_docs(ext = c("md", "qmd"))
#> character(0)
ls_docs(ignore = c(".git", ".archive"), ext = "md")
#> character(0)
ls_md()
#> character(0)
ls_qmd()
#> character(0)
ls_agent_docs()
#> character(0)
ls_planning_docs()
#> character(0)
ls_proj_quarto()
#> character(0)
ls_proj_rpkg()
#> character(0)