R/precommit.R

Defines functions init_precommit

Documented in init_precommit

#' Use precommit with that project
#'
#' @template commit
#' @export
init_precommit <- function(commit = TRUE) {
  if (!requireNamespace("precommit", quietly = TRUE)) {
    stop("Please install 'precommit'.")
  }
  if (!requireNamespace("gert", quietly = TRUE)) {
    stop("Please install 'gert'.")
  }

  precommit::use_precommit()

  if (commit == TRUE) {
    gert::git_add(c(".pre-commit-config.yaml", ".Rbuildignore"))
    gert::git_commit("use 'pre-commit' framework")
  }
}
cynkra/cynkrathis documentation built on June 14, 2025, 4:26 p.m.