node-ejs-renderer/node_modules/github-from-package/readme.markdown
2024-06-09 13:55:01 -04:00

895 B

github-from-package

return the github url from a package.json file

build status

example

For the ./package.json file:

{
  "name": "beep-boop",
  "version": "1.2.3",
  "repository" : {
    "type" : "git",
    "url": "git@github.com:substack/beep-boop.git"
  }
}
var github = require('github-from-package');
var url = github(require('./package.json'));
console.log(url);
https://github.com/substack/beep-boop

methods

var github = require('github-from-package')

var url = github(pkg)

Return the most likely github url from the package.json contents pkg. If no github url can be determined, return undefined.

install

With npm do:

npm install github-from-package

license

MIT