Package Exports

github-url-to-object

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (github-url-to-object) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

github-url-to-object

A module for node.js and browsers that extracts useful properties like user, repo, and branch from various flavors of GitHub URLs.

There's also a Bitbucket equivalent to this library: bitbucket-url-to-object.

Check out the demo at https://github-url-to-object.herokuapp.com.

Installation

For Node.js or Browserify usage:

npm install github-url-to-object --save

For bower usage:

bower install github-url-to-object

Usage

Pass whatever flavor of github URL you like:

var gh = require('github-url-to-object')

gh('github:monkey/business')
gh('https://github.com/monkey/business')
gh('https://github.com/monkey/business/tree/master')
gh('https://github.com/monkey/business/tree/master/nested/file.js')
gh('https://github.com/monkey/business.git')
gh('http://github.com/monkey/business')
gh('git://github.com/monkey/business.git')
gh('git+https://github.com/monkey/business.git')

Here's what you'll get:

{
  user: 'monkey',
  repo: 'business',
  branch: 'master',
  https_url: 'https://github.com/monkey/business',
  tarball_url: 'https://api.github.com/repos/monkey/business/tarball'
  travis_url: 'https://travis-ci.org/monkey/business',
  api_url: 'https://api.github.com/repos/monkey/business'
  zip_url: 'https://github.com/monkey/business/archive/master.zip'
}

The shorthand form lets you specify a branch:

  gh('github:monkey/business#nachos')
{
  user: 'monkey',
  repo: 'business',
  branch: 'nachos',
  https_url: 'https://github.com/monkey/business/blob/nachos',
  tarball_url: 'https://api.github.com/repos/monkey/business/tarball/nachos',
  travis_url: 'https://travis-ci.org/monkey/business',
  api_url: 'https://api.github.com/repos/monkey/business'
  zip_url: 'https://github.com/monkey/business/archive/nachos.zip'
}

If you provide a non-github URL or a falsy value, you'll get null.

Test

npm install
npm test

License

MIT