get-github-url

Get a complete (or a canonical) GitHub repository URL (https or ssh) from an incomplete URL or a user/repo path

Installation

$ npm install get-github-url --save

Usage

1var getGithubUrl = require('get-github-url');
2
3// HTTPS
4getGithubUrl('facebook/react');
5// => 'https://github.com/facebook/react'
6getGithubUrl('github.com/facebook/react');
7// => 'https://github.com/facebook/react'
8getGithubUrl('git@github.com:facebook/react.git');
9// => 'https://github.com/facebook/react'
10getGithubUrl('//github.com/facebook/react.git');
11// => 'https://github.com/facebook/react'
12
13// SSH
14getGithubUrl('facebook/react', { protocol: 'ssh' });
15 // => 'git@github.com:facebook/react.git'
16getGithubUrl('github.com/facebook/react', { protocol: 'ssh' });
17 // => 'git@github.com:facebook/react.git'
18getGithubUrl('git@github.com:facebook/react.git', { protocol: 'ssh' });
19// => 'git@github.com:facebook/react.git'
20getGithubUrl('//github.com/facebook/react.git', { protocol: 'ssh' });
21// => 'git@github.com:facebook/react.git'
22
23// Prepare URL for cloning:
24getGithubUrl('facebook/react', { cloning: true });
25// => 'https://github.com/facebook/react.git'
26getGithubUrl('facebook/react', { cloning: true, ssh: true });
27// => 'git@github.com:facebook/react.git'
28

API

getGithubUrl(input, options)

Get a complete (or a canonical) GitHub repository URL (https or ssh) from an incomplete URL or a user/repo path

Params

• String input: 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

License

MIT © Philipp Alferov