githooked

Manage git hooks across your project with cross-platform support and mobility. Comfortably integrates with git to allow custom scripting. Designed for Bash 4.0 or compatible. Compatible with Git SCM (Git for Windows).

Scope	Beta
Primary Sequence	Tool
Secondary Sequence(s)	DevOps

Installation and Help

githooked can be downloaded with the following command that leverages the GitHub API. This command requires curl and wget to be installed.

            curl -s https://api.github.com/repos/xCykrix/githooked/releases/latest \
            | grep "browser_download_url.*" \
            | cut -d : -f 2,3 \
            | tr -d \" \
            | wget -qi -
        

Alternatively, you can download the latest release of githooked and install it directly to your project path.

Usage (man page) of ./githooked

            $ ./githooked --help
            githooked - Minimal application used to uniformly enforce and distribute git-hooks for development.

            Usage:
            githooked [OPTIONS] COMMAND
            githooked [COMMAND] --help | -h
            githooked --version | -v

            Commands:
            install Install githooked runtime on the current path. Requires './.git/' to be present.
            generate Generate default githooked 'no-op' placeholder hooks.

            Options:
            --trace, -t
            Print additional information and details.

            --help, -h
            Show this help

            --version, -v
            Show version number

            Examples:
            githooked --help
            githooked install --help
            githooked generate --help
            githooked generate prepare-commit-msg pre-commit pre-push
            githooked upgrade
        

Getting Started

Installing githooked to a Project.

                $ ./githooked install
                $ ./githooked generate prepare-commit-msg pre-commit pre-push
            

Locate ./.git-hooks/ and open one of the generated files.
Scroll to Line 14 (by default). Generated scripts will be a "no operation" and can be configured to run additional commands and scripts.

Example: Simple Conventional Commit (prepare-commit)

            #!/usr/bin/env bash

            # Configure the hook with these options.
            HOOK_DEBUG=0 # Set to 1 to enable debug mode. This will print additional output.
            HOOK_DISABLE_NOTICE=0 # Set to 1 to disable the notice when the hook exits with an error code.

            # Import the git-hooked wrapper to prepare the env and execute the script below.
            . "$(dirname "$0")/_util/git-hooked.sh"

            # Your script begins here.
            # The last command to run, or explicit "exit" commands, will determine the status code to Git.

            # From: https://dev.to/craicoverflow/enforcing-conventional-commits-using-git-hooks-1o5p
            # Build the Regular Expression Options.
            types="build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test"
            scope_minlen=1
            scope_maxlen=16
            scope_regexp="[a-z0-9_.-]{${scope_minlen},${scope_maxlen}}"
            subject_minlen=4
            subject_maxlen=120
            subject_regexp="[a-z0-9_. -]{${subject_minlen},${subject_maxlen}}"

            # Build the Regular Expression String.
            regexp="^(revert: )?(${types})(\(${scope_regexp}\))?!?: ${subject_regexp}[^A-Z.,?]{1,}$"

            # Validate the commit message.
            if [[ ! "$(head -1 $1)" =~ ${regexp} ]]; then
            # Print the hook error message.
            echo
            echo "The commit message was not formatted correctly. Rejecting the commit request."
            echo " - https://www.conventionalcommits.org/en/v1.0.0/"
            echo " - https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional"
            echo
            echo " Having trouble with the format? Just not sure of how to commit correctly? https://commitlint.io/"
            echo " Something weird happening? Use https://regexr.com/ with the following expression to validate your
            commit."
            echo " - Expression: /${regexp}/"
            echo
            exit 1
            fi

            # Print the hook success message.
            echo "Validated 'prepare-commit-msg' hook."
            exit 0
        

Last modified: 04 February 2024