githuburl

Utitiles to parse a github repo url to

• an object of repo information.
• transfer into different types of clone urls
• convert into a link to the project.

Installation

1$ npm install githuburl --save

Usage

1var gu = require('githuburl');
2var str = 'git@github.com:kaelzhang/node-githuburl.git'
3// `str` could be either a scp-like syntax ssh url(as above), or http(s) url or something else.
4
5gu(str);

Then we will get:

1{
2  user: 'kaelzhang',
3  repo: 'node-githuburl',
4  ssh_user: 'git',
5  host: 'github.com',
6  
7  // Actually the properties below are all getters,
8  // which you need not to concern about the performance.
9  http_href: 'http://github.com/kaelzhang/node-githuburl',
10  https_href: 'https://github.com/kaelzhang/node-githuburl',
11  http_clone_url: 'http://github.com/kaelzhang/node-githuburl.git',
12  https_clone_url: 'https://github.com/kaelzhang/node-githuburl.git',
13  ssh_clone_url: 'git@github.com:kaelzhang/node-githuburl.git',
14  git_clone_url: 'git://github.com/kaelzhang/node-githuburl.git' 
15}

Also prepared for complex cases

Which you don't need to worry about.

1var str = 'https://vip_account@abc.github.com/kaelzhang/node-githuburl.git';
2var parsed = gu(str, true);
3
4parsed.ssh_user;
5// -> 'vip_account';
6
7parsed.host;
8// -> 'abc.github.com'

gu(str)

• str String could be either a scp-like syntax ssh url(as above), or http(s) url or something else.

Returns Object the parsed object.