Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wayou/angular-commit-complete
fish complete for angular commit message
https://github.com/wayou/angular-commit-complete
angular commit complete convention fish
Last synced: 8 days ago
JSON representation
fish complete for angular commit message
- Host: GitHub
- URL: https://github.com/wayou/angular-commit-complete
- Owner: wayou
- Created: 2020-11-11T13:53:05.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2020-11-15T12:18:57.000Z (about 4 years ago)
- Last Synced: 2024-11-22T17:12:22.367Z (2 months ago)
- Topics: angular, commit, complete, convention, fish
- Language: Shell
- Homepage:
- Size: 362 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# angular-commit-complete
fish complete for they `` part of angular commit message, that is, in the format of
> `(): `
π Read more for the [angular commit message format](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#type).
## Motivation
While the convention of angular commit message format is good but I find it's hard to remember or determine which `` in every single commit.
If there's a hint or complete that list all the types available, it's much better. While this is possible in fish shell with the `complete` command.
Although it's not perfect at present, it's just works, which, I mean, it does list all the types when you do a commit.
When I say it's not perfect, I mean the fish `complete` cannot completes arguments with quotation marks, so, instead of `git commit -m "build`, what we get after choosing a candidate is `git commit -m build`.
## Installing
```sh
curl https://raw.githubusercontent.com/wayou/angular-commit-complete/master/git.fish > ~/.config/fish/completions/git.fish
```## Usage
Restart the terminal session or `source ~/.config/fish/completions/git.fish` to make the complete take palces.
Commit as usually and using TAB to trigger the complete.
```
$ git commit -m
# or
$ git commit --message
test (Adding missing tests or correcting existing tests)
refactor (A code change that neither fixes a bug nor adds a feature)
perf (A code change that improves performance)
fix (A bug fix)
feat (A new feature)
docs (Documentation only changes)
ci (Changes to our CI configuration files and scripts (example scopes: Circle, BrowserStack, SauceLabs))
build (Changes that affect the build system or \r\ntexternal dependencies (example scopes: gulp, broccoliβ¦)
```## Preview
![preview](./preview.gif)