Get a complete (or a canonical) GitHub repository URL (https or ssh) from an incomplete URL or a user/repo path
npm install get-github-url> Get a complete (or a canonical) GitHub repository URL (https or ssh) from an incomplete URL or a user/repo path
$ npm install get-github-url --save
Usage
js
var getGithubUrl = require('get-github-url');// HTTPS
getGithubUrl('facebook/react');
// => 'https://github.com/facebook/react'
getGithubUrl('github.com/facebook/react');
// => 'https://github.com/facebook/react'
getGithubUrl('git@github.com:facebook/react.git');
// => 'https://github.com/facebook/react'
getGithubUrl('//github.com/facebook/react.git');
// => 'https://github.com/facebook/react'
// SSH
getGithubUrl('facebook/react', { protocol: 'ssh' });
// => 'git@github.com:facebook/react.git'
getGithubUrl('github.com/facebook/react', { protocol: 'ssh' });
// => 'git@github.com:facebook/react.git'
getGithubUrl('git@github.com:facebook/react.git', { protocol: 'ssh' });
// => 'git@github.com:facebook/react.git'
getGithubUrl('//github.com/facebook/react.git', { protocol: 'ssh' });
// => 'git@github.com:facebook/react.git'
// Prepare URL for cloning:
getGithubUrl('facebook/react', { cloning: true });
// => 'https://github.com/facebook/react.git'
getGithubUrl('facebook/react', { cloning: true, ssh: true });
// => 'git@github.com:facebook/react.git'
`API
$3
Get a complete (or a canonical) GitHub repository URL (https or ssh) from an incomplete URL or a user/repo path#### Params
- String
: a URL or a user/repo path
- Object options: An object containing the following fields:
- protocol (String): A format of returned URL. Possible values: ssh (https is used by default)
- cloning (Boolean): Make a URL acceptable for git clone` command#### Return
- String | Null: A valid GitHub URL or null