is_workdir_clean: Check if the current working directory of a repo is clean

In inbo/checklist: A Thorough and Strict Set of Checks for R Packages and Source Code

Check if the current working directory of a repo is clean

Description

A clean working directory has no staged, unstaged or untracked files.

Usage

is_workdir_clean(repo)

Arguments

repo

The path to the git repository. If the directory is not a repository, parent directories are considered (see git_find). To disable this search, provide the filepath protected with I(). When using this parameter, always explicitly call by name (i.e. ⁠repo = ⁠) because future versions of gert may have additional parameters.

Value

TRUE when there are no staged, unstaged or untracked files. Otherwise FALSE

See Also

Other git: clean_git(), create_draft_pr(), is_repository(), new_branch(), set_tag()

inbo/checklist documentation built on June 15, 2025, 12:54 p.m.