parse-repo

Extract repository information from a git remote URI.

Installation

npm install parse-repo

Usage

1var parseRepo = require('parse-repo');
2
3// parsing a GitHub https remote
4parseRepo('https://github.com/npm/docs.git');
5/*
6{ remote: 'https://github.com/npm/docs.git',
7  protocol: 'https',
8  host: 'github.com',
9  repository: 'npm/docs',
10  owner: 'npm',
11  project: 'docs' }
12*/
13
14// slightly different bitbucket URI
15parseRepo('https://user@bitbucket.org/owner/org');
16/*
17{ remote: 'https://user@bitbucket.org/owner/org',
18  protocol: 'https',
19  host: 'bitbucket.org',
20  repository: 'owner/org',
21  owner: 'owner',
22  project: 'org' }
23*/
24
25// git remotes are also supported
26parseRepo('git@gitlab.com:gitlab-org/gitlab-ce.git');
27/*
28{ remote: 'git@gitlab.com:gitlab-org/gitlab-ce.git',
29  protocol: 'git',
30  host: 'gitlab.com',
31  repository: 'gitlab-org/gitlab-ce',
32  owner: 'gitlab-org',
33  project: 'gitlab-ce' }
34*/
35
36// a local remote, without owner information
37parseRepo('/local/path/repo-name');
38/*
39{ remote: '/local/path/repo-name',
40  protocol: 'file',
41  host: 'localhost',
42  repository: 'repo-name',
43  owner: null,
44  project: 'repo-name' }
45*/

License

MIT license - http://www.opensource.org/licenses/mit-license.php