R/01-repo-names.R

In matt-dray/ghdump: Clone Or Download All Repos For A GitHub User

# Purpose: fetch GitHub repo information and extract repo names

#' Get GitHub Repo Information for a Named User
#'
#' Uses \code{\link[gh]{gh}} to access the GitHub API and get the details for
#' all of a named user's repos. To use this function you need to have created a
#' GitHub account and to have put a GitHub Personal Access Token (PAT) in your
#' .Renviron. See
#' \href{https://happygitwithr.com/github-pat.html}{Happy Git and GitHub for the UseR}
#' for more information.
#'
#' @param gh_user Character string. A GitHub username.
#'
#' @return A gh_response (list) object.
ghd_get_repos <- function(gh_user) {

  cli::cli_alert_info("Fetching GitHub repos for user '{gh_user}'. ")

  # Get repos for username
  user_repos <-
    gh::gh(
      endpoint = "/users/:username/repos",
      username = gh_user,
      .limit = Inf  # get all repos
    )

  cli::cli_alert_success("Found {length(user_repos)} repos.")

  return(user_repos)

}

#' Extract Names of GitHub Repos
#'
#' Extract all the 'name' elements from a gh_response object. These are the
#' names of all the GitHub repos.
#'
#' @param repo_object A gh_response object, as returned by
#'     \code{\link{ghd_get_repos}}.
#'
#' @return A character vector of GitHub repo names.
ghd_extract_names <- function(repo_object) {

  repo_names <-
    purrr::map(
      .x = repo_object,
      .f = purrr::pluck("name")
    )

  repo_names_vec <- unlist(repo_names)

  return(repo_names_vec)

}