getrepos - npm Package Compare versions

Comparing version 2.0.1 to 3.0.0-next.1576453449.742e870cfdb977f57aa201a746e9b62a06753f4e

HISTORY.md

 # History
 
+## v3.0.0 2019 December 16
+
+-   Rewrote in TypeScript
+-   API now uses Promises instead of Errbacks
+
 ## v2.0.1 2019 December 9
@@ -4,0 +9,0 @@

package.json

 {
+  "title": "Get Repositories",
   "name": "getrepos",
-  "version": "2.0.1",
+  "version": "3.0.0-next.1576453449.742e870cfdb977f57aa201a746e9b62a06753f4e",
   "description": "Fetch the specified repositories, or those that match a particular github user or search query",
@@ -8,11 +9,72 @@ "homepage": "https://github.com/bevry/getrepos",
   "keywords": [
-    "repositories",
-    "package.json",
+    "all github repos",
+    "all github repositories",
+    "all-repos",
+    "all",
+    "allpublic",
+    "api",
+    "cli",
+    "fetch",
+    "get-repos",
+    "get-repositories",
+    "get",
+    "gh-repos",
+    "gh",
+    "ghapi",
+    "git-getter",
+    "git",
+    "github repos",
+    "github repositories",
+    "github-client",
+    "github-org-repos",
+    "github-owner-repos",
+    "github-repositories",
+    "github-user-repos",
     "github",
+    "list",
+    "maintainers",
+    "meta",
+    "module",
+    "node",
+    "org-github-repositories",
+    "org-repos",
+    "org-repositories",
+    "org",
+    "organisation-github-repositories",
+    "organisation-repositories",
     "organisation",
+    "organisations",
+    "organization-github-repositories",
+    "organization-repositories",
     "organization",
+    "organizations",
+    "orgs",
+    "owner-github-repositories",
+    "owner-repositories",
+    "owner",
+    "owners",
+    "paginate",
+    "paginated",
+    "private",
+    "promise",
+    "promises",
+    "public",
+    "repo",
+    "repos",
+    "repositories",
+    "repository",
+    "request",
+    "retrieve",
+    "search",
+    "stars",
+    "typed",
+    "types",
+    "typescript",
+    "user-github-repositories",
+    "user-repos",
+    "user-repositories",
+    "user",
     "users",
-    "owners",
-    "maintainers",
-    "github-client"
+    "util",
+    "utility"
   ],
@@ -46,4 +108,3 @@ "badges": {
       "paypalURL": "https://bevry.me/paypal",
-      "wishlistURL": "https://bevry.me/wishlist",
-      "travisTLD": "com"
+      "wishlistURL": "https://bevry.me/wishlist"
     }
@@ -72,7 +133,30 @@ },
     {
-      "description": "esnext source code with require for modules",
+      "description": "typescript source code with import for modules",
       "directory": "source",
+      "entry": "index.ts",
+      "tags": [
+        "typescript",
+        "import"
+      ],
+      "engines": false
+    },
+    {
+      "description": "typescript compiled against ESNext for web browsers with import for modules",
+      "directory": "edition-browsers",
       "entry": "index.js",
       "tags": [
         "javascript",
+        "import"
+      ],
+      "engines": {
+        "node": false,
+        "browsers": "defaults"
+      }
+    },
+    {
+      "description": "typescript compiled against ESNext for Node.js with require for modules",
+      "directory": "edition-esnext",
+      "entry": "index.js",
+      "tags": [
+        "javascript",
         "esnext",
@@ -82,35 +166,42 @@ "require"
       "engines": {
-        "node": "8 || 10 || 12"
+        "node": "8 || 10 || 12 || 13",
+        "browsers": false
       }
     }
   ],
+  "types": "source/index.ts",
   "type": "commonjs",
-  "main": "source/index.js",
+  "main": "edition-esnext/index.js",
+  "browser": "edition-browsers/index.js",
+  "module": "edition-browsers/index.js",
   "dependencies": {
-    "feedr": "^4.7.0",
-    "githubauthquerystring": "^2.2.0",
-    "taskgroup": "^6.4.0",
-    "typechecker": "^6.2.0"
+    "cross-fetch": "^3.0.4",
+    "githubauthquerystring": "^2.3.0"
   },
   "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "^2.11.0",
