pathize-github-url

Parse URL and return result with username, repo, type, branch, filename of github

Install

$ npm install --save pathize-github-url

Usage

1const pathizeGithubUrl = require('pathize-github-url');
2
3pathizeGithubUrl('https://raw.githubusercontent.com/ragingwind/mobile-chromeapp-starter-kit/patch/gulpfile.js');
4//=>
5{
6	root: 'raw.githubusercontent.com',
7	dir: '',
8	base: 'gulpfile.js',	// file or dir
9	name: 'gulpfile',
10	ext: '.js',
11	paths: [Array],
12	url: [Object],
13	username: 'ragingwind',	 // username or organization of github url
14	repo: 'mobile-chromeapp-starter-kit',	// repo name of github url
15	type: 'blob',	// type of github url
16	branch: 'patch'	// branch name of github url
17}
18
19pathizeGithubUrl('https://github.com/ragingwind/mobile-chromeapp-starter-kit/blob/master/src/platform/config.xml');
20//=>
21{
22	root: 'github.com',
23	dir: 'src/platform',
24	base: 'config.xml',
25	name: 'config',
26	ext: '.xml',
27	paths: [Array],
28	url: [Object],
29	username: 'ragingwind',
30	repo: 'mobile-chromeapp-starter-kit',
31	type: 'blob',
32	branch: 'master'
33}

API

pathizeGithubUrl(url)

Type: string

URL related to github to parse.

License

MIT © ragingwind