jose-simple
Advanced tools
Comparing version 1.3.0 to 1.3.1
@@ -19,3 +19,3 @@ # How to contribute to the jose-simple project | ||
4. Disallow direct pushing to upstream `git remote set-url --push upstream no_push` | ||
5. create a local `master` branch `git checkout -b master` and test it via `git pull upstream master` | ||
5. create a local `main` branch `git checkout -b main` and test it via `git pull upstream main` | ||
6. ensure you have installed the [`git-flow` command line helpers](https://github.com/nvie/gitflow) and [`git-flow-completion` utils](https://github.com/bobthecow/git-flow-completion) then run `git flow init -d`. | ||
@@ -50,3 +50,3 @@ | ||
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 main you may only do it va a reviewed pull request. | ||
@@ -57,5 +57,5 @@ ### Releasing to production | ||
2. commit any changes to version info in `package.json` then `git flow release publish {tag.number}` | ||
3. `git flow release finish {tag.number}` merges the release into `master` of your fork, tags it, merges that back into `develop` on your fork and removes the release branch. | ||
4. Now go back to GitHub and raise a Pull Request to merge the upstream master from your fork's `master` branch. When that goes through you are done. | ||
5. In your command-line go back and clean up any outstanding branches and `git pull upstream` your local `master` and `develop` branches to ensure everything on your local machine is up to date with everyone's changes. | ||
3. `git flow release finish {tag.number}` merges the release into `main` of your fork, tags it, merges that back into `develop` on your fork and removes the release branch. | ||
4. Now go back to GitHub and raise a Pull Request to merge the upstream main from your fork's `main` branch. When that goes through you are done. | ||
5. In your command-line go back and clean up any outstanding branches and `git pull upstream` your local `main` and `develop` branches to ensure everything on your local machine is up to date with everyone's changes. | ||
@@ -62,0 +62,0 @@ Note you will **never** push changes directly to the upstream project, _only to your own fork_. |
{ | ||
"name": "jose-simple", | ||
"version": "1.3.0", | ||
"version": "1.3.1", | ||
"description": "Simplifies JOSE encryption and decryption.", | ||
@@ -31,3 +31,2 @@ "author": "Dave Sag <davesag@gmail.com>", | ||
"test:unit:cov": "NODE_ENV=test nyc mocha ./test/unit/ --require ./test/unitTestHelper.js --recursive", | ||
"test:mutants": "NODE_ENV=test npx stryker run", | ||
"snyk-protect": "snyk protect" | ||
@@ -51,29 +50,24 @@ }, | ||
"dependencies": { | ||
"node-jose": "^2.0.0" | ||
"node-jose": "^2.1.1" | ||
}, | ||
"devDependencies": { | ||
"@stryker-mutator/core": "^3.3.1", | ||
"@stryker-mutator/javascript-mutator": "^3.3.1", | ||
"@stryker-mutator/mocha-framework": "^3.3.1", | ||
"@stryker-mutator/mocha-runner": "^3.3.1", | ||
"chai": "^4.2.0", | ||
"@faker-js/faker": "^7.3.0", | ||
"chai": "^4.3.6", | ||
"chai-as-promised": "^7.1.1", | ||
"eslint": "^7.9.0", | ||
"eslint-config-prettier": "^6.11.0", | ||
"eslint-config-standard": "^14.1.1", | ||
"eslint-plugin-import": "^2.22.0", | ||
"eslint-plugin-mocha": "^8.0.0", | ||
"eslint": "^8.20.0", | ||
"eslint-config-prettier": "^8.5.0", | ||
"eslint-config-standard": "^17.0.0", | ||
"eslint-plugin-import": "^2.26.0", | ||
"eslint-plugin-mocha": "^10.1.0", | ||
"eslint-plugin-node": "^11.1.0", | ||
"eslint-plugin-prettier": "^3.1.4", | ||
"eslint-plugin-promise": "^4.2.1", | ||
"eslint-plugin-standard": "^4.0.1", | ||
"faker": "^5.1.0", | ||
"husky": "^4.3.0", | ||
"lint-staged": "^10.4.0", | ||
"mocha": "^8.1.3", | ||
"eslint-plugin-prettier": "^4.2.1", | ||
"eslint-plugin-promise": "^6.0.0", | ||
"husky": "^8.0.1", | ||
"lint-staged": "^13.0.3", | ||
"mocha": "^10.0.0", | ||
"nyc": "^15.1.0", | ||
"prettier": "^2.1.2", | ||
"sinon": "^9.0.3", | ||
"prettier": "^2.7.1", | ||
"sinon": "^14.0.0", | ||
"sinon-chai": "^3.5.0", | ||
"snyk": "^1.399.1" | ||
"snyk": "^1.981.0" | ||
}, | ||
@@ -93,7 +87,2 @@ "prettier": { | ||
}, | ||
"husky": { | ||
"hooks": { | ||
"pre-commit": "lint-staged" | ||
} | ||
}, | ||
"nyc": { | ||
@@ -100,0 +89,0 @@ "check-coverage": true, |
@@ -1,2 +0,2 @@ | ||
## jose-simple | ||
# jose-simple | ||
@@ -25,3 +25,3 @@ > Proper encryption ought to be simple, and widespread. | ||
## Useage | ||
## Usage | ||
@@ -75,7 +75,7 @@ ```js | ||
| `develop` | [![CircleCI](https://circleci.com/gh/davesag/jose-simple/tree/develop.svg?style=svg)](https://circleci.com/gh/davesag/jose-simple/tree/develop) | [![codecov](https://codecov.io/gh/davesag/jose-simple/branch/develop/graph/badge.svg)](https://codecov.io/gh/davesag/jose-simple) | [![Vulnerabilities](https://snyk.io/test/github/davesag/jose-simple/develop/badge.svg)](https://snyk.io/test/github/davesag/jose-simple/develop) | Work in progress | | ||
| `master` | [![CircleCI](https://circleci.com/gh/davesag/jose-simple/tree/master.svg?style=svg)](https://circleci.com/gh/davesag/jose-simple/tree/master) | [![codecov](https://codecov.io/gh/davesag/jose-simple/branch/master/graph/badge.svg)](https://codecov.io/gh/davesag/jose-simple) | [![Vulnerabilities](https://snyk.io/test/github/davesag/jose-simple/master/badge.svg)](https://snyk.io/test/github/davesag/jose-simple/master) | Latest release | | ||
| `main` | [![CircleCI](https://circleci.com/gh/davesag/jose-simple/tree/main.svg?style=svg)](https://circleci.com/gh/davesag/jose-simple/tree/main) | [![codecov](https://codecov.io/gh/davesag/jose-simple/branch/main/graph/badge.svg)](https://codecov.io/gh/davesag/jose-simple) | [![Vulnerabilities](https://snyk.io/test/github/davesag/jose-simple/main/badge.svg)](https://snyk.io/test/github/davesag/jose-simple/main) | Latest release | | ||
### Prerequisites | ||
- [NodeJS](https://nodejs.org) — Version `10.12.0` or better is needed to run the tests as they rely on `crypto.generateKeyPair`. | ||
- [NodeJS](htps://nodejs.org), I use [`nvm`](https://github.com/creationix/nvm) to manage Node versions — `brew install nvm`. | ||
@@ -86,3 +86,2 @@ ### Test it | ||
- `npm run test:unit:cov` — runs the unit tests with code coverage | ||
- `npm run test:mutants` — runs the mutation tests | ||
@@ -89,0 +88,0 @@ ### Lint it |
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
19
15382
94
Updatednode-jose@^2.1.1