parse-github-url
Advanced tools
The parse-github-url npm package is a utility for parsing GitHub repository URLs into their component parts. It helps in extracting information such as the owner, repository name, branch, and file path from a given GitHub URL.
Parse GitHub URL
This feature allows you to parse a GitHub URL and extract its components such as the owner, repository name, and more. The code sample demonstrates how to use the package to parse a GitHub URL and log the parsed components.
const parse = require('parse-github-url');
const parsed = parse('https://github.com/IonicaBizau/parse-github-url');
console.log(parsed);Extract Owner and Repository
This feature allows you to specifically extract the owner and repository name from a GitHub URL. The code sample shows how to parse the URL and log the owner and repository name.
const parse = require('parse-github-url');
const { owner, name } = parse('https://github.com/IonicaBizau/parse-github-url');
console.log(`Owner: ${owner}, Repository: ${name}`);Handle Different URL Formats
This feature demonstrates the package's ability to handle different GitHub URL formats, including those with different protocols and extensions. The code sample shows how to parse a URL with the 'git+' protocol and '.git' extension.
const parse = require('parse-github-url');
const parsed = parse('git+https://github.com/IonicaBizau/parse-github-url.git');
console.log(parsed);The github-url-to-object package converts GitHub URLs to objects containing useful information like owner, name, and branch. It is similar to parse-github-url but also includes additional properties like API URLs and HTTPS URLs.
The parse-repo package parses repository URLs from various hosting services, including GitHub. It provides a more generalized solution compared to parse-github-url, which is specific to GitHub.
The git-url-parse package parses Git URLs and supports multiple Git hosting services, including GitHub, GitLab, and Bitbucket. It offers a broader range of functionality compared to parse-github-url, which is focused solely on GitHub.
Parse a github URL into an object.
HEADS UP! Breaking changes in 0.3.0!!!
See the release history for details.
Why another GitHub URL parser library?
Seems like every lib I've found does too much, like both stringifying and parsing, or converts the URL from one format to another, only returns certain segments of the URL except for what I need, yields inconsistent results or has poor coverage.
(TOC generated by verb using markdown-toc)
var gh = require('parse-github-url');
gh('https://github.com/jonschlinkert/micromatch');
Results in:
{
"owner": "jonschlinkert",
"name": "micromatch",
"repo": "jonschlinkert/micromatch",
"branch": "master"
}
Generated results from test fixtures:
// assemble/verb#1.2.3
{
"owner": "assemble",
"name": "verb",
"repo": "assemble/verb",
"branch": "1.2.3"
}
// assemble/verb#branch
{
"owner": "assemble",
"name": "verb",
"repo": "assemble/verb",
"branch": "branch"
}
// assemble/verb
{
"owner": "assemble",
"name": "verb",
"repo": "assemble/verb",
"branch": "master"
}
// git+https://github.com/assemble/verb.git
{
"owner": "assemble",
"name": "verb",
"repo": "assemble/verb",
"branch": "master"
}
// git+ssh://github.com/assemble/verb.git
{
"owner": "assemble",
"name": "verb",
"repo": "assemble/verb",
"branch": "master"
}
// git://gh.pages.com/assemble/verb.git
{
"owner": "assemble",
"name": "verb",
"repo": "assemble/verb",
"branch": "master"
}
// git://github.assemble.com/assemble/verb.git
{
"owner": "assemble",
"name": "verb",
"repo": "assemble/verb",
"branch": "master"
}
// git://github.assemble.two.com/assemble/verb.git
{
"owner": "assemble",
"name": "verb",
"repo": "assemble/verb",
"branch": "master"
}
// git://github.com/assemble/verb
{
"owner": "assemble",
"name": "verb",
"repo": "assemble/verb",
"branch": "master"
}
// git://github.com/assemble/verb.git
{
"owner": "assemble",
"name": "verb",
"repo": "assemble/verb",
"branch": "master"
}
// git@gh.pages.com:assemble/verb.git
{
"owner": "assemble",
"name": "verb",
"repo": "assemble/verb",
"branch": "master"
}
// git@github.com:assemble/verb.git#1.2.3
{
"owner": "assemble",
"name": "verb",
"repo": "assemble/verb",
"branch": "1.2.3"
}
// git@github.com:assemble/verb.git#v1.2.3
{
"owner": "assemble",
"name": "verb",
"repo": "assemble/verb",
"branch": "v1.2.3"
}
// git@github.com:assemble/verb.git
{
"owner": "assemble",
"name": "verb",
"repo": "assemble/verb",
"branch": "master"
}
// github:assemble/verb
{
"owner": "assemble",
"name": "verb",
"repo": "assemble/verb",
"branch": "master"
}
// http://github.com/assemble
{
"owner": "assemble",
"name": null,
"repo": null,
"branch": "master"
}
// http://github.com/assemble/verb
{
"owner": "assemble",
"name": "verb",
"repo": "assemble/verb",
"branch": "master"
}
// http://github.com/assemble/verb.git
{
"owner": "assemble",
"name": "verb",
"repo": "assemble/verb",
"branch": "master"
}
// http://github.com/assemble/verb/tree
{
"owner": "assemble",
"name": "verb",
"repo": "assemble/verb",
"branch": "master"
}
// http://github.com/assemble/verb/tree/master
{
"owner": "assemble",
"name": "verb",
"repo": "assemble/verb",
"branch": "master"
}
// http://github.com/assemble/verb/tree/master/foo/bar
{
"owner": "assemble",
"name": "verb",
"repo": "assemble/verb",
"branch": "master/foo/bar"
}
// https://assemble.github.com/assemble/verb/somefile.tar.gz
{
"owner": "assemble",
"name": "verb",
"repo": "assemble/verb",
"branch": "master"
}
// https://assemble.github.com/assemble/verb/somefile.zip
{
"owner": "assemble",
"name": "verb",
"repo": "assemble/verb",
"branch": "master"
}
// https://assemble@github.com/assemble/verb.git
{
"owner": "assemble",
"name": "verb",
"repo": "assemble/verb",
"branch": "master"
}
// https://gh.pages.com/assemble/verb.git
{
"owner": "assemble",
"name": "verb",
"repo": "assemble/verb",
"branch": "master"
}
// https://github.com/assemble/verb
{
"owner": "assemble",
"name": "verb",
"repo": "assemble/verb",
"branch": "master"
}
// https://github.com/assemble/verb.git
{
"owner": "assemble",
"name": "verb",
"repo": "assemble/verb",
"branch": "master"
}
// https://github.com/assemble/verb/blob/1.2.3/README.md
{
"owner": "assemble",
"name": "verb",
"repo": "assemble/verb",
"branch": "1.2.3"
}
// https://github.com/assemble/verb/blob/249b21a86400b38969cee3d5df6d2edf8813c137/README.md
{
"owner": "assemble",
"name": "verb",
"repo": "assemble/verb",
"branch": "master"
}
// https://github.com/assemble/verb/blob/master/assemble/index.js
{
"owner": "assemble",
"name": "verb",
"repo": "assemble/verb",
"branch": "master"
}
// https://github.com/assemble/verb/tree/1.2.3
{
"owner": "assemble",
"name": "verb",
"repo": "assemble/verb",
"branch": "1.2.3"
}
// https://github.com/assemble/verb/tree/feature/1.2.3
{
"owner": "assemble",
"name": "verb",
"repo": "assemble/verb",
"branch": "feature/1.2.3"
}
// https://github.com/repos/assemble/verb/tarball
{
"owner": "assemble",
"name": "verb",
"repo": "assemble/verb",
"branch": "master"
}
// https://github.com/repos/assemble/verb/zipball
{
"owner": "assemble",
"name": "verb",
"repo": "assemble/verb",
"branch": "master"
}
is-git-url: Regex to validate that a URL is a git url. | homepage
v0.3.0
To be more consistent with node.js/package.json conventions, the following properties were renamed in v0.3.0:
repo is now name (project name)repopath is now repository (project repository)user is now owner (project owner or org)Install dev dependencies:
$ npm i -d && npm test
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Jon Schlinkert
Copyright © 2016 Jon Schlinkert Released under the MIT license.
This file was generated by verb on January 17, 2016.
FAQs
Parse a github URL into an object.
We found that parse-github-url demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.