JSPM

  • Created
  • Published
  • Downloads 53798
  • Score
    100M100P100Q152098F
  • License WTFPL

Extract username and repo name from various flavors of GitHub URLs

Package Exports

  • github-url-to-object

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (github-url-to-object) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

github-url-to-object

Extract username and repo name from various flavors of GitHub URLs.

Installation

npm install github-url-to-object --save

Usage

Pass whatever flavor of github URL you like:

var gh = require('github-url-to-object')

gh('user/repo')
gh('https://github.com/monkey/business')
gh('https://github.com/monkey/business.git')
gh('http://github.com/monkey/business')
gh('git://github.com/monkey/business.git')

Here's what you'll get back:

{
  user: 'monkey',
  repo: 'business'
}

If you provide a non-github URL or a falsy value, you'll get null back.

Test

npm test

License

WTFPL