term_git_config: Git config

Description Usage Arguments Examples

View source: R/term_git_config.R

Description

Sets up Git configurations including user name, email, editor, files to ignore, and commit message.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
term_git_config(
  name = "User Name",
  email = "email@email.com",
  editor = "vim",
  ignore = c("*~", ".*.swp", ".DS_Store", ".~lock.*"),
  msg = paste0("Subject line (try to keep under 50 characters)", "\n\n",
    "Multi-line description of commit,", "\n", "feel free to be detailed.", "\n\n",
    "[Ticket: X]"),
  global = TRUE,
  overwrite = FALSE
)

Arguments

name

Character string. Git user.name.

email

Character string. Git user.email.

editor

Character string. Git core.editor.

ignore

Character vector. Patterns of file names and paths to ignore.

msg

Character string. Git commit.template.

global

Logical. If TRUE, uses the --global option. If FALSE, uses the --local option.

overwrite

Logical. Overwrite existing git dot files in $HOME (global = TRUE) or working directory (global = FALSE).

Examples

1
2
3
4
5
6
7
8
## Not run: 
term_git_config(
  name = "User Name",
  email = "email@email.com",
  global = TRUE
)

## End(Not run)

jeksterslabds/jeksterslabRterm documentation built on July 13, 2020, 11:43 p.m.