https://github.com/vieitesss/gitcomic
It allows you to insert an icon depending on the type of updates you have made in your code.
https://github.com/vieitesss/gitcomic
Last synced: 5 months ago
JSON representation
It allows you to insert an icon depending on the type of updates you have made in your code.
- Host: GitHub
- URL: https://github.com/vieitesss/gitcomic
- Owner: vieitesss
- License: mit
- Created: 2023-10-17T11:58:02.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-26T23:41:13.000Z (over 1 year ago)
- Last Synced: 2025-01-09T11:50:36.516Z (5 months ago)
- Language: Python
- Homepage:
- Size: 12.9 MB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitComic 💥
https://github.com/vieitesss/GitComic/assets/60654781/25b82cd2-2636-4c12-a830-c0f59ee75d62
This script allows you to insert an icon depending on the type of updates you have made in your code.
If you want to start organizing your commits better and make them visually appealing, you're in the right place. I present you GitComic (Git Commit Icons).
## Why
After a month of trying out VSCode and getting a configuration I'm comfortable with, I've decided to go back to Nvim. 🙃
However, during my time with VSCode, I came across a specific plugin 🔌 that I loved and, after returning to the terminal, I missed it. It's a very simple plugin, but at the same time, I find it very useful, and it adds a different touch 🤩 to your Git repositories.
## Functionality
The plugin allows you to include an icon 😃 in your Git commits that visually describes the changes you've made in your repository, in addition to the comment 📝 you want to add.
For example:
Imagine you've just made changes to your .gitignore file.
``` shell
git commit -m "🙈 Added a file to ignore"
```
Or you're starting a project.
``` shell
git commit -m "🎉 Let's go for it"
```
Perhaps you've just come back from a party and feel like doing some programming.
``` shell
git commit -m "🍺 Not my best night"
```
Or, finally, you manage to pass those darn tests.
``` shell
git commit -m "✅ I'm done"
```
Those emojis aren't chosen randomly, each of them represents the essence of the changes made in that commit.
Here's a list of some more icons you can find.
🚀 Deploy stuff
🚧 Work in progress
💄 Add or update the UI and style files
🌱 Add or update seed files
🚩 Add update or remove feature flags
🥅 Catch errors
💫 Add or update animations and transitions
🔐 Add or update secrets
🔖 Release/Version tags
⬇️ Downgrade dependencies
⬆️ Upgrade dependencies
📈 Add or update analytics or track code
♻️ Refactor code
... and so on, with over 70 icons at your disposal.
## Getting started
### Dependencies
First of all, you'll need to install the dependencies.
The script is intended to be used with tmux, so if you're not familiar with it or are hesitant to use it, here's a video that explains how to get started. You can also check out my own tmux configuration here.
The second and final dependency is fzf, a widely known command that allows you to select one or multiple options from various entries using advanced regular expressions.
Just follow the guides in the provided links to install both commands.
### Installation
Once you have the dependencies installed, here comes the best part.
1. Clone this repository.
```shell
git clone https://github.com/vieitesss/GitComic.git
```
2. Execute the following commands.
```shell
sudo cp -r Gitcomic/gitcomic /usr/local/opt/
sudo ln -s /usr/local/opt/gitcomic/gitcomic.sh /usr/local/bin/gitcomic
```
3. Delete the repository.
```shell
rm -rf GitComic
```
4. Create a key-binding in your tmux config. You can bind any key you want.
```bash
# g
bind-key g run-shell "gitcomic"
# C-g (without prefix)
bind-key -n C-g run-shell "gitcomic"
```
5. Start coding and bring your commits to life.
🎨 🗃️ ⚡️ 🔨 📍 💡 💸
## Contributing
You can contact me through my social media 🕸️, sending me an email 📤, or directly make a pull request. ⁉️
If you feel that there's a missing icon for a specific description, don't hesitate to mention it. 🔫
I appreciate any kind of advice. 🙏
Press the star button if you liked it. ⭐️