jose-simple - npm Package Compare versions

Comparing version 1.2.1 to 1.2.2

CONTRIBUTING.md

@@ -49,3 +49,3 @@ # How to contribute to the jose-simple project
 
-It's basically the same process but use the word `hotfix` or `support` instead of `feature`.  `git flow` knows what to do. Just keep in mind that any changes are going to happen to your fork, and not the upstream repo. If you need to merge a `hotfix` into upstream master you may only do it va a reviewed pull request.
+It's basically the same process but use the word `hotfix` or `support` instead of `feature`. `git flow` knows what to do. Just keep in mind that any changes are going to happen to your fork, and not the upstream repo. If you need to merge a `hotfix` into upstream master you may only do it va a reviewed pull request.
 
@@ -60,3 +60,3 @@ ### Releasing to production
 
-Note you will **never** push changes directly to the upstream project, *only to your own fork*. 
+Note you will **never** push changes directly to the upstream project, _only to your own fork_.
 
@@ -77,3 +77,3 @@ **Changes may only be introduced into the upstream project via a properly reviewed pull request.**
 
-When commiting something use the `-m` flag to add a short commit message of the format `{issue number} summary of what you changed`.  So for example if you are working on issue `ABC-1` and you added a method to the `aardvark_controller` you might use the following commit message `"ABC-1 added anteater method to aardvark controller"`
+When commiting something use the `-m` flag to add a short commit message of the format `{issue number} summary of what you changed`. So for example if you are working on issue `ABC-1` and you added a method to the `aardvark_controller` you might use the following commit message `"ABC-1 added anteater method to aardvark controller"`
 
@@ -86,8 +86,8 @@ Commit messages ought to be in the past tense.
 
-Pull requests must be named as follows `[issue type, issue number] high level description of change`.  The following Issue Types are recognised
+Pull requests must be named as follows `[issue type, issue number] high level description of change`. The following Issue Types are recognised
 
-* `Bug Fix` - the change fixes a bug
-* `Feature` - the change adds a new feature (the usual issue type)
-* `Documentation` — The change is a documentation only change
-* `Optimisation` - The change is an optimisation of the code base without any functional changes
+- `Bug Fix` - the change fixes a bug
+- `Feature` - the change adds a new feature (the usual issue type)
+- `Documentation` — The change is a documentation only change
+- `Optimisation` - The change is an optimisation of the code base without any functional changes
 
@@ -94,0 +94,0 @@ If your change does not fit any of these categories, use `Feature`. Likewise if your change is not tied to an issue number you may use `n/a` instead.

