Function precommit_cmd

ggshield/cmd/secret/scan/precommit.py:58–111

Scan as a pre-commit hook all changes that have been staged in a git repository.

(
    ctx: click.Context,
    scan_all_merge_files: bool,
    precommit_args: List[str],
    **kwargs: Any,
)

@exception_wrapper
@non_blocking_on_server_error
def precommit_cmd(
    ctx: click.Context,
    scan_all_merge_files: bool,
    precommit_args: List[str],
    **kwargs: Any,
) -> int:  # pragma: no cover
    """
    Scan as a pre-commit hook all changes that have been staged in a git repository.
    """
    ctx_obj = ContextObj.get(ctx)
    ctx_obj.client = create_client_from_config(ctx_obj.config)
    config = ctx_obj.config

    if check_user_requested_skip():
        return 0

    output_handler = SecretTextOutputHandler(
        verbose=ui.is_verbose(),
        client=ctx_obj.client,
        output=None,
        secret_config=config.user_config.secret,
    )
    check_git_dir()

    scan_context = ScanContext(
        scan_mode=ScanMode.PRE_COMMIT,
        command_path=ctx.command_path,
        target_path=Path.cwd(),
    )

    # Get the commit object
    if not scan_all_merge_files and check_is_merge_with_conflict(Path.cwd()):
        commit = Commit.from_merge(ctx_obj.exclusion_regexes)
    elif not scan_all_merge_files and check_is_merge_without_conflict():
        merge_branch = get_merge_branch_from_reflog()
        commit = Commit.from_merge(ctx_obj.exclusion_regexes, merge_branch)
    else:
        commit = Commit.from_staged(ctx_obj.exclusion_regexes)

    scanner = SecretScanner(
        client=ctx_obj.client,
        cache=ctx_obj.cache,
        scan_context=scan_context,
        secret_config=config.user_config.secret,
    )
    with create_scanner_ui(len(commit.urls)) as scanner_ui:
        results = scanner.scan(commit.get_files(), scanner_ui)

    return_code = output_handler.process_scan(
        SecretScanCollection(id="cached", type="pre-commit", results=results)
    )
    if return_code:
        ui.display_info(ctx_obj.client.remediation_messages.pre_commit)
    return return_code