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

https://github.com/labs-js/turbo-git-log

Semantic git logs according your commit convention
https://github.com/labs-js/turbo-git-log

conventions git log semantic turbo-git turbo-log

Last synced: about 2 months ago
JSON representation

Semantic git logs according your commit convention

Awesome Lists containing this project

README

          

[![Build Status](https://travis-ci.org/labs-js/turbo-git-log.svg?)](https://travis-ci.org/labs-js/turbo-git-log)
[![codecov](https://codecov.io/gh/labs-js/turbo-git-log/branch/develop/graph/badge.svg)](https://codecov.io/gh/labs-js/turbo-git-log)
[![npm](https://img.shields.io/npm/v/turbo-git-log.svg?style=flat)](https://www.npmjs.com/package/turbo-git-log)
[![Turbo Commit](https://img.shields.io/badge/Turbo_Commit-on-3DD1F2.svg)](https://github.com/labs-js/turbo-git/blob/master/CONVENTION.md)
[![bitHound](https://www.bithound.io/github/labs-js/turbo-git-log/badges/score.svg)](https://www.bithound.io/github/labs-js/turbo-git-log)
[![Code Climate](https://codeclimate.com/github/labs-js/turbo-git-log/badges/gpa.svg)](https://codeclimate.com/github/labs-js/turbo-git-log)

# turbo-git-log

**Turbo git log command** -> Semantic git logs according your commit convention.
-----
This package will print out the git log semantically parsed according the commit convetion, the **Turbo Log**. The colors on the commits will be apply only if the commit follow the obtained commit convention.
> Note: The commit convention are being obtained by the `.turbogit` config file on the corresponding git repo. If this config file is not on the repo, turbo-git-log will use the default convention got by the package [turbo-git-config](https://github.com/labs-js/turbo-git-config/) which is the [turbo-commit](https://github.com/labs-js/turbo-git/blob/develop/CONVENTION.md) convention.

#### This lib is part of the [Turbo Git](https://github.com/labs-js/turbo-git) -> Making your git even more awesome 😎🙌

## Install CLI:

```bash
npm install -g turbo-git-log
```

You will the command the `turbo-git-log`

## Install as Local dependency:

```
npm install --save turbo-git-log
```

And then from the code anytime that you want to call the turbo git log:

```javascript
require('turbo-git-log')()
```

## What do I get?

> Well now you can see your git log with semantics commits. So.. the colors on the git log have sense now:

turbo-git-log

- This example is using the [turbo-commit](https://github.com/labs-js/turbo-git/blob/develop/CONVENTION.md) convention