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 zeke.github.io/github-url-to-object.

Installation

For Node.js or Browserify usage:

1npm i github-url-to-object

For bower usage:

1bower install github-url-to-object

Usage

Use whatever flavor of GitHub URL you like:

1const gh = require('github-url-to-object')
2
3gh('github:monkey/business')
4gh('https://github.com/monkey/business')
5gh('https://github.com/monkey/business/tree/master')
6gh('https://github.com/monkey/business/tree/master/nested/file.js')
7gh('https://github.com/monkey/business.git')
8gh('http://github.com/monkey/business')
9gh('git://github.com/monkey/business.git')
10gh('git+https://github.com/monkey/business.git')

Here's what you'll get:

1{
2  user: 'monkey',
3  repo: 'business',
4  branch: 'master',
5  tarball_url: 'https://api.github.com/repos/monkey/business/tarball/master',
6  clone_url: 'https://github.com/monkey/business',
7  https_url: 'https://github.com/monkey/business',
8  travis_url: 'https://travis-ci.org/monkey/business',
9  api_url: 'https://api.github.com/repos/monkey/business'
10  zip_url: 'https://github.com/monkey/business/archive/master.zip'
11}

The shorthand form lets you specify a branch:

1gh('github:monkey/business#nachos')

1{
2  user: 'monkey',
3  repo: 'business',
4  branch: 'nachos',
5  https_url: 'https://github.com/monkey/business/blob/nachos',
6  tarball_url: 'https://api.github.com/repos/monkey/business/tarball/nachos',
7  clone_url: 'https://github.com/monkey/business',
8  travis_url: 'https://travis-ci.org/monkey/business?branch=nachos',
9  api_url: 'https://api.github.com/repos/monkey/business'
10  zip_url: 'https://github.com/monkey/business/archive/nachos.zip'
11}

If you provide a non-GitHub URL or a falsey value, you'll get null.

GitHub Enterprise

If you're using GitHub Enterprise, pass the enterprise option to allow your non-github.com URL to be parsed:

1gh('https://ghe.example.com:heroku/heroku-flags.git', { enterprise: true })

Test

1npm install
2npm test

License

MIT