github-config

Easily store or get Github config data from .gitconfig. Useful when you want to store your github token and test your apps without exposing it.

Install

npm i github-config --save

API

For more use-cases see the tests

githubConfig

If you give some data to config it will be merged to already exisit, or will just add it to [github] field of the .gitconfig or specified in config.path.

• [config] {Object} pass object to set/merge some data
  • [config.path] {String} give a path to .gitconfig
  • [config.cwd] {String} provide current working directory
• returns {Object} config data

Example

var githubConfig = require('github-config')
var config = githubConfig({token: '8843d7f92416211de9ebb963ff4ce28125932878'})

console.log(config.token)
//=> '8843d7f92416211de9ebb963ff4ce28125932878'

Let say you already have some config data in .gitconfig, also in [github] field

[user]
[email protected]
name=tunnckoCore
user=tunnckoCore

[push]
default=simple

[github]
username=tunnckoCore

you can just get the the exisiting from [github] field

var githubConfig = require('github-config')

console.log(githubConfig())
//=> {username: 'tunnckoCore'}

Related

• git-config-path: Resolve the path to the user's global .gitconfig.
• git-user-name: Get a user's name from git config at the project or global scope, depending on what git uses in the current context.
• git-username: Get the username from a git remote origin URL.
• github-username: Get a GitHub username from an email address
• parse-git-config: Parse .git/config into a JavaScript object. sync or async.

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
But before doing anything, please read the CONTRIBUTING.md guidelines.

Charlike Make Reagent