package.json

 {
   "name": "jose-simple",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "description": "Simplifies JOSE encryption and decription.",
@@ -19,29 +19,5 @@ "engines": {
     "lint": "eslint .",
-    "prettier": "prettier --single-quote --no-semi --write '**/*.{js,json}'",
+    "prettier": "prettier --write '**/*.{js,json,md}'",
     "test:unit:cov": "find ./test/unit -name '*.test.js' | NODE_ENV=test xargs nyc mocha --require ./test/unit/testHelper.js"
   },
-  "lint-staged": {
-    "**/*.{js,json}": [
-      "prettier --single-quote --no-semi --write",
-      "git add"
-    ]
-  },
-  "nyc": {
-    "check-coverage": true,
-    "per-file": true,
-    "lines": 100,
-    "statements": 100,
-    "functions": 100,
-    "branches": 100,
-    "include": [
-      "src/**/*.js"
-    ],
-    "exclude": [],
-    "reporter": [
-      "lcov",
-      "text"
-    ],
-    "all": true,
-    "cache": true
-  },
   "keywords": [
@@ -66,23 +42,52 @@ "jose",
     "chai-as-promised": "^7.1.1",
-    "eslint": "^5.13.0",
-    "eslint-config-prettier": "^3.6.0",
+    "eslint": "^5.16.0",
+    "eslint-config-prettier": "^4.1.0",
     "eslint-config-standard": "^12.0.0",
     "eslint-plugin-import": "^2.16.0",
-    "eslint-plugin-mocha": "^5.2.1",
+    "eslint-plugin-mocha": "^5.3.0",
     "eslint-plugin-node": "^8.0.1",
     "eslint-plugin-prettier": "^3.0.1",
-    "eslint-plugin-promise": "^4.0.1",
+    "eslint-plugin-promise": "^4.1.1",
     "eslint-plugin-standard": "^4.0.0",
     "faker": "^4.1.0",
     "husky": "^1.3.1",
-    "lint-staged": "^8.1.3",
-    "mocha": "^5.2.0",
-    "nyc": "^13.2.0",
+    "lint-staged": "^8.1.5",
+    "mocha": "^6.1.1",
+    "nyc": "^13.3.0",
     "prettier": "^1.16.4",
-    "sinon": "^7.2.3",
+    "sinon": "^7.3.1",
     "sinon-chai": "^3.3.0"
   },
   "dependencies": {
-    "node-jose": "^1.1.1"
+    "node-jose": "^1.1.3"
   },
+  "prettier": {
+    "semi": false,
+    "singleQuote": true,
+    "proseWrap": "never"
+  },
+  "lint-staged": {
+    "**/*.{js,json,md}": [
+      "prettier --write",
+      "git add"
+    ]
+  },
+  "nyc": {
+    "check-coverage": true,
+    "per-file": true,
+    "lines": 100,
+    "statements": 100,
+    "functions": 100,
+    "branches": 100,
+    "include": [
+      "src/**/*.js"
+    ],
+    "exclude": [],
+    "reporter": [
+      "lcov",
+      "text"
+    ],
+    "all": true,
+    "cache": true
+  },
   "greenkeeper": {
@@ -89,0 +94,0 @@ "ignore": []

README.md

@@ -11,7 +11,7 @@ ## jose-simple
 
-* The project depends on [`node-jose`](https://github.com/cisco/node-jose) by Cisco.
-* `node-jose` [does not allow you to use private keys with passwords](https://github.com/cisco/node-jose/issues/69#issuecomment-236133179), and [they have no intention of changing that](https://github.com/cisco/node-jose/issues/234#issuecomment-457615794).
-* **Requires Node 10.12.0 or better** if you want to run the tests.
-Works fine under Node 11.9+, and might run under versions of node going back to 8.x but no further.
+- The project depends on [`node-jose`](https://github.com/cisco/node-jose) by Cisco.
+- `node-jose` [does not allow you to use private keys with passwords](https://github.com/cisco/node-jose/issues/69#issuecomment-236133179), and [they have no intention of changing that](https://github.com/cisco/node-jose/issues/234#issuecomment-457615794).
+- **Requires Node 10.12.0 or better** if you want to run the tests. Works fine under Node 11.13+, and might run under versions of node going back to 8.x but no further.
 
+<!-- prettier-ignore -->
 | Branch | Status | Coverage | Comment |
@@ -22,5 +22,9 @@ | ------ | ------ | -------- | ------- |
 
+[![NPM](https://nodei.co/npm/jose-simple.png)](https://nodei.co/npm/jose-simple/)
+
 ## Installation
 
-    npm install jose-simple
+```
+npm install jose-simple
+```
 
@@ -57,3 +61,3 @@ ## Useage
 
-See [encrypt.js#L661](https://github.com/cisco/node-jose/blob/master/lib/jwe/encrypt.js#L661)
+See [`encrypt.js#L662`](https://github.com/cisco/node-jose/blob/master/lib/jwe/encrypt.js#L662)
 
@@ -75,7 +79,7 @@ You can add `encrypt` options as follows:
 
-* [NodeJS](https://nodejs.org) — Version `10.12.0` or better is needed to run the tests as they rely on `crypto.generateKeyPair`.
+- [NodeJS](https://nodejs.org) — Version `10.12.0` or better is needed to run the tests as they rely on `crypto.generateKeyPair`.
 
 ### Test it
 
-* `npm test` — runs the unit tests.  The tests give an example of how to create key pairs too. (Leverages the [`crypto.generateKeyPair`](https://nodejs.org/dist/latest-v10.x/docs/api/crypto.html#crypto_crypto_generatekeypair_type_options_callback) libraries introduced in Node `10.12.0`.)
+- `npm test` — runs the unit tests. The tests give an example of how to create key pairs too. (Leverages the [`crypto.generateKeyPair`](https://nodejs.org/dist/latest-v10.x/docs/api/crypto.html#crypto_crypto_generatekeypair_type_options_callback) libraries introduced in Node `10.12.0`.)
 
@@ -82,0 +86,0 @@ ### Lint it

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

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

Improved metrics

Total package byte prevSize

199902

increased by10.28%

Lines of code

5442

increased by9.32%

Number of lines in readme file

91

increased by4.6%

Number of medium supply chain risk alerts

0

decreased by-100%

Dependency changes

• Updatednode-jose@^1.1.3