docs: tag

Author: maelle

DESCRIPTION

@@ -23,10 +23,11 @@ Imports:
     sys,
     zip (>= 2.1.0)
 Suggests:
-    spelling, 
+    spelling,
     knitr,
     rmarkdown,
-    testthat
+    testthat,
+    roxygen2
 VignetteBuilder: 
     knitr
 Encoding: UTF-8

NAMESPACE

@@ -1,7 +1,10 @@
 # Generated by roxygen2: do not edit by hand
 
+S3method(format,rd_section_gitcommands)
 S3method(print,gert_signature)
 S3method(print,git_repo_ptr)
+S3method(roxygen2,roxy_tag_parse)
+S3method(roxygen2,roxy_tag_rd)
 export(git_add)
 export(git_ahead_behind)
 export(git_archive_zip)

R/branch.R

@@ -28,6 +28,7 @@ git_branch_list <- function(local = NULL, repo = '.') {
 #' @param force ignore conflicts and overwrite modified files
 #' @param orphan if branch does not exist, checkout unborn branch
 #' @useDynLib gert R_git_checkout_branch R_git_checkout_unborn
+#' @git checkout
 git_branch_checkout <- function(
   branch,
   force = FALSE,

R/gert-package.R

@@ -4,3 +4,42 @@
 ## usethis namespace: start
 ## usethis namespace: end
 NULL
+
+.onLoad <- function(libname, pkgname) {
+  register_s3_method(
+    "roxygen2",
+    "roxy_tag_parse",
+    "roxy_tag_git",
+    roxy_tag_parse.roxy_tag_git
+  )
+  register_s3_method(
+    "roxygen2",
+    "roxy_tag_rd",
+    "roxy_tag_git",
+    roxy_tag_rd.roxy_tag_git
+  )
+}
+
+
+register_s3_method <- function(pkg, generic, class, fun = NULL) {
+  stopifnot(is.character(pkg), length(pkg) == 1)
+  stopifnot(is.character(generic), length(generic) == 1)
+  stopifnot(is.character(class), length(class) == 1)
+  if (is.null(fun)) {
+    fun <- get(paste0(generic, ".", class), envir = parent.frame())
+  } else {
+    stopifnot(is.function(fun))
+  }
+
+  if (isNamespaceLoaded(pkg)) {
+    registerS3method(generic, class, fun, envir = asNamespace(pkg))
+  }
+
+  # Always register hook in case package is later unloaded & reloaded
+  setHook(
+    packageEvent(pkg, "onLoad"),
+    function(...) {
+      registerS3method(generic, class, fun, envir = asNamespace(pkg))
+    }
+  )
+}

R/roxygen2.R

@@ -0,0 +1,47 @@
+# nocov start
+
+git_links <- function() {
+  rlang::check_installed("tibble")
+  tibble::tribble(
+    ~command   , ~url                                                          ,
+    "checkout" , "https://libgit2.org/docs/reference/main/checkout/index.html"
+  )
+}
+
+#' @exportS3Method roxygen2 roxy_tag_parse
+roxy_tag_parse.roxy_tag_git <- function(x) {
+  roxygen2::tag_words(x)
+}
+
+#' @exportS3Method roxygen2 roxy_tag_rd
+roxy_tag_rd.roxy_tag_git <- function(x, base_path, env) {
+  roxygen2::rd_section("gitcommands", x$val)
+}
+
+#' @export
+format.rd_section_gitcommands <- function(x, ...) {
+  paste0(
+    "\\section{Related libgit2 documentation}{",
+    present_git_link(x[["value"]]),
+    ".}\n"
+  )
+}
+
+present_git_link <- function(value) {
+  format_git_single_link <- function(x, git_links) {
+    df <- git_links[git_links$command == x, ]
+    if (nrow(df) == 0) {
+      cli::cli_warn("Can't find libgit2 entry for {x}!")
+    }
+    sprintf("\\href{%s}{\\code{%s}}", df$command, df$name)
+  }
+
+  strings <- purrr::map_chr(
+    unique(value),
+    format_git_single_link,
+    git_links = git_links()
+  )
+
+  paste(strings, collapse = ", ")
+}
+# nocov end