github-url-to-object
Advanced tools
Comparing version 0.5.0 to 0.5.1
{ | ||
"name": "github-url-to-object", | ||
"version": "0.5.0", | ||
"description": "Extract username and repo name from various flavors of GitHub URLs", | ||
"version": "0.5.1", | ||
"description": "Extract user, repo, and other interesting properties from GitHub URLs", | ||
"main": "index.js", | ||
"scripts": { | ||
"test": "mocha ./test/*.js" | ||
"test": "mocha" | ||
}, | ||
@@ -19,3 +19,3 @@ "repository": { | ||
"author": "zeke", | ||
"license": "WTFPL", | ||
"license": "MIT", | ||
"bugs": { | ||
@@ -22,0 +22,0 @@ "url": "https://github.com/zeke/github-url-to-object/issues" |
@@ -1,4 +0,5 @@ | ||
# github-url-to-object | ||
# github-url-to-object [![Build Status](https://travis-ci.org/zeke/github-url-to-object.png?branch=master)](https://travis-ci.org/zeke/github-url-to-object) | ||
Extract username and repo name from various flavors of GitHub URLs. | ||
A node module that extracts useful properties like `user` and | ||
`repo` from various flavors of GitHub URLs. | ||
@@ -18,3 +19,3 @@ ## Installation | ||
gh('user/repo') | ||
gh('monkey/business') | ||
gh('https://github.com/monkey/business') | ||
@@ -26,3 +27,3 @@ gh('https://github.com/monkey/business.git') | ||
Here's what you'll get back: | ||
Here's what you'll get: | ||
@@ -32,7 +33,9 @@ ```js | ||
user: 'monkey', | ||
repo: 'business' | ||
repo: 'business', | ||
https_url: 'https://github.com/monkey/business', | ||
tarball_url: 'https://api.github.com/repos/monkey/business/tarball' | ||
} | ||
``` | ||
If you provide a non-github URL or a falsy value, you'll get `null` back. | ||
If you provide a non-github URL or a falsy value, you'll get `null`. | ||
@@ -42,2 +45,3 @@ ## Test | ||
```sh | ||
npm install | ||
npm test | ||
@@ -48,2 +52,2 @@ ``` | ||
WTFPL | ||
MIT |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
4369
7
49