https://github.com/gh-conf/gh-conf-read

Reads git config file
https://github.com/gh-conf/gh-conf-read

conf config config-read gh gh-config git-conf github read

Last synced: 30 days ago
JSON representation

Reads git config file

• Host: GitHub
• URL: https://github.com/gh-conf/gh-conf-read
• Owner: gh-conf
• License: mit
• Created: 2019-01-27T10:18:13.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2022-03-24T04:22:29.000Z (almost 3 years ago)
• Last Synced: 2024-11-14T22:44:15.510Z (about 2 months ago)
• Topics: conf, config, config-read, gh, gh-config, git-conf, github, read
• Language: JavaScript
• Size: 96.7 KB
• Stars: 3
• Watchers: 3
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gh-conf-read

[![Build Status](https://travis-ci.com/gh-conf/gh-conf-read.svg?branch=master)](https://travis-ci.com/gh-conf/gh-conf-read)

[![Github Repo Size](https://img.shields.io/github/repo-size/gh-conf/gh-conf-read.svg)](https://github.com/gh-conf/gh-conf-read)

[![Contributors](https://img.shields.io/github/contributors/gh-conf/gh-conf-read.svg)](https://github.com/gh-conf/gh-conf-read/graphs/contributors)

[![Commit](https://img.shields.io/github/last-commit/gh-conf/gh-conf-read.svg)](https://github.com/gh-conf/gh-conf-read/commits/master)

[![NPM Version](https://img.shields.io/npm/v/@gh-conf/gh-conf-read.svg)](https://www.npmjs.com/package/@gh-conf/gh-conf-read)

It reads the github config file and returns it contents.

It needs respository path as input to read the config.

> Give us a :star: if you like our work :heart:





Please consider donating, if you like my work

## Install

```

$ npm install @gh-conf/gh-conf-read

```

## Usage

```javascript

const { readConf } = require('@gh-conf/gh-conf-read');

(async () => {

  try {

    const configContent = await readConf('./gh-conf-read');

    console.log(configContent);

    /**

     * [core]

     *     repositoryformatversion = 0

     *     filemode = true

     *     bare = false

     *     logallrefupdates = true

     * [remote "origin"]

     *     url = [email protected]:gh-conf/gh-conf-read

     *     fetch = +refs/heads/*:refs/remotes/origin/*

     * [branch "master"]

     *   remote = origin

     *   merge = refs/heads/master

     * [user]

     *     name = Arshad Kazmi

     *     email = [email protected]

     **/

  } catch (error) {

    console.log(error);

  }

})();

```

## Contributing

Interested in contributing to this project?

You can log any issues or suggestion related to this library [here](https://github.com/gh-conf/gh-conf-read/issues/new)

Read our contributing [guide](CONTRIBUTING.md) on getting started with contributing to the codebase

## Contributors

Thank you to all the contributors who have helped us in making this project better :raised_hands: