remote_hooks 1.0.1

A CLI tool to share & install git hooks from remote repository

Getting Started

Add remote_hooks to your project's dev_dependencies:

dart pub add dev:remote_hooks

copied to clipboard

Then, interact with it inside your project using:

dart run remote_hooks -h

copied to clipboard

Alternatively, install it globally:

dart pub global activate remote_hooks

copied to clipboard

Once installed globally, you can use it anywhere:

remote_hooks -h

copied to clipboard

Features

Store Git hooks in a shared repository to ensure consistency and reusability across team members and multiple projects.

Usage

Hooks installation

Usage: remote_hooks install [arguments]
-h, --help    Print this usage information.
-u, --url     Url to the remote repository
-r, --ref     Repository ref to checkout

copied to clipboard

For example, you can use this command to install hooks from a remote repository.

remote_hooks install -u [e-mail]:SilentCatD/where-you-store-hooks.git

copied to clipboard

Specify ref with -r to switch branches or check out a specific commit. This helps with using different hooks for different projects.

Hooks uninstall hooks

To uninstall, use:

remote_hooks uninstall

copied to clipboard

Configuration

You can also store the url and ref information in a config file. At the root of your repository, create a remotehooks.yaml file. Inside, you can specify these two keys:

git-url: [e-mail]:SilentCatD/where-you-store-hooks.git
ref: develop

copied to clipboard

Hooks repository structure (Remote repository)

Contents of the remote hooks repository will be copied to .git/hooks. In the remote repository, you can add a .hooksignore file to exclude specific files and folders from being copied.

Patterns defined inside .hooksignore and .gitignore will be merged to create a final exclusion list.

The file extension of files at the root level is not important, as they will be omitted when copying.

Example of a repository structure for pre-commit and pre-push hooks written in Python:

├── .gitignore
├── .hooksignore
├── hooks_utils
│ ├── formatter_utils.py
│ └── printer_utils.py
├── pre-commit.py
└── pre-push.py

copied to clipboard

Additional information

For additional command details, use remote_hooks -h

remote_hooks <command> -h

copied to clipboard