githubauthquerystring - npm Package Compare versions

Comparing version 1.0.2 to 1.1.0-next.1573203144.7245ff499373378ea403edadf5cb5872e1a92658

HISTORY.md

 # History
 
+## v1.1.0 2019 November 8
+
+-   Updated [base files](https://github.com/bevry/base) and [editions](https://editions.bevry.me) using [boundation](https://github.com/bevry/boundation)
+
 ## v1.0.2 2018 November 15
-- Fixed documentation link
 
+-   Fixed documentation link
+
 ## v1.0.1 2018 November 15
-- Update engines to reflect lack of Node v4 compatibility
 
+-   Update engines to reflect lack of Node v4 compatibility
+
 ## v1.0.0 2018 November 15
-- Initial working version
+
+-   Initial working version

LICENSE.md

@@ -18,3 +18,3 @@ <!-- LICENSEFILE/ -->
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.
 
@@ -21,0 +21,0 @@ 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.

package.json

 {
   "name": "githubauthquerystring",
-  "version": "1.0.2",
+  "version": "1.1.0-next.1573203144.7245ff499373378ea403edadf5cb5872e1a92658",
   "description": "Authorise GitHub API requests by appending the environments auth credentials to your request's query string.",
@@ -24,4 +24,2 @@ "homepage": "https://github.com/bevry/githubauthquerystring",
       "liberapay",
-      "thanksapp",
-      "boostlab",
       "buymeacoffee",
@@ -66,6 +64,2 @@ "opencollective",
       "entry": "index.js",
-      "engines": {
-        "node": true,
-        "browsers": false
-      },
       "tags": [
@@ -75,24 +69,31 @@ "javascript",
         "require"
-      ]
+      ],
+      "engines": {
+        "node": "6 || 8 || 10 || 12 || 13",
+        "browsers": false
+      }
     }
   ],
   "main": "source/index.js",
-  "dependencies": {},
   "devDependencies": {
-    "assert-helpers": "^4.5.1",
-    "eslint": "^5.9.0",
-    "joe": "^2.0.2",
-    "joe-reporter-console": "^2.0.2",
-    "jsdoc": "^3.5.5",
+    "assert-helpers": "^4.9.7",
+    "eslint": "^6.6.0",
+    "eslint-config-bevry": "^1.2.1",
+    "eslint-config-prettier": "^6.5.0",
+    "eslint-plugin-prettier": "^3.1.1",
+    "jsdoc": "^3.6.3",
+    "kava": "^3.1.0",
     "minami": "^1.2.3",
-    "projectz": "^1.5.1",
-    "surge": "^0.20.1",
+    "prettier": "^1.18.2",
+    "projectz": "^1.7.5",
+    "surge": "^0.21.3",
     "valid-directory": "^1.0.0"
   },
   "scripts": {
-    "our:clean": "rm -Rf ./docs ./edition* ./es2015 ./es5 ./out",
+    "our:clean": "rm -Rf ./docs ./edition* ./es2015 ./es5 ./out ./.next",
     "our:compile": "echo no need for this project",
     "our:deploy": "echo no need for this project",
     "our:meta": "npm run our:meta:docs && npm run our:meta:projectz",
-    "our:meta:docs": "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: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:projectz": "projectz compile",
@@ -105,10 +106,24 @@ "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: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:setup": "npm run our:setup:npm",
-    "our:setup:npm": "npm install",
+    "our:setup": "npm run our:setup:install",
+    "our:setup:install": "npm install",
     "our:test": "npm run our:verify && npm test",
-    "our:verify": "npm run our:verify:directory && npm run our:verify:eslint",
+    "our:verify": "npm run our:verify:directory && npm run our:verify:eslint && npm run our:verify:prettier",
     "our:verify:directory": "npx valid-directory",
-    "our:verify:eslint": "eslint --fix ./source/**",
-    "test": "node --harmony ./source/test.js --joe-reporter=console"
+    "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"
+  },
+  "eslintConfig": {
+    "extends": [
+      "bevry"
+    ]
+  },
+  "prettier": {
+    "semi": false,
+    "singleQuote": true
+  },
+  "funding": {
+    "type": "cooperative",
+    "url": "https://bevry.me/fund"
   }
 }

README.md

@@ -19,4 +19,2 @@ <!-- TITLE/ -->
 <span class="badge-liberapay"><a href="https://liberapay.com/bevry" title="Donate to this project using Liberapay"><img src="https://img.shields.io/badge/liberapay-donate-yellow.svg" alt="Liberapay donate button" /></a></span>
