open-hook 🎣

A CLI tool to manage and install reusable React custom hooks from a centralized repository
Supercharge your React development with community-vetted hooks!

🚀 Quick Start

Installation

npm install -g open-hook
# or 
pnpm add -g open-hook

Basic Usage

# Initialize your project
npx open-hook init

# Browse and add hooks interactively
npx open-hook add

# Or add specific hooks
npx open-hook add useFetch useLocalStorage --language ts

😄 Fun Break

💡 open-hook pro tip:
"Why did the React dev bring a fishing rod to work?"
Because they heard there were custom hooks to catch! 🎣

✨ Features

| Feature | Description | |---------|-------------| | 📦 Hook Management | Install, update, and manage hooks effortlessly | | ⚙️ Configurable | Customize installation directory and language | | 🔄 Conflict Resolution | Smart prompts when hooks exist | | 📜 Manifest Support | Structured hook repository format | | 🌐 GitHub Integration | Directly fetches from raw GitHub URLs | | 💻 CLI Interface | Intuitive command-line experience |

📖 Detailed Usage

init Command

Initialize your project configuration:

npx open-hook init

Creates open-hooks.config.json with:

• Default hooks directory (e.g. src/hooks)
• Preferred language (TypeScript/JavaScript)
• Repository URL

add Command

Install hooks with options:

# Interactive mode
npx open-hook add

# Direct installation
npx open-hook add ClickOutside LocalStorage --language ts

# Custom directory
npx open-hook add useDebounce --dir src/utils/hooks

Conflict Handling:
🔄 Replace existing | ⏭️ Skip hook | ❌ Cancel all

list Command

View available hooks:

npx open-hook list

Displays a formatted table with:

• Hook names
• Available versions (JS/TS)
• Brief descriptions

⚙️ Configuration

Example open-hooks.config.json:

{
  "hooksDir": "src/hooks",
  "defaultLanguage": "ts",
  "repoUrl": "https://github.com/****/OpenHooks"
}

🛠️ Development Roadmap

Planned Features

• 🔗 Custom repository support via --repo flag
• 📦 Automatic dependency installation
• 👀 Hook preview before download
• 🔍 Search functionality for hooks
• 🏷️ Version management for hooks

🤝 Contributing

We welcome contributions! Here's how:

1. Fork the repository
2. Create your feature branch
3. Submit a pull request

Hook Submission Guidelines:

• Include both JS and TS versions
• Add proper TypeScript types
• Include usage examples
• Document dependencies

📜 License

MIT © Rajeshkumar S & Vigneshwar

Enjoying open-hook?
Give us a ⭐ on GitHub and share with your team!