+    "@typescript-eslint/parser": "^2.11.0",
     "assert-helpers": "^5.8.0",
     "eslint": "^6.7.2",
-    "eslint-config-bevry": "^2.2.0",
+    "eslint-config-bevry": "^2.3.0",
     "eslint-config-prettier": "^6.7.0",
-    "eslint-plugin-prettier": "^3.1.1",
-    "jsdoc": "^3.6.3",
-    "kava": "^4.3.0",
-    "minami": "^1.2.3",
+    "eslint-plugin-prettier": "^3.1.2",
+    "kava": "^4.4.0",
     "prettier": "^1.19.1",
-    "projectz": "^1.15.0",
+    "projectz": "^1.16.0",
+    "simplytyped": "^3.2.3",
     "surge": "^0.21.3",
-    "valid-directory": "^1.5.0"
+    "typedoc": "^0.15.4",
+    "typescript": "^3.7.3",
+    "valid-directory": "^1.6.0"
   },
   "scripts": {
     "our:clean": "rm -Rf ./docs ./edition* ./es2015 ./es5 ./out ./.next",
-    "our:compile": "echo no need for this project",
+    "our:compile": "npm run our:compile:edition-browsers && npm run our:compile:edition-esnext",
+    "our:compile:edition-browsers": "tsc --module ESNext --target ESNext --outDir ./edition-browsers --project tsconfig.json && test -d edition-browsers/source && ( mv edition-browsers/source edition-temp && rm -Rf edition-browsers && mv edition-temp edition-browsers ) || true",
+    "our:compile:edition-esnext": "tsc --module commonjs --target ESNext --outDir ./edition-esnext --project tsconfig.json && test -d edition-esnext/source && ( mv edition-esnext/source edition-temp && rm -Rf edition-esnext && mv edition-temp edition-esnext ) || true",
     "our:deploy": "echo no need for this project",
     "our:meta": "npm run our:meta:docs && npm run our:meta:projectz",
-    "our:meta:docs": "npm run our:meta:docs:jsdoc",
-    "our:meta:docs:jsdoc": "rm -Rf ./docs && jsdoc --recurse --pedantic --access all --destination ./docs --package ./package.json --readme ./README.md --template ./node_modules/minami ./source && mv ./docs/$npm_package_name/$npm_package_version/* ./docs/ && rm -Rf ./docs/$npm_package_name/$npm_package_version",
+    "our:meta:docs": "npm run our:meta:docs:typedoc",
+    "our:meta:docs:typedoc": "rm -Rf ./docs && typedoc --mode file --exclude '**/+(*test*|node_modules)' --excludeExternals --name \"$npm_package_name\" --readme ./README.md --out ./docs ./source",
     "our:meta:projectz": "projectz compile",
@@ -126,7 +217,8 @@ "our:release": "npm run our:release:prepare && npm run our:release:check-changelog && npm run our:release:check-dirty && npm run our:release:tag && npm run our:release:push",
     "our:test": "npm run our:verify && npm test",
-    "our:verify": "npm run our:verify:directory && npm run our:verify:eslint && npm run our:verify:prettier",
+    "our:verify": "npm run our:verify:directory && npm run our:verify:eslint && npm run our:verify:prettier && npm run our:verify:typescript",
     "our:verify:directory": "npx valid-directory",
     "our:verify:eslint": "eslint --fix --ignore-pattern '**/*.d.ts' --ignore-pattern '**/vendor/' --ignore-pattern '**/node_modules/' --ext .mjs,.js,.jsx,.ts,.tsx ./source",
     "our:verify:prettier": "prettier --write ./source/**",
-    "test": "node ./source/test.js"
+    "our:verify:typescript": "tsc --noEmit --project tsconfig.json",
+    "test": "node ./edition-esnext/test.js"
   },
