Skip to content

Memnoc/gig

Repository files navigation

GIG - GitIgnore Generator 🚀

License npm npm GitHub issues

🤔 Why GIG?

Ever found yourself copy-pasting .gitignore files from random places on the internet? Or, when you work with build tools, there is always that one thing you wanted to add? 💀

Well, I did, so I have built GIG:

  • 🚫 No More Copy-Pasting: Stop searching and copying from multiple sources
  • 🎯 Language-Specific: Pre-configured templates for major programming languages and frameworks
  • Instant Setup: Set up proper Git ignores in seconds, not minutes
  • 🔍 Interactive Selection: Beautiful CLI interface to choose the right template
  • 🛠️ Best Practices: Templates curated following community standards and best practices
  • 💻 IDE Agnostic: Works with any development environment or Git workflow

Whether you're starting your next big project or just need a quick .gitignore fix, GIG's got your back! No more headaches, just clean Git histories. 🥲

👀 Features

Selection Execution

✨ Features

  • 🎯 Interactive template selection with beautiful UI
  • 📦 Multiple language templates (Node.js, Python, TypeScript, Go, Ruby...)
  • ⚡ Lightning fast and lightweight
  • 🎨 Beautiful terminal output with colors and icons
  • 🔧 Easy to use with simple commands
  • 🛠️ Built with TypeScript for type safety

🚀 Installation

# with Node
npm install -g gig-ignite
# run without installing
npx gig-ignite

🎮 Usage

# Interactive mode
gig list
# or shorter
gig l

# Generate directly
gig generate --template node
# or shorter
gig g --template node

📦 Development

Clone repository
git clone https://github.com/memnoc/gig-ignite.git

# Install dependencies
npm install

# Build
npm run build

# Link locally
npm link

# Run tests
npm test

🎯 Supported Templates

  • Node.js
  • Python
  • TypeScript
  • Go
  • Ruby
  • Rust

More coming soon!

🛠️ Tech Stack

TypeScript Node.js npm

🤝 Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

📝 License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details.

🙏 Acknowledgments

Clipanion Clack Better CLI Alerts

Special thanks to:

🎈 Upcoming Features

  • Support for custom templates
  • Multiple template selection
  • Template preview
  • Force override option
  • Template updates via CLI

🐛 Bug Reports

Found a bug? Please create an issue here.

Made with ❤️ by Memnoc

About

A CLI utility to generate well crafted gitignore files for different languages and tech-stacks

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published