path_precommit_exec: Locate the pre-commit executable

In precommit: Pre-Commit Hooks

Locate the pre-commit executable

Description

path_precommit_exec() simply reads the R option precommit.executable, path_pre_commit_exec() is the old spelling and deprecated.

Usage

path_precommit_exec(check_if_exists = TRUE)

path_pre_commit_exec(check_if_exists = TRUE)

Arguments

check_if_exists

Whether or not to make sure the returned path also exists.

Value

A character vector of length one with the path to the pre-commit executable.

See Also

path_derive_precommit_exec() for the heuristic to derive it from scratch.

Examples

## Not run: 
path_precommit_exec()

## End(Not run)
## Not run: 
path_pre_commit_exec()

## End(Not run)

precommit documentation built on Sept. 11, 2024, 7:07 p.m.