Fix all remaining lint issues (#1249)

As part of ongoing automation for our code practices and preferences we introduced eslint instead of the DEFRA standard linter standard.js.

Our eslint setup uses standard.js as the base linter but we have our own rules on top.

We have previously introduced a gradual adoption of eslint by using the git diff when running eslint. This appears to have some limitation with some rules not getting picked up.

At this point it makes sense to fix the remaining lint issues and remove the git diff and lint the whole codebase. When we first moved over to eslint there were 1000+ issues now we only have 137 issues (with the majority being able to be fixed with --fix).

This change fixes all outstanding linting issues and remove the previous lint with git diff lint to the basic eslint run.

app/lib/legacy-db-snake-case-mappers.lib.js

@@ -5,7 +5,7 @@
  * @module LegacyDbSnakeCaseMappersLib
  */
 
-const { camelCase, knexIdentifierMappers, snakeCase } = require('objection/lib/utils/identifierMapping')
+const { camelCase, knexIdentifierMappers, snakeCase } = require('objection/lib/utils/identifierMapping.js')
 
 /**
  * Return an object containing Knex postProcessResponse() and wrapIdentifier() hooks used in Db query and result parsing

app/presenters/paginator.presenter.js

@@ -195,6 +195,7 @@ function _items (selectedPageNumber, numberOfPages, path) {
   const paginatorType = _paginatorType(selectedPageNumber, numberOfPages)
 
   let items
+
   switch (paginatorType) {
     case COMPLEX_START_PAGINATOR:
       items = _complexPaginatorStart(selectedPageNumber, numberOfPages, path)

app/requests/charging-module/token.request.js

@@ -50,6 +50,7 @@ function _parseResult (result) {
 
   if (result.succeeded) {
     const data = JSON.parse(result.response.body)
+
     authentication.accessToken = data.access_token
     authentication.expiresIn = data.expires_in
   }

app/services/bill-runs/annual/process-billing-period.service.js

@@ -67,6 +67,7 @@ async function go (billRun, billingPeriod, billingAccounts) {
     // supplementary it is extremely unlikely an annual bill run would generate no bills. But we play it safe and don't
     // make that assumption.
     const results = await Promise.all(processes)
+
     if (!billRunIsPopulated) {
       billRunIsPopulated = results.some((result) => {
         return result
@@ -142,6 +143,7 @@ function _extractBillableLicences (allBillLicences) {
 
   allBillLicences.forEach((billLicence) => {
     const { id, billId, licenceId, licenceRef, billable } = billLicence
+
     if (billable) {
       billableBillLicences.push({ id, billId, licenceId, licenceRef })
     }

app/services/bill-runs/determine-billing-periods.service.js

@@ -63,6 +63,7 @@ function _billingPeriods (billRunType, financialYear) {
   // It means we'll never pick a PRESROC for our billing periods. But also we are future proofed should we still be
   // here in 2029!
   const earliestSrocFinYearEnd = Math.max(SROC_FIRST_FIN_YEAR_END, (years.endYear - NO_OF_YEARS_TO_LOOK_BACK))
+
   while (earliestSrocFinYearEnd <= years.endYear) {
     _addBillingPeriod(billingPeriods, years.startYear, years.endYear)
 

app/services/bill-runs/generate-transactions.service.js

@@ -60,6 +60,7 @@ function go (billLicenceId, chargeReference, billingPeriod, chargePeriod, newLic
 
   if (!waterUndertaker) {
     const compensationTransaction = _compensationTransaction(standardTransaction)
+
     transactions.push(compensationTransaction)
   }
 

app/services/bill-runs/submit-cancel-bill-run.service.js

@@ -42,6 +42,7 @@ async function go (billRunId) {
   const billRun = await _fetchBillRun(billRunId)
 
   const cannotBeDeleted = _cannotBeDeleted(billRun.status)
+
   if (cannotBeDeleted) {
     return
   }

app/services/bill-runs/supplementary/process-billing-period.service.js

@@ -119,6 +119,7 @@ function _buildBillingDataWithTransactions (chargeVersions, preGeneratedData, bi
     // We fetch the previous transactions for `superseded` (REPLACED) charge versions later in the process
     if (chargeVersion.status === 'current') {
       const calculatedTransactions = _generateCalculatedTransactions(billLicenceId, billingPeriod, chargeVersion)
+
       acc[billLicenceId].calculatedTransactions.push(...calculatedTransactions)
     }
 

app/services/bill-runs/two-part-tariff/fetch-bill-run-licences.service.js

@@ -46,7 +46,9 @@ async function go (id, filterIssues, filterLicenceHolderNumber, filterLicenceSta
   return { billRun, licences }
 }
 
-function _applyFilters (reviewLicenceQuery, filterIssues, filterLicenceHolderNumber, filterLicenceStatus, filterProgress) {
+function _applyFilters (
+  reviewLicenceQuery, filterIssues, filterLicenceHolderNumber, filterLicenceStatus, filterProgress
+) {
   if (filterIssues) {
     _filterIssues(filterIssues, reviewLicenceQuery)
   }
@@ -84,7 +86,9 @@ async function _fetchBillRun (id) {
     })
 }
 
-async function _fetchBillRunLicences (id, filterIssues, filterLicenceHolderNumber, filterLicenceStatus, filterProgress, page = 1) {
+async function _fetchBillRunLicences (
+  id, filterIssues, filterLicenceHolderNumber, filterLicenceStatus, filterProgress, page = 1
+) {
   const reviewLicenceQuery = ReviewLicenceModel.query()
     .select('licenceId', 'licenceRef', 'licenceHolder', 'issues', 'progress', 'status')
     .where('billRunId', id)

app/services/bill-runs/two-part-tariff/persist-allocated-licence-to-results.service.js

@@ -52,6 +52,7 @@ async function go (billRunId, licence) {
 
 async function _persistChargeElement (chargeElement, reviewReturnIds, reviewChargeReferenceId) {
   const reviewChargeElementId = await _persistReviewChargeElement(chargeElement, reviewChargeReferenceId)
+
   for (const returnLog of chargeElement.returnLogs) {
     // When we persist the review result we need the Id's for both the charge element and return log's review result
     // records. Though it looks like we're iterating return logs here, these are copies assigned during matching and
@@ -130,6 +131,7 @@ async function _persistReturnLogs (returnLogs, reviewLicenceId) {
 
   for (const returnLog of returnLogs) {
     const reviewReturnId = await _persistReviewReturn(returnLog, reviewLicenceId)
+
     reviewReturnIds.push({ returnId: returnLog.id, reviewReturnId })
   }
 

app/services/billing-accounts/change-address.service.js

@@ -154,6 +154,7 @@ async function _patchExistingBillingAccountAddressEndDate (trx, billingAccountId
   // `endDate` to be today - 1 (yesterday). The following works it all out even if we're over a month or year boundary
   // and no moment() in sight! Thanks to https://stackoverflow.com/a/1296374 for how to do this
   const endDate = new Date()
+
   endDate.setDate(timestamp.getDate() - 1)
 
   await BillingAccountAddressModel.query(trx)

app/services/data/deduplicate/submit-deduplicate.service.js

@@ -35,6 +35,7 @@ async function go (payload) {
   }
 
   const parsedLicenceRef = licenceRef.trim().toUpperCase()
+
   await DeDuplicateService.go(parsedLicenceRef)
 
   return {

app/services/health/fetch-import-jobs.service.js

@@ -80,6 +80,7 @@ async function go () {
  */
 function _subtractDaysFromCurrentDate (days) {
   const date = new Date()
+
   date.setDate(date.getDate() - days)
 
   return date

app/services/idm/fetch-user-roles-and-groups.service.js

@@ -56,6 +56,7 @@ async function go (userId) {
  */
 function _extractRolesAndGroupsFromUser (user) {
   const { roles, groups } = user
+
   delete user.roles
   delete user.groups
 
@@ -71,6 +72,7 @@ function _extractRolesAndGroupsFromUser (user) {
 function _extractRolesFromGroups (groups) {
   return groups.flatMap((group) => {
     const { roles } = group
+
     delete group.roles
 
     return roles

app/services/jobs/export/write-table-to-file.service.js

@@ -29,6 +29,7 @@ async function go (headers, rows, schemaFolderPath, tableName) {
   const transformDataStream = _transformDataStream()
 
   const convertedHeaders = ConvertToCSVService.go(headers)
+
   writeToFileStream.write(convertedHeaders)
 
   await promisifiedPipeline(inputStream, transformDataStream, writeToFileStream)
@@ -44,6 +45,7 @@ function _transformDataStream () {
     objectMode: true,
     transform: function (row, _encoding, callback) {
       const datRow = ConvertToCSVService.go(Object.values(row))
+
       callback(null, datRow)
     }
   })

app/services/jobs/licence-updates/fetch-licence-updates.service.js

@@ -62,6 +62,7 @@ async function go () {
 
 function _twoMonthsAgo () {
   const today = new Date()
+
   today.setMonth(today.getMonth() - 2)
 
   return today

app/services/jobs/time-limited/fetch-time-limited-licences.service.js

@@ -57,6 +57,7 @@ async function go () {
 
 function _offSetCurrentDateByDays (days) {
   const date = new Date()
+
   date.setDate(date.getDate() + days)
 
   return date

app/services/plugins/payload-cleaning.service.js

@@ -105,6 +105,7 @@ function _cleanObject (obj) {
 
   for (const [key, value] of Object.entries(obj)) {
     let result
+
     if (typeof value === 'object') {
       if (Array.isArray(value)) {
         result = _cleanArray(value)
@@ -202,6 +203,7 @@ function _keepValue (value) {
 function _cleanValue (value) {
   if (typeof value === 'string') {
     let cleanedValue = Sanitizer.sanitize(value)
+
     cleanedValue = cleanedValue.trim()
     cleanedValue = Sanitizer.unescapeEntities(cleanedValue)
 

app/services/return-requirements/add.service.js

@@ -33,6 +33,7 @@ async function _save (session) {
 
   return session.$update()
 }
+
 module.exports = {
   go
 }

app/services/return-requirements/check-licence-ended.service.js

@@ -48,6 +48,7 @@ function _licenceEnded (licence) {
   }
 
   const today = new Date()
+
   today.setHours(0, 0, 0, 0)
 
   return ends.date <= today

app/services/return-requirements/fetch-points.service.js

@@ -42,6 +42,7 @@ function _abstractPointsData (result) {
   result.purposes.forEach((purpose) => {
     purpose.purposePoints.forEach((point) => {
       const pointDetail = point.point_detail
+
       pointsData.push(pointDetail)
     })
   })

app/services/return-requirements/submit-additional-submission-options.service.js

@@ -34,6 +34,7 @@ async function go (sessionId, payload, yar) {
 
   if (!validationResult) {
     const notification = _notification(session, payload)
+
     await _save(session, payload)
 
     if (notification) {

app/services/return-requirements/submit-note.service.js

@@ -32,6 +32,7 @@ async function go (sessionId, payload, user, yar) {
 
   if (!validationResult) {
     const notification = _notification(session, payload.note)
+
     await _save(session, payload, user)
 
     if (notification) {

db/db.js

@@ -2,7 +2,7 @@
 
 const environment = process.env.NODE_ENV || 'development'
 
-const dbConfig = require('../knexfile.application')[environment]
+const dbConfig = require('../knexfile.application.js')[environment]
 
 // Where the 'pg' package has concern that parsing a DB value into its JavaScript equivalent will lead to a loss of
 // data it will return the value as a string. For example, a PostgreSQL BigInt has the range -9223372036854775808 to

index.js

@@ -1,5 +1,5 @@
 'use strict'
 
-const { start } = require('./app/server')
+const { start } = require('./app/server.js')
 
 start()

knexfile.application.js

@@ -21,7 +21,7 @@ const { legacyDbSnakeCaseMappers } = require('./app/lib/legacy-db-snake-case-map
  * to migrations.
  */
 
-const knexfile = require('./knexfile')
+const knexfile = require('./knexfile.js')
 
 for (const environment in knexfile) {
   Object.assign(knexfile[environment], legacyDbSnakeCaseMappers({ underscoreBeforeDigits: true }))

package.json

@@ -17,8 +17,7 @@
     "rollback:all": "knex migrate:rollback --all",
     "rollback:all:test": "NODE_ENV=test knex migrate:rollback --all",
     "seed": "knex seed:run --knexfile knexfile.application.js",
-    "lint": "eslint $(git diff --name-only --diff-filter=ACMRTUXB  | grep -E \"\\.(js)$\")",
-    "lint:all": "eslint .",
+    "lint": "eslint .",
     "pretest": "NODE_ENV=test node db/clean.js",
     "test": "lab --silent-skips --shuffle",
     "postinstall": "npm run build",