Merge pull request #454 from Fdawgs/chore/tidy

CONTRIBUTING.md

@@ -50,10 +50,11 @@ Titles and headings should adhere to the [Associated Press (AP)](https://www.aps
 Prior to submitting a pull request back to the main repository, please make sure you have completed the following steps:
 
 1. Pull request base branch is set to `master`. All pull requests should be forked from and merged back to `master`
-2. Run `npm test` to check the code adheres to the defined style and that it passes the Jest tests
+2. Run `npm test` to check the code adheres to the defined ESLint style and that it passes the Jest tests
 3. Run `npm run lint:prettier` to run the Prettier code formatter over the code
+4. Run `npm run lint:licenses` if adding or updating production dependencies to check they use permissive licenses
 
-Step 2. is automatically run by a pre-commit hook added by [Husky](https://typicode.github.io/husky/#/).
+Steps 2. and 4. are automatically run by a pre-commit hook added by [Husky](https://typicode.github.io/husky/#/).
 
 ## Issues
 

package.json

@@ -18,7 +18,7 @@
     "jest": "jest --detectOpenHandles --runInBand",
     "jest:coverage": "jest --coverage --runInBand",
     "lint": "eslint . --cache --ext js,jsx,ts,tsx --ignore-path .gitignore",
-    "lint:licenses": "license-checker --direct --onlyAllow=\"0BSD;Apache-2.0;Apache 2.0;BSD-2-Clause;BSD-3-Clause;ISC;MIT;Unlicense\" --production --summary",
+    "lint:licenses": "license-checker --direct --onlyAllow=\"0BSD;Apache-2.0;BSD-2-Clause;BSD-3-Clause;ISC;MIT;Unlicense\" --production --summary",
     "lint:prettier": "prettier . --write --ignore-unknown",
     "lint:prettier:ci": "prettier . --check --ignore-unknown",
     "prepare": "husky install && rm -rf .git/hooks && ln -s ../.husky .git/hooks",

src/plugins/jwt-jwks-auth/index.js

@@ -35,7 +35,7 @@ async function getSigningKey(token, jwksUri) {
  * @author Frazer Smith
  * @description Decorator plugin that adds `verifyJWT` function
  * to authenticate JWTs using JWKS endpoint.
- * @param {Function} server - Fastify instance.
+ * @param {object} server - Fastify instance.
  * @param {object} options - Plugin config values.
  * @param {string} options.jwksEndpoint - URL of endpoint containing JWKS public keys.
  * @param {string|Array=} options.allowedAudiences - Accepted recipient(s) that JWT is intended for.

src/plugins/shared-schemas/index.js

@@ -4,7 +4,7 @@ const S = require("fluent-json-schema");
 /**
  * @author Frazer Smith
  * @description Plugin that adds collection of shared schemas for re-use throughout server.
- * @param {Function} server - Fastify instance.
+ * @param {object} server - Fastify instance.
  */
 async function plugin(server) {
 	// Response schemas

src/routes/admin/healthcheck/index.js

@@ -8,7 +8,7 @@ const { healthcheckGetSchema } = require("./schema");
  * @description Sets routing options for server for healthcheck endpoint.
  * This is used by monitoring software to poll and confirm the API is running,
  * so needs no authentication.
- * @param {Function} server - Fastify instance.
+ * @param {object} server - Fastify instance.
  * @param {object} options - Route config values.
  * @param {object} options.cors - CORS settings.
  */