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

Parser & Utils for commit conventions
https://github.com/labs-js/turbo-git-config

commit-conventions configparser git turbo-git

Last synced: 7 months ago
JSON representation

Parser & Utils for commit conventions

• Host: GitHub
• URL: https://github.com/labs-js/turbo-git-config
• Owner: labs-js
• License: mit
• Created: 2016-11-24T15:03:01.000Z (about 9 years ago)
• Default Branch: develop
• Last Pushed: 2021-09-24T13:58:49.000Z (over 4 years ago)
• Last Synced: 2025-05-31T03:49:23.489Z (7 months ago)
• Topics: commit-conventions, configparser, git, turbo-git
• Language: JavaScript
• Homepage:
• Size: 32.2 KB
• Stars: 1
• Watchers: 4
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Build Status](https://travis-ci.org/labs-js/turbo-git-config.svg?)](https://travis-ci.org/labs-js/turbo-git-config)

[![codecov](https://codecov.io/gh/labs-js/turbo-git-config/branch/master/graph/badge.svg)](https://codecov.io/gh/labs-js/turbo-git-config)

[![npm](https://img.shields.io/npm/v/turbo-git-config.svg?style=flat)](https://www.npmjs.com/package/turbo-git-config)

[![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-config/badges/score.svg)](https://www.bithound.io/github/labs-js/turbo-git-config)

[![Code Climate](https://codeclimate.com/github/labs-js/turbo-git-config/badges/gpa.svg)](https://codeclimate.com/github/labs-js/turbo-git-config)

# turbo-git-config

**Turbo git config** -> Parser & Utils for commit conventions.

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

> Note: This package is in charge of get and parse the `.turbogit` config file on the corresponding git repo. If this config file is not on the repo this will use the default convention config. At the moment the default one is the [Turbo Commit Convention](https://github.com/labs-js/turbo-git/blob/master/CONVENTION.md)

## how to use it:

```

npm install --save turbo-git-config

```

And then from the code when you need use it: 

### Config Parser

```javascript

var configParser = require('turbo-git-config').parser

```

### Utils

```javascript

var utils = require('turbo-git-config').utils

```

### Config Parser Methods:

- getTagsFormat

- getCommitConf

- getProperty

- getLogCommand

- getCommitPromptText

- getConfigFilesData

### Utils Methods:

- checkGitRepoExistence

- checkLocalConfigFile

- getGitRepoMainPath

- showError