https://github.com/love1ace/byulhook
A streamlined tool for effortlessly managing Git hooks with speed and ease. 🐈
https://github.com/love1ace/byulhook
byulhook githook hooks husky lefthook
Last synced: about 1 year ago
JSON representation
A streamlined tool for effortlessly managing Git hooks with speed and ease. 🐈
- Host: GitHub
- URL: https://github.com/love1ace/byulhook
- Owner: love1ace
- License: mit
- Created: 2024-08-24T05:52:17.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-27T12:13:06.000Z (almost 2 years ago)
- Last Synced: 2025-05-04T21:16:03.557Z (about 1 year ago)
- Topics: byulhook, githook, hooks, husky, lefthook
- Language: TypeScript
- Homepage:
- Size: 5.11 MB
- Stars: 13
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# byulhook
**byulhook** is a tool for managing Git hooks.
## Installation
You can install **byulhook** using your preferred package manager:
### npm
```bash
npm install byulhook
```
### Yarn
```bash
yarn add byulhook
```
### pnpm
```bash
pnpm add byulhook
```
### Bun
```bash
bun add byulhook
```
## Setup error
If the `byulhook.yml` file hasn’t been created, run:
```bash
node node_modules/byul-alias/dist/bin/setup.mjs
```
Or, you can manually create the `byulhook.yml` file and add this code:
```yaml
# hook name:
# This is the name of the Git hook, such as 'pre-commit', 'commit-msg', etc.
# commands:
# command name:
# A user-defined name for the command. This can be any descriptive name you choose.
# run: 'command to run'
# The shell command or script that will be executed when the hook is triggered.
#
# Example:
#
# pre-commit:
# commands:
# lint:
# run: 'npm run lint'
```
## Usage
### Define Your Git Hooks
Customize your Git hooks by editing the `byulhook.yml` file. Here’s an example configuration:
```yaml
pre-commit:
commands:
Lint:
run: "npm run lint"
Prettier:
run: "npm run prettier -- --write '**/*.{js,jsx,ts,tsx,css,md}'"
```
This setup will automatically run linting and formatting to ensure code consistency across your project.
### Install and Apply Hooks
Once your hooks are configured, install and apply them effortlessly with:
```bash
npx byulhook install
npx byulhook add
```
ByulHook automatically finds the right directory for your hooks and applies them with no extra effort.
## Why Choose ByulHook?
- **Setup:** ByulHook features a straightforward installation process.
- **Speed:** ByulHook operates at lightning-fast speeds, keeping your development workflow smooth and allowing you to focus on writing important code.
- **Convenience:** ByulHook’s simple design makes managing Git hooks easy, even for beginners.
- **Compatibility:** ByulHook works seamlessly across various environments and Git workflows, integrating effortlessly into your existing setup.
- **Logs:** ByulHook provides easy-to-read logs, making it simple to understand what’s happening and troubleshoot when needed
## Contributing
We welcome contributions to **byulhook**! Whether it's reporting a bug, suggesting an enhancement, or submitting a pull request, your input is valued.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Contact
For any questions, suggestions, or feedback, please contact [love1ace](mailto:lovelacedud@gmail.com).