Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/capdiem/psgitutils
Provides emoji supports for Git commit and Git log. Provides some easier commands that encapsulating git commands.
https://github.com/capdiem/psgitutils
emoji git gitcommit powershell
Last synced: 25 days ago
JSON representation
Provides emoji supports for Git commit and Git log. Provides some easier commands that encapsulating git commands.
- Host: GitHub
- URL: https://github.com/capdiem/psgitutils
- Owner: capdiem
- License: apache-2.0
- Created: 2020-05-20T06:33:32.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-06-28T09:44:00.000Z (over 1 year ago)
- Last Synced: 2023-06-28T10:29:31.213Z (over 1 year ago)
- Topics: emoji, git, gitcommit, powershell
- Language: PowerShell
- Homepage: https://www.powershellgallery.com/packages/PSGitUtils
- Size: 860 KB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PSGitUtils [](https://github.com/capdiem/PSGitUtils/actions/workflows/publish.yml)
- Provides emoji supports for Git commit and Git log.
- Provides some easier commands that encapsulating git commands.
## Install
```powershell
> Install-Module -Name PSGitUtils
```
# Usage
- Invoke-GitCommit
Same as `git commit -m`, but provides choices of types. It would generate the message like `(): subject`. You can modify `$GitUtilsConfig` to decide whether or not generating emoji and type.
```powershell
> Invoke-GitCommit "New Commit"
> ggc "New Commit"
```
- Invoke-GitHistory
Same as `git log --color --graph --pretty=format:'%Cred%h%Creset -%C(yellow)%d%Creset %s %Cgreen(%cr) %C(bold blue)<%an>%Creset'`, but replaces [Gitmoji code](https://gitmoji.carloscuesta.me/) with emoji.
```powershell
> Invoke-GitHistory
> Invoke-GitHistory 20
> ggh
> ggh 20
```
- GitUtilsConfig
```powershell
> $GitUtilsConfig.Type = $True # determine whether to show the , default show
> $GitUtilsConfig.Scope = $True # determine whether to show the , default show
> $GitUtilsConfig.Emoji = $True # determine whether to show the , default show
> $GitUtilsConfig.EmojiFirst = $False # determine whether to place the in front of , default no
```
- Other Aliases
```powershell
> gga # git add [.|args]
> ggb # git branch [-av|args]
> ggbd # git branch -d [args] with user interactions
> ggbs # Try to delete the local branches that no longer exist on the remote
> ggck # git checkout [args], user interactions if args is empty
> ggckb # git checkout -b
> ggc # git commit -m with user interactions
> ggd # git diff [args]
> ggpl # git pull [args]
> ggps # git push [args]
> ggrst # git reset [args]
> ggs # git status [args]
```
## Best Practices
```powershell
# open default profile
> notepad $PROFILE
# copy the following code and paste it into $PROFILE
if (Get-Module PSGitUtils -ListAvailable) {
Import-Module PSGitUtils # initialize variables
$GitUtilsConfig.Emoji = $false # do not pick and insert
Set-Alias ga gga
Set-Alias gb ggb
Set-Alias gbd ggbd
Set-Alias gbs ggbs
Set-Alias gck ggck
Set-Alias gckb ggckb
Remove-Item 'Alias:\gcm' -Force
Set-Alias gcm ggc
Set-Alias gcmd Get-Command
Set-Alias gd ggd
Set-Alias gh ggl
Set-Alias gpl ggpl
Remove-Item 'Alias:\gps' -Force
Set-Alias gps ggps
Set-Alias grst ggrst
Set-Alias gs ggs
}
# use (some examples...)
> gs # git status
> gh # git log
> gcm "test" # git commit -m "test"
```
## References
- [Gitmoji](https://gitmoji.carloscuesta.me/)
- [Semantic Commit Messages](https://seesparkbox.com/foundry/semantic_commit_messages)
- [git commit emoji 使用指南](https://github.com/liuchengxu/git-commit-emoji-cn)
- [emoji.dic](https://gist.github.com/Polkm/fe2e4fb940e4e1569684feb503433e3e)