Package 'captain'

Handle .pre-commit-config file

Description

Handle .pre-commit-config file for running pre-commit hooks

Usage

create_precommit_config(filename = path_precommit_files()[1], force = FALSE)

edit_precommit_config()

Arguments

filename	the name of the file to create
force	overwrite the file if it already exists

Details

create_precommit_config() will create a .pre-commit-config file in the current project. Only one file is allowed in the project and should be in the root directory or in the inst directory such as:

• inst/pre-commit/.pre-commit-config.yml

• inst/pre-commit/.pre-commit-config.yaml

Value

cli messages related to the creation and edition of the .pre-commit-config file.

---

Create pre-commit hooks

Description

Add pre-commit hooks to .pre-commit-config.y*ml file

Usage

create_precommit_hook(
  filename,
  id,
  name,
  description,
  language = "system",
  always_run = TRUE
)

Arguments

filename	The name of script file
id	The unique identifier for the hook
name	A descriptive name for the hook
description	A brief description of what the hook does
language	The programming language or environment for the hook (default is "system")
always_run	Logical, whether the hook should always run (default is TRUE)

Value

cli messages related to the creation of the hook and updating the config file. Create ⁠inst/pre-commit/hooks/{filename}.R⁠ script and update .pre-commit-config.y*ml file.

---

Install pre-commit

Description

Install pre-commit file in the repo.

Usage

install_precommit(force = FALSE, ...)

Arguments

force	overwrite the file if it already exists
...	additional arguments to pass to create_precommit_config()

Value

cli messages related to the installation of pre-commit files. Create inst/pre-commit folder and .git/hooks/pre-commit file.

---

Run precommit

Description

Run pre-commit hooks

Usage

run_precommit(path = ".git/hooks/pre-commit")

Arguments

path	path of the pre-commit file

Value

cli message related to the run of all git precommit hooks.

---

Toggle pre-commit hooks

Description

Enable or disable individual hooks in the .pre-commit-config.y*ml file.

Usage

toggle_precommit_hook(...)

Arguments

...	One or more named lists, each with fields: id Character. The hook ID to toggle. enable Logical. TRUE to enable the hook, FALSE to disable it. Defaults to TRUE.

Details

Disabling a hook sets ⁠stages: [manual]⁠ on the hook entry, which tells pre-commit to skip it during normal git commits. The hook can then only be triggered explicitly with ⁠pre-commit run --hook-stage manual⁠. Enabling a hook removes the stages field, restoring default behaviour.

Value

cli messages describing the result. When disabled, the hook's stages field is set to ⁠[manual]⁠ so it is skipped during normal git runs. When enabled, the stages restriction is removed.

Examples

## Not run: 
toggle_precommit_hook(
  list(id = "lintr", enable = FALSE),
  list(id = "styler", enable = TRUE)
)

## End(Not run)

---