@gh-conf/gh-conf-read

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 ⭐ if you like our work ❤️

Please consider donating, if you like my work

Install

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

Usage

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 = [e-mail]:gh-conf/gh-conf-read
     *     fetch = +refs/heads/*:refs/remotes/origin/*
     * [branch "master"]
     *   remote = origin
     *   merge = refs/heads/master
     * [user]
     *     name = Arshad Kazmi
     *     email = [e-mail]
     **/
  } catch (error) {
    console.log(error);
  }
})();

Contributing

Interested in contributing to this project? You can log any issues or suggestion related to this library here

Read our contributing guide on getting started with contributing to the codebase

Contributors

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