Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cheap-glitch/git-grapnel
🪝 A collection of useful git hooks written in Bash.
https://github.com/cheap-glitch/git-grapnel
bash-script bash-scripting git-automation git-hooks hooks shell-script
Last synced: about 1 month ago
JSON representation
🪝 A collection of useful git hooks written in Bash.
- Host: GitHub
- URL: https://github.com/cheap-glitch/git-grapnel
- Owner: cheap-glitch
- License: isc
- Created: 2020-09-27T15:28:57.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-04-09T09:49:09.000Z (over 2 years ago)
- Last Synced: 2024-10-02T04:01:30.744Z (about 2 months ago)
- Topics: bash-script, bash-scripting, git-automation, git-hooks, hooks, shell-script
- Language: Shell
- Homepage:
- Size: 394 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](LICENSE)
[](https://github.com/cheap-glitch/git-grapnel/releases/latest)
This is a collection of custom [git hooks](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks).
## Features
* Automatically lint any modified files before committing
* Smart spellchecking of commit messages
* Can enforce the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0) specification
* …and more!
> Note: even thought these scripts can be configured to a certain degree, they
> can't possibly cover all existing use cases, and thus are meant more as
> blueprints and sources of inspiration rather than comprehensive solutions.
## Installation
Clone the repo or download the scripts from [the latest release](https://github.com/cheap-glitch/git-grapnel/releases/latest),
and make sure they're executable (`chmod +x `).
### For a single git repo
Place the scripts in a folder named `hooks` inside the `.git` directory of that
repo.
### For every git repo on a machine
Ensure the scripts are in your `PATH` so that `git` can execute them.
Then point the `core.hooksPath` config option to the folder containing the
scripts, e.g. if they're stored in `~/.git-grapnel`:
```
git config core.hooksPath ~/.git-grapnel
```
### External dependencies
Some of the scripts use external tools to accomplish their tasks, so make sure
you install them too:
* [jq](https://stedolan.github.io/jq) to parse JSON data
* [aspell](http://aspell.net) to spellcheck commit messages
## Usage
Each of the hooks can be bypassed by calling its git command with the
`--no-verify` option.
All the features are disabled by default, and each on can be enabled and
configured by setting some environment variables (`GIT_GRAPNEL_*`).
### [pre-commit](https://github.com/cheap-glitch/git-grapnel/blob/main/src/pre-commit)
This hook is run whenever committing to a repo.
Setting `GIT_GRAPNEL_LINT_ON_COMMIT` to `1` will enable the automatic linting of
modified source files. The commit will be cancelled if any errors or warnings
are produced.
### [commit-msg](https://github.com/cheap-glitch/git-grapnel/blob/main/src/commit-msg)
This hook is run whenever committing to a repo.
Setting `GIT_GRAPNEL_COMMIT_MSG_FORMAT` to one of the following values will
enforce that particular format for commit message:
* `basic`: the message must start with a capital letter and not end with a full stop
* `conventional-commits`: the message must conform to the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0) specification
It can also:
* spellcheck the commit message and highlight possible typos (`GIT_GRAPNEL_SPELLCHECK`)
* convert pairs of single quotes (`''`) into a single back quote — useful when you
surround the message in double quotes on the command line (`GIT_GRAPNEL_CONVERT_SINGLE_QUOTE_PAIRS`)
* automatically add a corresponding emoji at the start of Conventional Commits messages (`GIT_GRAPNEL_ADD_EMOJIS`)
### [pre-push](https://github.com/cheap-glitch/git-grapnel/blob/main/src/pre-push)
This hook is run whenever pushing to a remote.
Setting `GIT_GRAPNEL_PRE_PUSH_CHECKS` to `1` will automatically lint the
codebase and run the testing scripts present in `package.json`, and abort the
push if any of them fail.
### [post-merge](https://github.com/cheap-glitch/git-grapnel/blob/main/src/post-merge)
This hook is run after a successful merge.
Setting `GIT_GRAPNEL_AUTO_INSTALL` to `1` will reinstall the Node modules as
needed to keep them in sync with `package-lock.json`.
## Contributing
Contributions are welcomed! Please open an issue before submitting substantial changes.
## Related
* [The official documentation on Git hooks](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks)
* [`git-toolbelt`](https://github.com/nvie/git-toolbelt) – A collection of convenient utilities for everyday git usage
## License
ISC