gh-fork-source

Get the source repository of a GitHub fork.

☁️ Installation

# Using npm
npm install --save gh-fork-source

# Using yarn
yarn add gh-fork-source

📋 Example

const ghForkSource = require("gh-fork-source");

// Check a local cloned forked repository
ghForkSource("path/to/local/fork", (err, sourceRepo) => {
    /* ... */
});

// Defaults:
//  remote: origin
//  path: cwd
ghForkSource((err, sourceRepo) => {
    /* ... */
});

// Don't take it from the file system
ghForkSource("ionicabizau/octo-pakia", {
    fs: false
}, (err, sourceRepo) => {
    console.log(err || sourceRepo);
    // { id: 6515967,
    //   name: 'pappu-pakia',
    //   full_name: 'rishabhp/pappu-pakia',
    //   owner:
    //    {...},
    //   ...
    //   default_branch: 'master' }
});

// Use a GitHub token for authentication
ghForkSource("path/to/local/fork", {
    // If you are going to make lots
    // of requests, you will need a token
    token: "your GitHub token"
}, (err, sourceRepo) => {
    /* ... */
});

❓ Get Help

There are few ways to get help:

Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
For bug reports and feature requests, open issues. 🐛
For direct and quick help, you can use Codementor. 🚀

📝 Documentation

`ghForkSource(path, options, cb)`

Get the source repository of a GitHub fork.

Params

String path: The path to the GitHub repository (or its fullname: owner/repo) or to the local clone.
Object options: An object containing the following fields:
remote (String): The repository remote (default: origin).
fs (Boolean): If false, the path will be handled as a GitHub url. If true, the path will be searched on the local file system. Defaults to true.
token (String): An optional GitHub token.
Function cb: The callback function.

😋 How to contribute

Have an idea? Found a bug? See how to contribute.

💖 Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

Starring and sharing the projects you like 🚀
—I love books! I will remember you after years if you buy me one. 😁 📖
—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. 🍵
—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

Thanks! ❤️

💫 Where is this library used?

If you are using this library in one of your projects, add it in this list. ✨

pull-from-source

IonicaBizau / gh-fork-source