Git Hooks

Catch validation errors before they reach the repository by running Repotype in git hooks.

Quick Setup

npx repotype install-checks --hook both --target .

This installs both pre-commit and pre-push hooks.

Hook Options

Option	Effect
--hook pre-commit	Validate before each commit
--hook pre-push	Validate before pushing
--hook both	Install both hooks

Tip

pre-commit catches issues early but runs on every commit. pre-push is less frequent but delays feedback. Use both for maximum safety.

Config-Based Installation

Define hooks in your config file:

repotype.yaml

operations:
  hooks:
    enabled: true
    hook: both  # pre-commit | pre-push | both

Then apply:

npx repotype apply .

What the Hooks Do

The installed hooks run:

npx repotype validate . --json

If validation fails, the commit/push is blocked with error output.

Manual Hook Scripts

If you prefer manual control, add to .git/hooks/pre-commit:

#!/bin/sh
npx repotype validate . --json
exit $?

Make it executable:

chmod +x .git/hooks/pre-commit

Integration with Husky

If you use Husky for hook management:

1. Install Husky

   npm install -D husky
   npx husky init

2. Add Repotype to pre-commit

   echo "npx repotype validate ." > .husky/pre-commit

Integration with lint-staged

For faster commits, only validate changed files:

package.json

{
  "lint-staged": {
    "*.{ts,tsx}": [
      "npx repotype explain"
    ],
    "*.md": [
      "npx repotype validate"
    ]
  }
}

Caution

lint-staged validates individual files, not repo structure. Folder rules won’t be checked this way. Consider running full validation on push instead.

Bypassing Hooks (Emergency)

In emergencies, you can skip hooks:

git commit --no-verify -m "emergency fix"
git push --no-verify

Caution

Only use --no-verify for genuine emergencies. CI should still catch any violations.

Disabling Hooks

Remove hooks from config:

repotype.yaml

operations:
  hooks:
    enabled: false

Then reapply:

npx repotype apply .

Or manually remove:

rm .git/hooks/pre-commit .git/hooks/pre-push

Troubleshooting

Hook not running

Check hook is executable:

ls -la .git/hooks/pre-commit
# Should show: -rwxr-xr-x

Hook too slow

Consider:

• Using pre-push instead of pre-commit
• Using lint-staged for file-specific validation
• Caching node_modules

Permission denied

chmod +x .git/hooks/pre-commit
chmod +x .git/hooks/pre-push