@@ -133,0 +225,0 @@ "eslintConfig": {

README.md

 <!-- TITLE/ -->
 
-<h1>getrepos</h1>
+<h1>Get Repositories</h1>
 
@@ -10,3 +10,3 @@ <!-- /TITLE -->
 
-<span class="badge-travisci"><a href="http://travis-ci.com/bevry/getrepos" title="Check this project's build status on TravisCI"><img src="https://img.shields.io/travis/com/bevry/getrepos/master.svg" alt="Travis CI Build Status" /></a></span>
+<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>
@@ -47,2 +47,10 @@ <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>
 
+<a href="https://jspm.io" title="Native ES Modules CDN"><h3>jspm</h3></a>
+
+``` html
+<script type="module">
+    import * as pkg from '//dev.jspm.io/getrepos'
+</script>
+```
+
 <h3><a href="https://editions.bevry.me" title="Editions are the best way to produce and consume packages you care about.">Editions</a></h3>
@@ -52,19 +60,9 @@
 
-<ul><li><code>getrepos</code> aliases <code>getrepos/source/index.js</code></li>
-<li><code>getrepos/source/index.js</code> is esnext source code with require for modules</li></ul>
+<ul><li><code>getrepos/source/index.ts</code> is typescript source code with import for modules</li>
+<li><code>getrepos/edition-browsers/index.js</code> is typescript compiled against <a href="https://babeljs.io/docs/learn-es2015/" title="ECMAScript Next">ESNext</a> for web browsers with import for modules</li>
+<li><code>getrepos</code> aliases <code>getrepos/edition-esnext/index.js</code></li>
+<li><code>getrepos/edition-esnext/index.js</code> is typescript compiled against <a href="https://babeljs.io/docs/learn-es2015/" title="ECMAScript Next">ESNext</a> for Node.js with require for modules</li></ul>
 
 <p>Environments older than Node.js v8 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>
 
-<h3><a href="https://www.typescriptlang.org/" title="TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. ">TypeScript</a></h3>
-
-This project provides its type information via inline <a href="http://usejsdoc.org" title="JSDoc is an API documentation generator for JavaScript, similar to Javadoc or phpDocumentor">JSDoc Comments</a>. To make use of this in <a href="https://www.typescriptlang.org/" title="TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. ">TypeScript</a>, set your <code>maxNodeModuleJsDepth</code> compiler option to `5` or thereabouts. You can accomlish this via your `tsconfig.json` file like so:
-
-``` json
-{
-  "compilerOptions": {
-    "maxNodeModuleJsDepth": 5
-  }
-}
-```
-
 <!-- /INSTALL -->
@@ -78,19 +76,24 @@
 ```javascript
-// Create our getrepos instance
-var getter = require('getrepos').create({
-    log: console.log // optional, arguments: level, message...
-})
+import {
+    fetchRepo,
+    fetchRepos,
+    fetchReposFromSearch,
+    fetchReposFromUsers
+} from 'getrepos'
 
-// Fetch the data on these github repositories
-getter.fetchRepos(['bevry/getrepos'], function(err) {
-    console.log(err)
+// https://developer.github.com/v3/repos/#get
+fetchRepo('bevry/getrepos')
+    .then(console.log)
+    .catch(console.error)
+fetchRepos(['bevry/getrepos'])
+    .then(console.log)
+    .catch(console.error)
 
-    // Fetch all the repo data on these github users/organisations
-    getter.fetchReposFromUsers(['bevry'], function(err) {
-        console.log(err)
-
-        // Get the combined listing
-        console.log(getter.getRepos())
-    })
-})
+// https://developer.github.com/v3/search/#search-repositories
+fetchReposFromSearch('@bevry', { pages: 0 })
+    .then(console.log)
+    .catch(console.error)
+fetchReposFromUsers(['bevry'], { pages: 0 })
+    .then(console.log)
+    .catch(console.error)
 ```
@@ -97,0 +100,0 @@

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

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

35355

increased by27.55%

Dependency count

2

decreased by-50%

Number of package files

11

increased by57.14%

Lines of code

473

increased by39.94%

Number of lines in readme file

164

increased by1.86%

Worsened metrics

Dev dependency count

15

increased by25%

Number of low quality alerts

1

increased byInfinity%

Number of low supply chain risk alerts

2

increased by100%

Number of medium supply chain risk alerts

3

increased byInfinity%

Dependency changes

• + Addedcross-fetch@^3.0.4

• + Addedcross-fetch@3.2.0(transitive)

• + Addednode-fetch@2.7.0(transitive)

• + Addedtr46@0.0.3(transitive)

• + Addedwebidl-conversions@3.0.1(transitive)

• + Addedwhatwg-url@5.0.0(transitive)

• - Removedfeedr@^4.7.0

• - Removedtaskgroup@^6.4.0

• - Removedtypechecker@^6.2.0

• - Removedajv@6.12.6(transitive)

• - Removedambi@3.2.0(transitive)

• - Removedargparse@1.0.10(transitive)

• - Removedasn1@0.2.6(transitive)

• - Removedassert-plus@1.0.0(transitive)

• - Removedasynckit@0.4.0(transitive)

• - Removedaws-sign2@0.7.0(transitive)

• - Removedaws4@1.13.2(transitive)

• - Removedbcrypt-pbkdf@1.0.2(transitive)

• - Removedbinaryextensions@2.3.0(transitive)

• - Removedcaseless@0.12.0(transitive)

• - Removedcoffeescript@1.12.72.7.0(transitive)

• - Removedcombined-stream@1.0.8(transitive)

• - Removedcore-util-is@1.0.2(transitive)

• - Removedcson@6.9.0(transitive)

• - Removedcson-parser@4.0.9(transitive)

• - Removeddashdash@1.14.1(transitive)

• - Removeddelayed-stream@1.0.0(transitive)

• - Removedeachr@4.5.0(transitive)

• - Removedecc-jsbn@0.1.2(transitive)

• - Removededitions@2.3.1(transitive)

• - Removederrlop@2.2.0(transitive)

• - Removedesprima@4.0.1(transitive)

• - Removedextend@3.0.2(transitive)

• - Removedextendr@4.3.0(transitive)

• - Removedextract-opts@4.3.0(transitive)

• - Removedextsprintf@1.3.0(transitive)

• - Removedfast-deep-equal@3.1.3(transitive)

• - Removedfast-json-stable-stringify@2.1.0(transitive)

• - Removedfeedr@4.8.0(transitive)

• - Removedforever-agent@0.6.1(transitive)

• - Removedform-data@2.3.3(transitive)

• - Removedget-port@5.1.1(transitive)

• - Removedgetpass@0.1.7(transitive)

• - Removedgraceful-fs@4.2.11(transitive)

• - Removedhar-schema@2.0.0(transitive)

• - Removedhar-validator@5.1.5(transitive)

• - Removedhttp-signature@1.2.0(transitive)

• - Removedis-typedarray@1.0.0(transitive)

• - Removedisstream@0.1.2(transitive)

• - Removedistextorbinary@3.3.0(transitive)

• - Removedjs-yaml@3.14.1(transitive)

• - Removedjsbn@0.1.1(transitive)

• - Removedjson-schema@0.4.0(transitive)

• - Removedjson-schema-traverse@0.4.1(transitive)

• - Removedjson-stringify-safe@5.0.1(transitive)

• - Removedjsprim@1.4.2(transitive)

• - Removedmime-db@1.52.0(transitive)

• - Removedmime-types@2.1.35(transitive)

• - Removedoauth-sign@0.9.0(transitive)

• - Removedperformance-now@2.1.0(transitive)

• - Removedpsl@1.15.0(transitive)

• - Removedpunycode@2.3.1(transitive)

• - Removedqs@6.5.3(transitive)

• - Removedrequest@2.88.2(transitive)

• - Removedrequirefresh@3.3.0(transitive)

• - Removedsafe-buffer@5.2.1(transitive)

• - Removedsafefs@5.5.0(transitive)

• - Removedsafeps@9.3.0(transitive)

• - Removedsafer-buffer@2.1.2(transitive)

• - Removedsax@1.4.1(transitive)

• - Removedsemver@6.3.1(transitive)

• - Removedsprintf-js@1.0.3(transitive)

• - Removedsshpk@1.18.0(transitive)

• - Removedtaskgroup@6.5.0(transitive)

• - Removedtextextensions@3.3.0(transitive)

• - Removedtough-cookie@2.5.0(transitive)

• - Removedtunnel-agent@0.6.0(transitive)

• - Removedtweetnacl@0.14.5(transitive)

• - Removedtypechecker@4.11.06.4.0(transitive)

• - Removedunbounded@2.3.0(transitive)

• - Removeduri-js@4.4.1(transitive)

• - Removeduuid@3.4.0(transitive)

• - Removedverror@1.10.0(transitive)

• - Removedxml2js@0.4.23(transitive)

• - Removedxmlbuilder@11.0.1(transitive)

• Updatedgithubauthquerystring@^2.3.0