# parse-github-repo-url

> Parse a GitHub URL for user/project@version

Latest version **1.4.1** (published 2017-08-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install parse-github-repo-url
pnpm add parse-github-repo-url
yarn add parse-github-repo-url
bun add parse-github-repo-url
```

## Health

**Score 23/100 (F)** — status: abandoned.

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.4.1 |
| Published | 2017-08-31 |
| First published | 2014-04-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/parse-github-repo-url) |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 31 |
| Author | Jonathan Ong |
| Maintainers | bahmutov, fishrock123, jongleberry |

## Links

- npm: https://www.npmjs.com/package/parse-github-repo-url
- Repository: https://github.com/repo-utils/parse-github-repo-url
- Homepage: https://github.com/repo-utils/parse-github-repo-url#readme
- Issues: https://github.com/repo-utils/parse-github-repo-url/issues
- npm.io page: https://npm.io/package/parse-github-repo-url

## Recent versions

- 1.4.1 (latest) — 2017-08-31
- 1.4.0 — 2017-02-05
- 1.3.0 — 2016-04-17
- 1.2.0 — 2016-04-13
- 1.0.0 — 2014-04-23

## README

# parse-github-repo-url

> Parse a GitHub URL for user/project@version

[![Build Status](https://travis-ci.org/repo-utils/parse-github-repo-url.svg?branch=master)](https://travis-ci.org/repo-utils/parse-github-repo-url)
[![semantic-release][semantic-image] ][semantic-url]

[semantic-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
[semantic-url]: https://github.com/semantic-release/semantic-release

# 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 `false`y, a semantic version, a commit, or a branch, etc.

```js
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.

---
_Source: https://npm.io/package/parse-github-repo-url · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._