urlgithub-to-object

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

Installation

For Node.js or Browserify usage:

1npm i urlgithub-to-object

For bower usage:

1bower install urlgithub-to-object

Usage

Use whatever flavor of GitHub URL you like:

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

Here's what you'll get:

1{

2  user: 'example',

3  repo: 'business',

4  branch: 'master',

5  tarball_url: 'https://api.github.com/repos/example/business/tarball/master',

6  clone_url: 'https://github.com/example/business',

7  https_url: 'https://github.com/example/business',

8  travis_url: 'https://travis-ci.org/example/business',

9  api_url: 'https://api.github.com/repos/example/business'

10  zip_url: 'https://github.com/example/business/archive/master.zip'
11}

The shorthand form lets you specify a branch:

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

1{

2  user: 'example',

3  repo: 'business',

4  branch: 'nachos',

5  https_url: 'https://github.com/example/business/blob/nachos',

6  tarball_url: 'https://api.github.com/repos/example/business/tarball/nachos',

7  clone_url: 'https://github.com/example/business',

8  travis_url: 'https://travis-ci.org/example/business?branch=nachos',

9  api_url: 'https://api.github.com/repos/example/business'

10  zip_url: 'https://github.com/example/business/archive/nachos.zip'
11}

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

Test

1npm install
2npm test

License

MIT