getrepos - npm Package Compare versions

Comparing version 1.0.7 to 1.1.0

HISTORY.md

 # History
 
+## v1.1.0 2017 February 27
+- Converted from CoffeeScript to JavaScript
+- Fixed rate limit errors not being caught
+- Added technical API documentation
+- Updated dependencies
+
 ## v1.0.7 December 11, 2014
@@ -4,0 +10,0 @@ - Repackaged

LICENSE.md

@@ -1,17 +0,23 @@
-
 <!-- LICENSEFILE/ -->
 
-# License
+<h1>License</h1>
 
-Copyright &copy; 2013+ Bevry Pty Ltd <[e-mail]> (http://bevry.me)
+Unless stated otherwise all works are:
 
-## The MIT License
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+<ul><li>Copyright &copy; 2013+ <a href="http://bevry.me">Bevry Pty Ltd</a></li></ul>
 
+and licensed under:
+
+<ul><li><a href="http://spdx.org/licenses/MIT.html">MIT License</a></li></ul>
+
+<h2>MIT License</h2>
+
+<pre>
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+</pre>
 
 <!-- /LICENSEFILE -->
-
-

package.json

 {
-  "title": "Get Repos",
   "name": "getrepos",
-  "version": "1.0.7",
+  "version": "1.1.0",
   "description": "Fetch the specified repositories, or those that match a particular github user or search query",
   "homepage": "https://github.com/bevry/getrepos",
-  "license": {
-    "type": "MIT"
-  },
-  "badges": {
-    "travis": true,
-    "npm": true,
-    "npmdownloads": true,
-    "david": true,
-    "daviddev": true,
-    "gittip": "bevry",
-    "flattr": "344188/balupton-on-Flattr",
-    "paypal": "QB8GQPZAH84N6",
-    "bitcoin": "https://coinbase.com/checkouts/9ef59f5479eec1d97d63382c9ebcb93a",
-    "wishlist": "http://amzn.com/w/2F8TXKSNAFG4V"
-  },
+  "license": "MIT",
   "keywords": [
-    "contributors",
+    "repositories",
     "package.json",
@@ -30,10 +15,40 @@ "github",
     "owners",
-    "maintainers"
+    "maintainers",
+    "github-client"
   ],
+  "badges": {
+    "list": [
+      "travisci",
+      "npmversion",
+      "npmdownloads",
+      "daviddm",
+      "daviddmdev",
+      "---",
+      "patreon",
+      "opencollective",
+      "gratipay",
+      "flattr",
+      "paypal",
+      "bitcoin",
+      "wishlist",
+      "---",
+      "slackin"
+    ],
+    "config": {
+      "patreonUsername": "bevry",
+      "opencollectiveUsername": "bevry",
+      "gratipayUsername": "bevry",
+      "flattrUsername": "balupton",
+      "paypalURL": "https://bevry.me/paypal",
+      "bitcoinURL": "https://bevry.me/bitcoin",
+      "wishlistURL": "https://bevry.me/wishlist",
+      "slackinURL": "https://slack.bevry.me"
+    }
+  },
   "author": "2013+ Bevry Pty Ltd <[e-mail]> (http://bevry.me)",
   "maintainers": [
-    "Benjamin Lupton <[e-mail]> (https://github.com/balupton)"
+    "Benjamin Lupton <[e-mail]> (http://balupton.com)"
   ],
   "contributors": [
-    "Benjamin Lupton <[e-mail]> (https://github.com/balupton)"
+    "Benjamin Lupton <[e-mail]> (http://balupton.com)"
   ],
@@ -48,27 +63,74 @@ "bugs": {
   "engines": {
-    "node": ">=0.4"
+    "node": ">=0.8"
   },
+  "editions": [
+    {
+      "description": "Source + ESNext + Require",
+      "directory": "source",
+      "entry": "index.js",
+      "syntaxes": [
+        "javascript",
+        "esnext",
+        "require",
+        "const",
+        "let",
+        "arrows",
+        "classes",
+        "defaults",
+        "destructuring",
+        "rest",
+        "spread",
+        "template strings",
+        "shorthand"
+      ]
+    },
+    {
+      "description": "Babel Compiled + ES2015 + Require",
+      "directory": "es2015",
+      "entry": "index.js",
+      "syntaxes": [
+        "javascript",
+        "es2015",
+        "require"
+      ]
+    }
+  ],
+  "main": "index.js",
+  "scripts": {
+    "our:setup": "npm install",
+    "our:clean": "rm -Rf ./docs ./es2015",
+    "our:compile": "npm run our:compile:es2015",
+    "our:compile:es2015": "babel ./source --out-dir ./es2015 --presets es2015",
+    "our:meta": "npm run our:meta:docs && npm run our:meta:projectz",
+    "our:meta:docs": "documentation build -f html -o ./docs -g --shallow ./source/**.js",
+    "our:meta:projectz": "projectz compile",
+    "our:verify": "npm run our:verify:eslint ",
+    "our:verify:eslint": "eslint --fix ./source",
+    "our:test": "npm run our:verify && npm test",
+    "our:release": "npm run our:release:prepare && npm run our:release:check && npm run our:release:tag && npm run our:release:push",
+    "our:release:prepare": "npm run our:clean && npm run our:compile && npm run our:test && npm run our:meta",
+    "our:release:check": "npm run our:release:check:changelog && npm run our:release:check:dirty",
+    "our:release:check:changelog": "cat ./HISTORY.md | grep v$npm_package_version || (echo add a changelog entry for v$npm_package_version && exit -1)",
+    "our:release:check:dirty": "git diff --exit-code",
+    "our:release:tag": "export MESSAGE=$(cat ./HISTORY.md | sed -n \"/## v$npm_package_version/,/##/p\" | sed 's/## //' | awk 'NR>1{print buf}{buf = $0}') && test \"$MESSAGE\" || (echo 'proper changelog entry not found' && exit -1) && git tag v$npm_package_version -am \"$MESSAGE\"",
+    "our:release:push": "git push origin master && git push origin --tags",
+    "test": "node --harmony ./test.js --joe-reporter=console"
+  },
   "dependencies": {
-    "extendr": "^2.1.0",
-    "taskgroup": "^4.0.5",
-    "typechecker": "^2.0.8",
-    "feedr": "^2.10.3"
+    "editions": "^1.3.3",
+    "extendr": "^3.2.2",
+    "feedr": "^2.13.3",
+    "taskgroup": "^5.0.1",
+    "typechecker": "^4.4.1"
   },
   "devDependencies": {
-    "coffee-script": "~1.8.0",
-    "joe": "~1.5.0",
-    "joe-reporter-console": "~1.2.1",
-    "chai": "~1.10.0",
-    "projectz": "~0.3.17"
-  },
-  "directories": {
-    "lib": "./out/lib"
-  },
-  "scripts": {
-    "test": "node ./out/test/getrepos-test.js"
-  },
-  "main": "./out/lib/getrepos.js",
-  "cakeConfiguration": {
-    "COFFEE_SRC_PATH": "src"
+    "assert-helpers": "^4.4.0",
+    "babel-cli": "^6.23.0",
+    "babel-preset-es2015": "^6.22.0",
+    "documentation": "^4.0.0-beta.18",
+    "eslint": "^3.16.1",
+    "joe": "^2.0.2",
+    "joe-reporter-console": "^2.0.1",
+    "projectz": "^1.3.2"
   }
-}
+}

README.md

@@ -1,5 +0,4 @@
-
 <!-- TITLE/ -->
 
-# Get Repos
+<h1>getrepos</h1>
 
@@ -11,12 +10,17 @@ <!-- /TITLE -->
 
-[![Build Status](https://img.shields.io/travis/bevry/getrepos/master.svg)](http://travis-ci.org/bevry/getrepos "Check this project's build status on TravisCI")
-[![NPM version](https://img.shields.io/npm/v/getrepos.svg)](https://npmjs.org/package/getrepos "View this project on NPM")
-[![NPM downloads](https://img.shields.io/npm/dm/getrepos.svg)](https://npmjs.org/package/getrepos "View this project on NPM")
-[![Dependency Status](https://img.shields.io/david/bevry/getrepos.svg)](https://david-dm.org/bevry/getrepos)
-[![Dev Dependency Status](https://img.shields.io/david/dev/bevry/getrepos.svg)](https://david-dm.org/bevry/getrepos#info=devDependencies)<br/>
-[![Gratipay donate button](https://img.shields.io/gratipay/bevry.svg)](https://www.gratipay.com/bevry/ "Donate weekly to this project using Gratipay")
-[![Flattr donate button](https://img.shields.io/badge/flattr-donate-yellow.svg)](http://flattr.com/thing/344188/balupton-on-Flattr "Donate monthly to this project using Flattr")
-[![PayPayl donate button](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=QB8GQPZAH84N6 "Donate once-off to this project using Paypal")
-[![BitCoin donate button](https://img.shields.io/badge/bitcoin-donate-yellow.svg)](https://coinbase.com/checkouts/9ef59f5479eec1d97d63382c9ebcb93a "Donate once-off to this project using BitCoin")
-[![Wishlist browse button](https://img.shields.io/badge/wishlist-donate-yellow.svg)](http://amzn.com/w/2F8TXKSNAFG4V "Buy an item on our wishlist for us")
+<span class="badge-travisci"><a href="http://travis-ci.org/bevry/getrepos" title="Check this project's build status on TravisCI"><img src="https://img.shields.io/travis/bevry/getrepos/master.svg" alt="Travis CI Build Status" /></a></span>
+<span class="badge-npmversion"><a href="https://npmjs.org/package/getrepos" title="View this project on NPM"><img src="https://img.shields.io/npm/v/getrepos.svg" alt="NPM version" /></a></span>
+<span class="badge-npmdownloads"><a href="https://npmjs.org/package/getrepos" title="View this project on NPM"><img src="https://img.shields.io/npm/dm/getrepos.svg" alt="NPM downloads" /></a></span>
+<span class="badge-daviddm"><a href="https://david-dm.org/bevry/getrepos" title="View the status of this project's dependencies on DavidDM"><img src="https://img.shields.io/david/bevry/getrepos.svg" alt="Dependency Status" /></a></span>
+<span class="badge-daviddmdev"><a href="https://david-dm.org/bevry/getrepos#info=devDependencies" title="View the status of this project's development dependencies on DavidDM"><img src="https://img.shields.io/david/dev/bevry/getrepos.svg" alt="Dev Dependency Status" /></a></span>
+<br class="badge-separator" />
+<span class="badge-patreon"><a href="https://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a></span>
+<span class="badge-opencollective"><a href="https://opencollective.com/bevry" title="Donate to this project using Open Collective"><img src="https://img.shields.io/badge/open%20collective-donate-yellow.svg" alt="Open Collective donate button" /></a></span>
+<span class="badge-gratipay"><a href="https://www.gratipay.com/bevry" title="Donate weekly to this project using Gratipay"><img src="https://img.shields.io/badge/gratipay-donate-yellow.svg" alt="Gratipay donate button" /></a></span>
+<span class="badge-flattr"><a href="https://flattr.com/profile/balupton" title="Donate to this project using Flattr"><img src="https://img.shields.io/badge/flattr-donate-yellow.svg" alt="Flattr donate button" /></a></span>
+<span class="badge-paypal"><a href="https://bevry.me/paypal" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a></span>
+<span class="badge-bitcoin"><a href="https://bevry.me/bitcoin" title="Donate once-off to this project using Bitcoin"><img src="https://img.shields.io/badge/bitcoin-donate-yellow.svg" alt="Bitcoin donate button" /></a></span>
+<span class="badge-wishlist"><a href="https://bevry.me/wishlist" title="Buy an item on our wishlist for us"><img src="https://img.shields.io/badge/wishlist-donate-yellow.svg" alt="Wishlist browse button" /></a></span>
+<br class="badge-separator" />
+<span class="badge-slackin"><a href="https://slack.bevry.me" title="Join this project's slack community"><img src="https://slack.bevry.me/badge.svg" alt="Slack community badge" /></a></span>
 
@@ -35,8 +39,18 @@ <!-- /BADGES -->
 
-## Install
+<h2>Install</h2>
 
-### [NPM](http://npmjs.org/)
-- Use: `require('getrepos')`
-- Install: `npm install --save getrepos`
+<a href="https://npmjs.com" title="npm is a package manager for javascript"><h3>NPM</h3></a><ul>
+<li>Install: <code>npm install --save getrepos</code></li>
+<li>Module: <code>require('getrepos')</code></li></ul>
 
+<h3><a href="https://github.com/bevry/editions" title="Editions are the best way to produce and consume packages you care about.">Editions</a></h3>
+
+<p>This package is published with the following editions:</p>
+
+<ul><li><code>getrepos</code> aliases <code>getrepos/index.js</code> which uses <a href="https://github.com/bevry/editions" title="Editions are the best way to produce and consume packages you care about.">Editions</a> to automatically select the correct edition for the consumers environment</li>
+<li><code>getrepos/source/index.js</code> is Source + <a href="https://babeljs.io/docs/learn-es2015/" title="ECMAScript Next">ESNext</a> + <a href="https://nodejs.org/dist/latest-v5.x/docs/api/modules.html" title="Node/CJS Modules">Require</a></li>
+<li><code>getrepos/es2015/index.js</code> is <a href="https://babeljs.io" title="The compiler for writing next generation JavaScript">Babel</a> Compiled + <a href="http://babeljs.io/docs/plugins/preset-es2015/" title="ECMAScript 2015">ES2015</a> + <a href="https://nodejs.org/dist/latest-v5.x/docs/api/modules.html" title="Node/CJS Modules">Require</a></li></ul>
+
+<p>Older environments may need <a href="https://babeljs.io/docs/usage/polyfill/" title="A polyfill that emulates missing ECMAScript environment features">Babel's Polyfill</a> or something similar.</p>
+
 <!-- /INSTALL -->
@@ -74,5 +88,6 @@
 
-## History
-[Discover the change history by heading on over to the `HISTORY.md` file.](https://github.com/bevry/getrepos/blob/master/HISTORY.md#files)
+<h2>History</h2>
 
+<a href="https://github.com/bevry/getrepos/blob/master/HISTORY.md#files">Discover the release history by heading on over to the <code>HISTORY.md</code> file.</a>
+
 <!-- /HISTORY -->
@@ -83,5 +98,5 @@
 
-## Contribute
+<h2>Contribute</h2>
 
-[Discover how you can contribute by heading on over to the `CONTRIBUTING.md` file.](https://github.com/bevry/getrepos/blob/master/CONTRIBUTING.md#files)
+<a href="https://github.com/bevry/getrepos/blob/master/CONTRIBUTING.md#files">Discover how you can contribute by heading on over to the <code>CONTRIBUTING.md</code> file.</a>
 
@@ -93,27 +108,29 @@ <!-- /CONTRIBUTE -->
 
-## Backers
+<h2>Backers</h2>
 
-### Maintainers
+<h3>Maintainers</h3>
 
 These amazing people are maintaining this project:
 
-- Benjamin Lupton <[e-mail]> (https://github.com/balupton)
+<ul><li><a href="http://balupton.com">Benjamin Lupton</a> — <a href="https://github.com/bevry/getrepos/commits?author=balupton" title="View the GitHub contributions of Benjamin Lupton on repository bevry/getrepos">view contributions</a></li></ul>
 
-### Sponsors
+<h3>Sponsors</h3>
 
 No sponsors yet! Will you be the first?
 
-[![Gratipay donate button](https://img.shields.io/gratipay/bevry.svg)](https://www.gratipay.com/bevry/ "Donate weekly to this project using Gratipay")
-[![Flattr donate button](https://img.shields.io/badge/flattr-donate-yellow.svg)](http://flattr.com/thing/344188/balupton-on-Flattr "Donate monthly to this project using Flattr")
-[![PayPayl donate button](https://img.shields.io/badge/paypal-donate-yellow.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=QB8GQPZAH84N6 "Donate once-off to this project using Paypal")
-[![BitCoin donate button](https://img.shields.io/badge/bitcoin-donate-yellow.svg)](https://coinbase.com/checkouts/9ef59f5479eec1d97d63382c9ebcb93a "Donate once-off to this project using BitCoin")
-[![Wishlist browse button](https://img.shields.io/badge/wishlist-donate-yellow.svg)](http://amzn.com/w/2F8TXKSNAFG4V "Buy an item on our wishlist for us")
+<span class="badge-patreon"><a href="https://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a></span>
+<span class="badge-opencollective"><a href="https://opencollective.com/bevry" title="Donate to this project using Open Collective"><img src="https://img.shields.io/badge/open%20collective-donate-yellow.svg" alt="Open Collective donate button" /></a></span>
+<span class="badge-gratipay"><a href="https://www.gratipay.com/bevry" title="Donate weekly to this project using Gratipay"><img src="https://img.shields.io/badge/gratipay-donate-yellow.svg" alt="Gratipay donate button" /></a></span>
+<span class="badge-flattr"><a href="https://flattr.com/profile/balupton" title="Donate to this project using Flattr"><img src="https://img.shields.io/badge/flattr-donate-yellow.svg" alt="Flattr donate button" /></a></span>
+<span class="badge-paypal"><a href="https://bevry.me/paypal" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a></span>
+<span class="badge-bitcoin"><a href="https://bevry.me/bitcoin" title="Donate once-off to this project using Bitcoin"><img src="https://img.shields.io/badge/bitcoin-donate-yellow.svg" alt="Bitcoin donate button" /></a></span>
+<span class="badge-wishlist"><a href="https://bevry.me/wishlist" title="Buy an item on our wishlist for us"><img src="https://img.shields.io/badge/wishlist-donate-yellow.svg" alt="Wishlist browse button" /></a></span>
 
-### Contributors
+<h3>Contributors</h3>
 
 These amazing people have contributed code to this project:
 
-- [Benjamin Lupton](https://github.com/balupton) <[e-mail]> — [view contributions](https://github.com/bevry/getrepos/commits?author=balupton)
+<ul><li><a href="http://balupton.com">Benjamin Lupton</a> — <a href="https://github.com/bevry/getrepos/commits?author=balupton" title="View the GitHub contributions of Benjamin Lupton on repository bevry/getrepos">view contributions</a></li></ul>
 
-[Become a contributor!](https://github.com/bevry/getrepos/blob/master/CONTRIBUTING.md#files)
+<a href="https://github.com/bevry/getrepos/blob/master/CONTRIBUTING.md#files">Discover how you can contribute by heading on over to the <code>CONTRIBUTING.md</code> file.</a>
 
@@ -125,10 +142,12 @@ <!-- /BACKERS -->
 
-## License
+<h2>License</h2>
 
-Licensed under the incredibly [permissive](http://en.wikipedia.org/wiki/Permissive_free_software_licence) [MIT license](http://creativecommons.org/licenses/MIT/)
+Unless stated otherwise all works are:
 
-Copyright &copy; 2013+ Bevry Pty Ltd <[e-mail]> (http://bevry.me)
+<ul><li>Copyright &copy; 2013+ <a href="http://bevry.me">Bevry Pty Ltd</a></li></ul>
 
-<!-- /LICENSE -->
+and licensed under:
 
+<ul><li><a href="http://spdx.org/licenses/MIT.html">MIT License</a></li></ul>
 
+<!-- /LICENSE -->

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

38141

increased by134.45%

Number of package files

8

increased by33.33%

Lines of code

716

increased by200.84%

Number of lines in readme file

148

increased by14.73%

Worsened metrics

Dependency count

5

increased by25%

Dev dependency count

8

increased by60%

Number of low supply chain risk alerts

4

increased by100%

Number of medium supply chain risk alerts

2

increased byInfinity%

Dependency changes

• + Addededitions@^1.3.3

• + Addedsafeps@6.4.0(transitive)

• - Removedambi@2.5.0(transitive)

• - Removedcsextends@1.2.0(transitive)

• - Removedextendr@2.1.0(transitive)

• - Removedtaskgroup@4.3.1(transitive)

• - Removedtypechecker@2.0.82.1.0(transitive)

• Updatedextendr@^3.2.2

• Updatedfeedr@^2.13.3

• Updatedtaskgroup@^5.0.1

• Updatedtypechecker@^4.4.1