git¶

Helpers that delegate listing changed files to git-bot-feedback.

cpp_linter.git.to_gbf_lines_changed_only(lines_changed_only: int | LinesChangedOnly) → LinesChangedOnly[source]¶

Convert an integer lines_changed_only value to git_bot_feedback.LinesChangedOnly.

async cpp_linter.git.get_list_of_changed_files(git_client: GitClient, file_filter: FileFilter, lines_changed_only: int, diff_base: None | int | str = None, ignore_index: bool = False, path_prefix: str = '') → list[FileObj][source]¶

Retrieve changed files delegating to git-bot-feedback.

Parameters:¶

file_filter: FileFilter¶

A git_bot_feedback.FileFilter to filter files.

lines_changed_only: int¶

A value that dictates what file changes to focus on.

diff_base: None | int | str = None¶

The commit or ref to use as the base of the diff.

ignore_index: bool = False¶

Ignore staged files in index.

git_client: GitClient¶

The git_bot_feedback.GitClient to delegate to.

path_prefix: str = ''¶

The path of the repo root inside the git repository (see ~cpp_linter.common_fs.get_repo_root_prefix()).

Returns:¶

A list of FileObj describing the changed files. The file names are relative to the repo root. Changed files outside the repo root are left out.