README.md

pre-commit-hooks

A collection of custom Git pre-commit hooks for the OpenSemanticLab / -World packages.

Some out-of-the-box hooks for pre-commit.

See also: https://github.com/pre-commit/pre-commit

Using pre-commit-hooks with pre-commit

Add this to your .pre-commit-config.yaml

-   repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.4.0  # Use the ref you want to point at
    hooks:
    -   id: trailing-whitespace
    # -   id: ...

or in case of the test hook created within this package:

-   repo: https://github.com/OpenSemanticLab/pre-commit-hooks
    rev: v0.1.25  # Use the ref you want to point at
    hooks:
    - id: print-arguments

Hooks available

print-arguments

Prints the arguments passed to the hook. Source: https://dev.to/jalvaradosegura/create-your-own-pre-commit-hook-3kh

update-submodules

Transfers the state of the submodules tracked in the remote parent repository to the local repository, updating them. Source: https://stackoverflow.com/a/5828396/1497139

merge-remote-submodule-updates

Updates the submodules of the repository by updating the state of the submodule tracked in the local parent repository to match the most recent commit in the remote submodule repository.

Note

This project has been set up using PyScaffold 4.4. For details and usage information on PyScaffold see https://pyscaffold.org/.