-<span class="badge-thanksapp"><a href="https://givethanks.app/donate/npm/githubauthquerystring" title="Donate to this project using Thanks App"><img src="https://img.shields.io/badge/thanksapp-donate-yellow.svg" alt="Thanks App donate button" /></a></span>
-<span class="badge-boostlab"><a href="https://boost-lab.app/bevry/githubauthquerystring" title="Donate to this project using Boost Lab"><img src="https://img.shields.io/badge/boostlab-donate-yellow.svg" alt="Boost Lab donate button" /></a></span>
 <span class="badge-buymeacoffee"><a href="https://buymeacoffee.com/balupton" title="Donate to this project using Buy Me A Coffee"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg" alt="Buy Me A Coffee donate button" /></a></span>
@@ -42,7 +40,9 @@ <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>
 
-<a href="https://npmjs.com" title="npm is a package manager for javascript"><h3>NPM</h3></a><ul>
+<a href="https://npmjs.com" title="npm is a package manager for javascript"><h3>npm</h3></a>
+<ul>
 <li>Install: <code>npm install --save githubauthquerystring</code></li>
-<li>Module: <code>require('githubauthquerystring')</code></li></ul>
+<li>Require: <code>require('githubauthquerystring')</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>
+<h3><a href="https://editions.bevry.me" title="Editions are the best way to produce and consume packages you care about.">Editions</a></h3>
 
@@ -54,4 +54,16 @@ <p>This package is published with the following editions:</p>
 
-<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>
+<p>Environments older than Node.js v6 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 -->
@@ -150,4 +162,2 @@
 <span class="badge-liberapay"><a href="https://liberapay.com/bevry" title="Donate to this project using Liberapay"><img src="https://img.shields.io/badge/liberapay-donate-yellow.svg" alt="Liberapay donate button" /></a></span>
-<span class="badge-thanksapp"><a href="https://givethanks.app/donate/npm/githubauthquerystring" title="Donate to this project using Thanks App"><img src="https://img.shields.io/badge/thanksapp-donate-yellow.svg" alt="Thanks App donate button" /></a></span>
-<span class="badge-boostlab"><a href="https://boost-lab.app/bevry/githubauthquerystring" title="Donate to this project using Boost Lab"><img src="https://img.shields.io/badge/boostlab-donate-yellow.svg" alt="Boost Lab donate button" /></a></span>
 <span class="badge-buymeacoffee"><a href="https://buymeacoffee.com/balupton" title="Donate to this project using Buy Me A Coffee"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg" alt="Buy Me A Coffee donate button" /></a></span>
@@ -154,0 +164,0 @@ <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>

source/index.js

@@ -17,12 +17,11 @@ 'use strict'
  */
-function fetchGithubAuthQueryString (opts) {
+function fetchGithubAuthQueryString(opts) {
 	// https://developer.github.com/v3/#authentication
-	const { GITHUB_ACCESS_TOKEN, GITHUB_CLIENT_ID, GITHUB_CLIENT_SECRET } = opts || process.env
+	const { GITHUB_ACCESS_TOKEN, GITHUB_CLIENT_ID, GITHUB_CLIENT_SECRET } =
+		opts || process.env
 	if (GITHUB_ACCESS_TOKEN) {
 		return `access_token=${GITHUB_ACCESS_TOKEN}`
-	}
-	else if (GITHUB_CLIENT_ID && GITHUB_CLIENT_SECRET) {
+	} else if (GITHUB_CLIENT_ID && GITHUB_CLIENT_SECRET) {
 		return `client_id=${GITHUB_CLIENT_ID}&client_secret=${GITHUB_CLIENT_SECRET}`
-	}
-	else {
+	} else {
 		return ''
@@ -37,4 +36,7 @@ }
  */
-function redactGithubAuthQueryString (value) {
-	return value.replace(/(&?)(access_token|client_id|client_secret)=\w+/gi, '$1$2=REDACTED')
+function redactGithubAuthQueryString(value) {
+	return value.replace(
+		/(&?)(access_token|client_id|client_secret)=\w+/gi,
+		'$1$2=REDACTED'
+	)
 }
@@ -41,0 +43,0 @@

New alerts

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

18224

increased by3.94%

Number of package files

6

increased by20%

Lines of code

42

increased by5%

Number of lines in readme file

189

increased by5.59%

Worsened metrics

Dev dependency count

12

increased by33.33%

Number of low quality alerts

1

increased byInfinity%

No dependency changes