Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

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)