This repository contains shared repository Git hooks for shell scripts in
githooks/*
to be used with the
Githooks Manager.
The following hooks are included:
- Hook to format configuration files
.yaml, .toml, .json
files withprettier
(pre-commit).
Table of Content (click to expand)
Run them
containerized
where only docker
is required.
If you want to run them non-containerized, make the following installed on your system:
prettier
(optionalprettierd
prettier-plugin-toml
https://github.com/bd82/toml-tools/tree/master/packages/prettier-plugin-toml)bash
- GNU
grep
- GNU
sed
- GNU
find
- GNU
xargs
- GNU
parallel
[optional]
This works with Windows setups too.
The hooks can be used by simply using this repository as a shared hook repository inside shell projects. See further documentation.
You should configure the shared hook repository in your project to use this
repos main
branch by using the following .githooks/.shared.yaml
:
version: 1
urls:
- https://github.com/gabyx/githooks-configs.git@main`.
Formatting with prettier
.
The following scripts are provided:
format-configs-all.sh
: Script to format all doc files in a directory recursively. See documentation.
shellHooks=$(git hooks shared root ns:githooks-docs)
"$shellHooks/githooks/scripts/<script-name>.sh"
The containerized tests in tests/*
are executed by
tests/test.sh
or only special tests steps by
tests/test.sh --seq 001..010
For showing the output also in case of success use:
tests/test.sh --show-output [other-args]