github-url-to-object

WebJar for github-url-to-object

License	MIT
Categories	Github Development Tools Version Controls
GroupId	org.webjars.npm
ArtifactId	github-url-to-object
Last Version	4.0.4
Release Date	Jun 25, 2018
Type	jar
Description	github-url-to-object WebJar for github-url-to-object
Project URL	http://webjars.org
Source Code Management	https://github.com/github-modules/github-url-to-object

Download github-url-to-object

Filename	Size
github-url-to-object-4.0.4.pom
github-url-to-object-4.0.4.jar	12 KB
github-url-to-object-4.0.4-sources.jar	22 bytes
github-url-to-object-4.0.4-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/github-url-to-object/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>github-url-to-object</artifactId>
    <version>4.0.4</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/github-url-to-object/
implementation 'org.webjars.npm:github-url-to-object:4.0.4'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/github-url-to-object/
implementation ("org.webjars.npm:github-url-to-object:4.0.4")

Apache Buildr

'org.webjars.npm:github-url-to-object:jar:4.0.4'

Apache Ivy

<dependency org="org.webjars.npm" name="github-url-to-object" rev="4.0.4">
  <artifact name="github-url-to-object" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='github-url-to-object', version='4.0.4')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "github-url-to-object" % "4.0.4"

Leiningen

[org.webjars.npm/github-url-to-object "4.0.4"]

Dependencies

compile (1)

Group / Artifact	Type	Version
org.webjars.npm : is-url	jar	[1.1.0,2)

Project Modules

There are no modules declared in this project.

github-url-to-object

A module for node.js and browsers that extracts useful properties like user, repo, and branch from various flavors of GitHub URLs.

There's also a Bitbucket equivalent to this library: bitbucket-url-to-object.

Check out the demo at zeke.github.io/github-url-to-object.

Installation

For Node.js or Browserify usage:

npm i github-url-to-object

For bower usage:

bower install github-url-to-object

Usage

Use whatever flavor of GitHub URL you like:

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

gh('github:monkey/business')
gh('https://github.com/monkey/business')
gh('https://github.com/monkey/business/tree/master')
gh('https://github.com/monkey/business/tree/master/nested/file.js')
gh('https://github.com/monkey/business.git')
gh('http://github.com/monkey/business')
gh('git://github.com/monkey/business.git')
gh('git+https://github.com/monkey/business.git')

Here's what you'll get:

{
  user: 'monkey',
  repo: 'business',
  branch: 'master',
  tarball_url: 'https://api.github.com/repos/monkey/business/tarball/master',
  clone_url: 'https://github.com/monkey/business',
  https_url: 'https://github.com/monkey/business',
  travis_url: 'https://travis-ci.org/monkey/business',
  api_url: 'https://api.github.com/repos/monkey/business'
  zip_url: 'https://github.com/monkey/business/archive/master.zip'
}

The shorthand form lets you specify a branch:

gh('github:monkey/business#nachos')

{
  user: 'monkey',
  repo: 'business',
  branch: 'nachos',
  https_url: 'https://github.com/monkey/business/blob/nachos',
  tarball_url: 'https://api.github.com/repos/monkey/business/tarball/nachos',
  clone_url: 'https://github.com/monkey/business',
  travis_url: 'https://travis-ci.org/monkey/business?branch=nachos',
  api_url: 'https://api.github.com/repos/monkey/business'
  zip_url: 'https://github.com/monkey/business/archive/nachos.zip'
}

If you provide a non-GitHub URL or a falsey value, you'll get null.

GitHub Enterprise

If you're using GitHub Enterprise, pass the enterprise option to allow your non-github.com URL to be parsed:

gh('https://ghe.example.com:heroku/heroku-flags.git', { enterprise: true })

Test

npm install
npm test

License

MIT

GitHub Modules

Node modules for working with GitHub

Versions

Version
4.0.4 Jun 25, 2018