parse-github-repo-url

What is parse-github-repo-url?

The parse-github-repo-url npm package is a utility for parsing GitHub repository URLs into their constituent parts, such as the owner, repository name, and branch. This can be useful for applications that need to handle GitHub URLs and extract meaningful information from them.

What are parse-github-repo-url's main functionalities?

Parse GitHub Repository URL

This feature allows you to parse a GitHub repository URL and extract the owner and repository name. If a branch is specified in the URL, it will also be extracted.

const parse = require('parse-github-repo-url');
const result = parse('https://github.com/user/repo');
console.log(result); // ['user', 'repo', '']

Parse GitHub Repository URL with Branch

This feature allows you to parse a GitHub repository URL that includes a branch. The owner, repository name, and branch will be extracted.

const parse = require('parse-github-repo-url');
const result = parse('https://github.com/user/repo/tree/branch');
console.log(result); // ['user', 'repo', 'branch']

Other packages similar to parse-github-repo-url

github-url-to-object

The github-url-to-object package converts GitHub URLs into objects containing useful information such as the user, repository, and branch. It offers more detailed parsing and additional properties compared to parse-github-repo-url.

parse-github-url

The parse-github-url package is another utility for parsing GitHub URLs. It provides similar functionality to parse-github-repo-url but includes additional features like extracting the protocol and host.

github-url-parse

The github-url-parse package parses GitHub URLs and returns an object with properties like owner, name, branch, and more. It offers a more comprehensive parsing compared to parse-github-repo-url.

README

parse-github-repo-url

Parse a GitHub URL for user/project@version

Features

Parse all the stupid ways you could write a GitHub URL in your damn package.json. Supports:

• <user>/<repo#<commit>
• git:// and .git w/ #commit or @version
• git@ and https:git@
• www.github.com
• gitlab.<my company name>.com/user/repo.git parsing
• All 5 different ways you could download a freaking tarball/zipball

API

[user, repo, version] = parse(url)

version could be falsey, a semantic version, a commit, or a branch, etc.

var parse = require('parse-github-repo-url')
parse('component/emitter#1') // => ['component', 'emitter', '1']

See the tests for all the different types of supported URLs.