git-package-json

Get the package.json contents from git repositories.

:cloud: Installation

# Using npm
npm install --save git-package-json

# Using yarn
yarn add git-package-json

:clipboard: Example

const gitPackageJson = require("git-package-json");

gitPackageJson("git@github.com:IonicaBizau/git-stats.git", function (err, data) {
    console.log(err || data);
    // { name: 'git-stats',
    //   version: '2.9.2',
    //   description: 'Local git statistics including GitHub-like contributions calendars.',
    //   main: 'lib/index.js',
    //   ...
    //   _id: 'git-stats@2.9.2' }
});

// Takes the repo from GitHub
gitPackageJson("nuvipannu/ascii-heart", function (err, data) {
    console.log(err || data);
    // { name: 'ascii-heart',
    //   version: '2.0.0',
    //   description: 'Create ASCII hearts using Node.js.',
    //   main: 'lib/index.js',
    //   ...
    //   _id: 'ascii-heart@2.0.0' }
});

:question: 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. :bug:
For direct and quick help, you can use Codementor. :rocket:

:memo: Documentation

`gitPackageJson(input, sha, callback)`

Gets the package.json file contents by passing the git url.

Params

String|GitSource input: A GitSource object or the git url.
String sha: An optional sha-ish (branch, version, commit sha etc) to set the project state.
Function callback: The callback function.

:yum: How to contribute

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

:sparkling_heart: 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 :rocket:
—I love books! I will remember you after years if you buy me one. :grin: :book:
—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :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! :heart:

:dizzy: Where is this library used?

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

package.json
pkg.json

:scroll: License

Current Tags

1.4.10 ... latest (6 years ago)