Fix JSDOC's lint required params and returns

.eslintrc.js

@@ -36,12 +36,19 @@ module.exports = {
     'arrow-body-style': ['error', 'always'],
     'import/extensions': ['error', 'always'],
     strict: ['error', 'global'],
+    'jsdoc/require-jsdoc': ['warn', {
+      publicOnly: true
+    }],
     'jsdoc/require-description': 'warn',
-    'jsdoc/require-param': 'warn',
-    'jsdoc/require-returns': 'warn',
+    'jsdoc/require-param': ['warn', {
+      exemptedBy: ['private']
+    }],
+    'jsdoc/require-returns': ['warn', {
+      publicOnly: true
+    }],
     'jsdoc/check-tag-names': 'warn',
     'jsdoc/check-alignment': 'warn',
-    'jsdoc/newline-after-description': 'off', // does not work with 'use strict'
+    'jsdoc/newline-after-description': 'off', // does not work with ' use strict'
     'jsdoc/check-indentation': 'warn',
     'jsdoc/lines-before-block': 'warn',
     'jsdoc/check-types': 'warn',

app/validators/bill-runs/two-part-tariff/adjustment-factor.validator.js

@@ -30,6 +30,7 @@ function go (payload, maxNumberOfDecimals, validationType) {
 }
 
 /**
+ * @private
  * Due to limitations in Joi validation for decimals, achieving validation for numbers with fewer than 2 or 15 decimal
  * places requires a custom approach. First, convert the number into a string. Then split the string into an array using
  * the decimal point (`.`) as the delimiter. This results in either one item in the array (if no decimal is present) or

test/support/helpers/address.helper.js

@@ -40,6 +40,8 @@ function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const defaults = {

test/support/helpers/bill-licence.helper.js

@@ -36,6 +36,8 @@ async function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const defaults = {

test/support/helpers/bill-run-charge-version-year.helper.js

@@ -37,6 +37,8 @@ function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const defaults = {

test/support/helpers/bill-run-volume.helper.js

@@ -36,6 +36,8 @@ function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const defaults = {

test/support/helpers/bill-run.helper.js

@@ -39,6 +39,8 @@ function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const defaults = {

test/support/helpers/bill.helper.js

@@ -38,6 +38,8 @@ async function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const defaults = {

test/support/helpers/billing-account-address.helper.js

@@ -35,6 +35,8 @@ function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const defaults = {

test/support/helpers/billing-account.helper.js

@@ -35,6 +35,8 @@ function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const defaults = {

test/support/helpers/charge-category.helper.js

@@ -44,6 +44,8 @@ function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const defaults = {

test/support/helpers/charge-element.helper.js

@@ -48,6 +48,8 @@ function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const defaults = {

test/support/helpers/charge-reference.helper.js

@@ -49,6 +49,8 @@ function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const defaults = {

test/support/helpers/charge-version-note.helper.js

@@ -34,6 +34,8 @@ function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const defaults = {

test/support/helpers/charge-version.helper.js

@@ -42,6 +42,8 @@ async function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const defaults = {

test/support/helpers/company-address.helper.js

@@ -36,6 +36,8 @@ function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const defaults = {

test/support/helpers/company-contact.helper.js

@@ -36,6 +36,8 @@ function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const defaults = {

test/support/helpers/company.helper.js

@@ -36,6 +36,8 @@ function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const defaults = {

test/support/helpers/contact.helper.js

@@ -36,6 +36,8 @@ function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const defaults = {

test/support/helpers/event.helper.js

@@ -47,6 +47,8 @@ function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const timestamp = timestampForPostgres()

test/support/helpers/gauging-station.helper.js

@@ -39,6 +39,8 @@ async function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const timestamp = timestampForPostgres()

test/support/helpers/licence-agreement.helper.js

@@ -36,6 +36,8 @@ async function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const defaults = {

test/support/helpers/licence-document-header.helper.js

@@ -38,6 +38,8 @@ async function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const defaults = {

test/support/helpers/licence-document-role.helper.js

@@ -37,6 +37,8 @@ async function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const defaults = {

test/support/helpers/licence-document.helper.js

@@ -34,6 +34,8 @@ async function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const defaults = {

test/support/helpers/licence-entity-role.helper.js

@@ -37,6 +37,8 @@ async function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const defaults = {

test/support/helpers/licence-entity.helper.js

@@ -35,6 +35,8 @@ async function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const defaults = {

test/support/helpers/licence-gauging-station.helper.js

@@ -40,6 +40,8 @@ async function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const defaults = {

test/support/helpers/licence-role.helper.js

@@ -33,6 +33,8 @@ async function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const defaults = {

test/support/helpers/licence-supplementary-year.helper.js

@@ -34,6 +34,8 @@ function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here in the database
+ *
+ * @returns {object} - Returns data from the query
  */
 function defaults (data = {}) {
   const defaults = {

test/support/helpers/licence-version-purpose-condition.helper.js

@@ -40,6 +40,8 @@ async function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const timestamp = timestampForPostgres()

test/support/helpers/licence-version-purpose.helper.js

@@ -44,6 +44,8 @@ async function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const timestamp = timestampForPostgres()

test/support/helpers/licence-version.helper.js

@@ -41,6 +41,8 @@ async function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const timestamp = timestampForPostgres()

test/support/helpers/licence.helper.js

@@ -38,6 +38,8 @@ async function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const defaults = {

test/support/helpers/mod-log.helper.js

@@ -40,6 +40,8 @@ function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const regionCode = randomInteger(1, 9)

test/support/helpers/permit-licence.helper.js

@@ -37,6 +37,8 @@ async function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const licenceRef = data.licenceRef ? data.licenceRef : generateLicenceRef()
@@ -55,6 +57,7 @@ function defaults (data = {}) {
 }
 
 /**
+ * @private
  * In real life, when a licence is imported from NALD into WRLS a number of records get created. A lot of it is
  * duplication, but not everything from NALD is put into tables.
  *

test/support/helpers/return-log.helper.js

@@ -46,6 +46,8 @@ function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const licenceRef = data.licenceRef ? data.licenceRef : generateLicenceRef()

test/support/helpers/return-requirement-point.helper.js

@@ -37,6 +37,8 @@ function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const naldPointId = data.naldPointId ? data.naldPointId : generateNaldPointId()

test/support/helpers/return-requirement-purpose.helper.js

@@ -41,6 +41,8 @@ function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const purpose = PurposeHelper.select()

test/support/helpers/return-requirement.helper.js

@@ -42,6 +42,8 @@ function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const legacyId = data.legacyId ? data.legacyId : randomInteger(100, 99999)

test/support/helpers/return-submission-line.helper.js

@@ -42,6 +42,8 @@ function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const defaults = {

test/support/helpers/return-submission.helper.js

@@ -43,6 +43,8 @@ function add (data = {}) {
  * for use in tests to avoid having to duplicate values.
  *
  * @param {object} [data] - Any data you want to use instead of the defaults used here or in the database
+ *
+ * @returns {object} - Returns the set defaults with the override data spread
  */
 function defaults (data = {}) {
   const defaults = {