gitign 0.16

A powerful and user-friendly Python script to generate `.gitignore` files with default entries, custom patterns, or templates from gitignore.io

🚀 GitIgnore Generator

A powerful and user-friendly Python script to generate .gitignore files with default entries, custom patterns, or templates from gitignore.io. Features rich console output and smart duplicate detection.

✨ Features

• 🎯 Smart Generation: Create .gitignore files with sensible defaults
• 🔄 Template Support: Fetch templates from gitignore.io for popular frameworks
• 🛡️ Duplicate Prevention: Automatically detects and prevents duplicate entries
• 🧹 Cleanup Tool: Remove duplicates from existing .gitignore files
• 📖 Syntax Highlighting: Beautiful syntax-highlighted file reading
• 🎨 Rich Console Output: Colorful and informative terminal interface
• ⚡ Auto-Append Mode: Intelligently appends to existing files
• 💾 Backup Support: Creates backups when cleaning files

📋 Requirements

• Python 3.6+
• Rich library (pip install rich)

🔧 Installation

1. Clone or download the script:

git clone https://github.com/cumulus13/gitignore.git
cd gitignore

2. Install dependencies:

pip install rich

3. Make the script executable (optional):

chmod +x gitignore.py

🚀 Quick Start

Basic Usage

# Generate .gitignore with default entries
python gitignore.py

# Add custom entries (auto-appends if file exists)
python gitignore.py "*.log" "temp/" "config.local"

# Use templates from gitignore.io
python gitignore.py -t python node react

# Read existing .gitignore with syntax highlighting
python gitignore.py -r

📖 Usage Examples

🎯 Creating New .gitignore Files

# Basic generation with defaults
python gitignore.py

# Generate with custom entries
python gitignore.py "*.tmp" "debug.log" "*.cache"

# Generate with templates
python gitignore.py -t python django

# Generate without default entries
python gitignore.py --no-defaults -t python

# Force overwrite existing file
python gitignore.py -f "*.backup"

📝 Adding to Existing Files

# Auto-append mode (detects existing file)
python gitignore.py "new_pattern" "*.local"

# Explicit append mode
python gitignore.py -a "build/" "dist/"

# Add multiple entries with different separators
python gitignore.py "file1,file2;file3|file4"

🧹 Cleaning Duplicates

# Preview duplicates without changes
python gitignore.py --clean --preview

# Remove duplicates (creates backup by default)
python gitignore.py --clean

# Remove duplicates without backup
python gitignore.py --clean --no-backup

# Clean file in specific directory
python gitignore.py --clean -p /path/to/project

📖 Reading Files

# Read .gitignore with syntax highlighting
python gitignore.py -r

# Read from specific directory
python gitignore.py -r -p /path/to/project

⚙️ Command Line Options

Main Options

Option	Short	Description
--path	-p	Target directory path (default: current directory)
--data	-d	Additional entries (can be repeated)
--template	-t	Templates from gitignore.io
--append	-a	Append to existing file without overwrite
--force	-f	Skip confirmation prompt
--no-defaults		Don't include default entries
--read	-r	Read and display .gitignore content
--version	-v	Show version information

Cleaning Options

Option	Description
--clean	Clean duplicate entries
--preview	Preview changes without applying
--no-backup	Don't create backup file

🎨 Default Entries

The script includes these default entries by default:

*.pyc
*.bak
*.zip
*.rar
*.7z
*.mp3
*.wav
*.sublime-workspace
.hg/
build/
*.hgignore
*.hgtags
*dist/
*.egg-info/
traceback.log
__pycache__/
*.log

🌟 Advanced Features

📝 Multiple Entry Formats

The script supports various entry formats:

# Comma-separated
python gitignore.py "file1,file2,file3"

# Space-separated (use quotes)
python gitignore.py "file1 file2 file3"

# Semicolon-separated
python gitignore.py "file1;file2;file3"

# Array-like format
python gitignore.py "[file1,file2,file3]"

# Quoted entries
python gitignore.py '"special file.txt"' "'another file.log'"

🔄 Template Examples

Popular templates available from gitignore.io:

# Programming languages
python gitignore.py -t python
python gitignore.py -t node javascript
python gitignore.py -t java maven
python gitignore.py -t csharp dotnetcore

# Frameworks
python gitignore.py -t react vue angular
python gitignore.py -t django flask
python gitignore.py -t rails laravel

# IDEs and editors
python gitignore.py -t vscode visualstudio
python gitignore.py -t intellij pycharm
python gitignore.py -t sublime vim

# Operating systems
python gitignore.py -t windows macos linux

# Combined templates
python gitignore.py -t python django vscode

🛡️ Smart Duplicate Detection

The script automatically:

• ✅ Reads existing .gitignore entries
• ✅ Prevents adding duplicate patterns
• ✅ Preserves comments and formatting
• ✅ Shows informative messages about skipped duplicates

🔧 Configuration

Environment Variables

• TRACEBACK=1: Enable detailed error tracebacks

🎯 Use Cases

For New Projects

# Python project
python gitignore.py -t python

# Node.js project
python gitignore.py -t node

# Full-stack project
python gitignore.py -t python node react vscode

For Existing Projects

# Add build artifacts
python gitignore.py "build/" "dist/" "*.map"

# Add IDE files
python gitignore.py ".vscode/" ".idea/" "*.swp"

# Add OS-specific files
python gitignore.py -t macos windows linux

Maintenance Tasks

# Clean up duplicated .gitignore
python gitignore.py --clean

# Preview what would be cleaned
python gitignore.py --clean --preview

# Backup and clean
python gitignore.py --clean  # Creates .gitignore.bak automatically

🐛 Troubleshooting

Common Issues

Unicode characters not displaying properly

• Ensure your terminal supports UTF-8 encoding
• On Windows, try using Windows Terminal or enable UTF-8 support

Permission errors

• Make sure you have write permissions in the target directory
• Run with appropriate privileges if needed

Template fetch failures

• Check your internet connection
• Verify template names are correct (see gitignore.io)

Debug Mode

Enable detailed tracebacks:

export TRACEBACK=1  # Linux/Mac
set TRACEBACK=1     # Windows
python gitignore.py [options]

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

Development Setup

git clone https://github.com/cumulus13/gitignore.git
cd gitignore
pip install rich

📄 License

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

🙏 Acknowledgments

• gitignore.io for providing the template API
• Rich for beautiful terminal output
• The Python community for inspiration and support

📞 Support

• 🐛 Bug Reports: GitHub Issues
• 💡 Feature Requests: GitHub Issues
• 📧 Email: [e-mail]

---

Author

Made with ❤️ by Hadi Cahyadi

⭐ Star this repo if you find it helpful! ⭐

License

MIT License. See LICENSE.

Coffee

Support me on Patreon

Medium