https://github.com/gazorby/fish-git-emojis
✨ Shortcuts to commit with Gitmoji messages following the Conventional Commits specification
https://github.com/gazorby/fish-git-emojis
conventional-commits emoji fish fish-plugin fish-shell fisher git gitmoji gitmoji-messages semantic-commits
Last synced: 4 months ago
JSON representation
✨ Shortcuts to commit with Gitmoji messages following the Conventional Commits specification
- Host: GitHub
- URL: https://github.com/gazorby/fish-git-emojis
- Owner: gazorby
- License: mit
- Created: 2020-04-01T17:40:14.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-29T16:44:49.000Z (about 1 year ago)
- Last Synced: 2025-06-10T05:41:57.812Z (4 months ago)
- Topics: conventional-commits, emoji, fish, fish-plugin, fish-shell, fisher, git, gitmoji, gitmoji-messages, semantic-commits
- Language: Shell
- Homepage:
- Size: 25.4 KB
- Stars: 5
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
# fish-git-emojis
Shortcuts to commit with Gitmoji messages. Default emojis are inspired from [gitmoji](https://gitmoji.carloscuesta.me/), and messages follow [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) and [Angular commit messages guidelines]([https://link](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines)).
## 🚀 Install
Using [fisher](https://github.com/jorgebucaran/fisher) :
```console
fisher install Gazorby/fish-git-emojis
```
## 🔧 Usage
`command [] [options]`
options :
```console
-k --breaking Add a "!" after the type/scope to indicate a breaking change
-f --footer STRING Add a footer. Can be used multiple times for multiple footers
-b --b-footer STRING Add a breaking change footer. The message will be prepended by "BREAKING CHANGE:". Can be used multiple time for multiple footers
```
| Command | Emoji |
|-------- | ----------- |
| gbuild | 👷 build/chore |
| gci | 💚 Continuous integration |
| gdocs | 📝 Documentation |
| gfix | 🐛 Bugfix |
| gfeat | ✨ New feature |
| gperf | ⚡️ Improve performance |
| gref | ♻️ Code refactoring |
| gstyle | 🎨 Code style |
| gtest | ✅ Test |
### Examples
- `gfeat "my new feat"` => `✨ feat: my new feat"`
- `gdocs "readme" "add badges"` => `📝 doc(readme): "add badge"`
- `gref "parser" "remove json parser" -k -b "Drop support for json parsing"` :
```console
♻️ refactor(parser)!: remove json parser
BREAKING CHANGE : Drop support for json parsing
```
- `gperf "parser" "improve toml parsing" -f "toml parsing is 2x faster"` :
```console
⚡️ perf(parser) improve toml parsing
toml parsing is 2x faster
```
- `gref "drop support for Node 6" -k` => `♻️ refactor!: drop support for Node 6`
## 📝 License
[MIT](https://github.com/Gazorby/fish-git-emojis/blob/master/LICENSE)