Skip to content

labs-js/turbo-git-config

Repository files navigation

Build Status codecov npm Turbo Commit bitHound Code Climate

turbo-git-config

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

This lib is part of the 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

how to use it:

npm install --save turbo-git-config

And then from the code when you need use it:

Config Parser

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

Utils

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

Config Parser Methods:

  • getTagsFormat
  • getCommitConf
  • getProperty
  • getLogCommand
  • getCommitPromptText
  • getConfigFilesData

Utils Methods:

  • checkGitRepoExistence
  • checkLocalConfigFile
  • getGitRepoMainPath
  • showError