bun-git-hooksModern Git Hooks Management

Quick Start ​

# Install the package
bun add -D bun-git-hooks

# Create a configuration file
cat > git-hooks.config.ts << EOL
import type { GitHooksConfig } from 'bun-git-hooks'

const config: GitHooksConfig = {
  // Note: staged-lint is only available in pre-commit hook
  'pre-commit': {
    'staged-lint': {
      '*.{js,ts}': 'bunx --bun eslint . --fix --max-warnings=0'
    }
  },
  'commit-msg': 'bun commitlint --edit $1',
  'pre-push': 'bun run build',
}

export default config
EOL

# Hooks are automatically installed!

Why bun-git-hooks? ​

• 🎯 Simple Yet Powerful: Easy to set up, but packed with features
• 🔄 Team Friendly: Automatically install hooks for all team members
• 🛡️ Type Safe: Full TypeScript support with great IDE integration
• 📦 Zero Dependencies: Minimal footprint in your project
• ⚡ Fast: Built for Bun with performance in mind
• 🔧 Flexible: Multiple configuration formats and options
• 🚫 Restricted Features: Clear boundaries for features like staged-lint (pre-commit only)

Configuration Options ​

Supported Config Files ​

• git-hooks.config.ts (TypeScript)
• git-hooks.config.js (JavaScript)
• git-hooks.config.cjs (CommonJS)
• git-hooks.config.json (JSON)
• package.json (with gitHooks field)

Environment Variables ​

• SKIP_BUN_GIT_HOOKS: Set to "1" to skip hook execution
• BUN_GIT_HOOKS_RC: Path to initialization script
• SKIP_INSTALL_GIT_HOOKS: Set to "1" to skip hook installation

Popular Use Cases ​

const config: GitHooksConfig = {
  // Lint and test before commits (using staged-lint)
  'pre-commit': {
    'staged-lint': {
      '*.{js,ts}': 'bunx --bun eslint . --fix --max-warnings=0',
      '*.{css,scss}': 'stylelint --fix'
    }
  },

  // Validate commit messages
  'commit-msg': 'bun commitlint --edit $1',

  // Build and test before pushing
  'pre-push': 'bun run build && bun run test:e2e',

  // Update dependencies after checkout
  'post-checkout': 'bun install',

  // Run security checks before push
  'pre-push': 'bun run security:check'
}

Advanced Features ​

Custom Initialization Scripts ​

Create a .git-hooks.rc file to set up environment variables or perform custom initialization:

#!/bin/bash
export NODE_ENV=development
export CUSTOM_VAR=value

Skip Hooks Temporarily ​

# Skip hooks for a single command
SKIP_BUN_GIT_HOOKS=1 git commit -m "message"

# Skip hook installation
SKIP_INSTALL_GIT_HOOKS=1 bun install

Community ​

Join our community to get help, share ideas, and contribute:

• 📖 Documentation
• 💬 Discord Chat
• 🐙 GitHub Discussions
• 🐦 Twitter Updates

Support ​

If you find this project useful, please consider:

• ⭐ Starring the repository
• 🤝 Contributing
• 💙 Becoming a sponsor

License ​

MIT License © 2024-present Stacks.js

Meet The Team

Chris Breuer

Open sourceror.
Core Stacks team.
Working at Stacks.js

Glenn

Open sourceror.
Core Stacks team.
Working at Stacks.js

Mike

Open sourceror.
Core Stacks team.
Working at Stacks.js

Zoltan

Open sourceror.
Core Stacks team.

Stacks Sponsors

Click here to become a sponsor.

Contributors