Use prettier to manage code style and formatting

.github/dependabot.yml

@@ -3,14 +3,14 @@
 
 version: 2
 updates:
-- package-ecosystem: npm
-  directory: "/"
-  schedule:
-    interval: daily
-  open-pull-requests-limit: 10
-  versioning-strategy: lockfile-only
-- package-ecosystem: "github-actions"
-  # Workflow files stored in the default location of `.github/workflows`
-  directory: "/"
-  schedule:
-    interval: "daily"
+  - package-ecosystem: npm
+    directory: '/'
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+    versioning-strategy: lockfile-only
+  - package-ecosystem: 'github-actions'
+    # Workflow files stored in the default location of `.github/workflows`
+    directory: '/'
+    schedule:
+      interval: 'daily'

.github/workflows/ci.yml

@@ -64,7 +64,7 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v4
         with:
-          fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of sonarcloud analysis
+          fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of sonarcloud analysis
 
       # Before we do anything, check we haven't accidentally left any `describe.only()` or `it.only(` statements in the
       # tests
@@ -85,7 +85,7 @@ jobs:
       - name: Install Node
         uses: actions/setup-node@v4
         with:
-          node-version-file: ".nvmrc"
+          node-version-file: '.nvmrc'
 
       # Speeds up workflows by reading the node modules from cache. Obviously you need to run it at least once, and the
       # cache will be updated should the package-lock.json file change

.jsdoc.js

@@ -1,4 +1,3 @@
-
 'use strict'
 
 module.exports = {

.labrc.js

@@ -11,13 +11,40 @@ module.exports = {
   // of globals to ignore to be a single comma-delimited string; for ease of management we define them in an array then
   // join them.
   globals: [
-    '__extends', '__assign', '__rest', '__decorate', '__param', '__metadata', '__awaiter', '__generator',
-    '__exportStar', '__createBinding', '__values', '__read', '__spread', '__spreadArrays', '__spreadArray', '__await',
-    '__asyncGenerator', '__asyncDelegator', '__asyncValues', '__makeTemplateObject', '__importStar', '__importDefault',
-    '__classPrivateFieldGet', '__classPrivateFieldSet', '__esDecorate', '__runInitializers', '__propKey',
-    '__setFunctionName', '__classPrivateFieldIn', '__addDisposableResource', '__disposeResources',
+    '__extends',
+    '__assign',
+    '__rest',
+    '__decorate',
+    '__param',
+    '__metadata',
+    '__awaiter',
+    '__generator',
+    '__exportStar',
+    '__createBinding',
+    '__values',
+    '__read',
+    '__spread',
+    '__spreadArrays',
+    '__spreadArray',
+    '__await',
+    '__asyncGenerator',
+    '__asyncDelegator',
+    '__asyncValues',
+    '__makeTemplateObject',
+    '__importStar',
+    '__importDefault',
+    '__classPrivateFieldGet',
+    '__classPrivateFieldSet',
+    '__esDecorate',
+    '__runInitializers',
+    '__propKey',
+    '__setFunctionName',
+    '__classPrivateFieldIn',
+    '__addDisposableResource',
+    '__disposeResources',
     // We also ignore globals exposed by global-agent:
-    'GLOBAL_AGENT', 'ROARR',
+    'GLOBAL_AGENT',
+    'ROARR',
     // GlobalNotifier is added by us a global in a server plugin. It's how we make logging available anywhere in the app
     // whilst avoiding having to pass it around
     'GlobalNotifier',

.prettierrc

@@ -0,0 +1,6 @@
+{
+  "semi": false,
+  "singleQuote": true,
+  "trailingComma": "none",
+  "printWidth": 120
+}

CHANGELOG.md

@@ -53,7 +53,7 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - Exclude VOID returns from two-part tariff billing [`#1419`](https://github.com/DEFRA/water-abstraction-system/pull/1419)
 - 2PT use full authorised volume rather than Nil [`#1404`](https://github.com/DEFRA/water-abstraction-system/pull/1404)
 - Bump @aws-sdk/client-s3 from 3.670.0 to 3.673.0 [`#1417`](https://github.com/DEFRA/water-abstraction-system/pull/1417)
-- Rename gauging stations to monitoring stations  [`#1415`](https://github.com/DEFRA/water-abstraction-system/pull/1415)
+- Rename gauging stations to monitoring stations [`#1415`](https://github.com/DEFRA/water-abstraction-system/pull/1415)
 - Fix auth scope on view monitoring station route [`#1413`](https://github.com/DEFRA/water-abstraction-system/pull/1413)
 - Import licence document for a licence [`#1392`](https://github.com/DEFRA/water-abstraction-system/pull/1392)
 - Bump eslint-plugin-jsdoc from 50.3.2 to 50.4.1 [`#1411`](https://github.com/DEFRA/water-abstraction-system/pull/1411)
@@ -339,10 +339,10 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - Add 'currentVersion' modifier to LicenceModel [`#1133`](https://github.com/DEFRA/water-abstraction-system/pull/1133)
 - Fix returns requirement button text [`#1134`](https://github.com/DEFRA/water-abstraction-system/pull/1134)
 - Feature-requirements-for-returns-view-page [`#1118`](https://github.com/DEFRA/water-abstraction-system/pull/1118)
-- Add orderBy to data fetched for two-part tariff review  [`#1131`](https://github.com/DEFRA/water-abstraction-system/pull/1131)
+- Add orderBy to data fetched for two-part tariff review [`#1131`](https://github.com/DEFRA/water-abstraction-system/pull/1131)
 - Add new two-part tariff generate bill run endpoint [`#1123`](https://github.com/DEFRA/water-abstraction-system/pull/1123)
 - Add created_by to return versions and link models [`#1126`](https://github.com/DEFRA/water-abstraction-system/pull/1126)
-- Update two-part tariff review pages to add Cypress data test attributes  [`#1128`](https://github.com/DEFRA/water-abstraction-system/pull/1128)
+- Update two-part tariff review pages to add Cypress data test attributes [`#1128`](https://github.com/DEFRA/water-abstraction-system/pull/1128)
 - Fix Ret. Req. logic to determine cycle for 2PT [`#1124`](https://github.com/DEFRA/water-abstraction-system/pull/1124)
 - Bump joi from 17.13.1 to 17.13.3 [`#1127`](https://github.com/DEFRA/water-abstraction-system/pull/1127)
 - Update validation msg for ret. req. copy existing [`#1125`](https://github.com/DEFRA/water-abstraction-system/pull/1125)
@@ -433,7 +433,7 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - Select additional submission options page [`#988`](https://github.com/DEFRA/water-abstraction-system/pull/988)
 - Refactor purposes page to use purpose ids as values [`#1025`](https://github.com/DEFRA/water-abstraction-system/pull/1025)
 - Bump sass from 1.77.1 to 1.77.2 [`#1030`](https://github.com/DEFRA/water-abstraction-system/pull/1030)
-- Add sentence case function & rename capitalize  [`#1029`](https://github.com/DEFRA/water-abstraction-system/pull/1029)
+- Add sentence case function & rename capitalize [`#1029`](https://github.com/DEFRA/water-abstraction-system/pull/1029)
 - Fix QA issues found with the review adjustment factors validation [`#1027`](https://github.com/DEFRA/water-abstraction-system/pull/1027)
 - Refactor to use computed error message [`#1026`](https://github.com/DEFRA/water-abstraction-system/pull/1026)
 - Remove returns requirements button on check page [`#1021`](https://github.com/DEFRA/water-abstraction-system/pull/1021)
@@ -672,7 +672,7 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - Add legacy create bill run request [`#800`](https://github.com/DEFRA/water-abstraction-system/pull/800)
 - Return instead of await requests [`#799`](https://github.com/DEFRA/water-abstraction-system/pull/799)
 - Move legacy refresh requests to module [`#798`](https://github.com/DEFRA/water-abstraction-system/pull/798)
-- Migrate Charging Module services to *.request.js [`#797`](https://github.com/DEFRA/water-abstraction-system/pull/797)
+- Migrate Charging Module services to \*.request.js [`#797`](https://github.com/DEFRA/water-abstraction-system/pull/797)
 - Add defra-user-id header to legacy requests [`#796`](https://github.com/DEFRA/water-abstraction-system/pull/796)
 - Move non-model helpers out of helpers [`#795`](https://github.com/DEFRA/water-abstraction-system/pull/795)
 - Move currentFinancialYear() from test [`#794`](https://github.com/DEFRA/water-abstraction-system/pull/794)
@@ -723,7 +723,7 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - Move SendTransactions to root with refactoring [`#745`](https://github.com/DEFRA/water-abstraction-system/pull/745)
 - Remove Landing Page From System [`#747`](https://github.com/DEFRA/water-abstraction-system/pull/747)
 - Fix & tidy test DB legacy migrations [`#725`](https://github.com/DEFRA/water-abstraction-system/pull/725)
-- Returns required -  Select an existing return requirement from basic page [`#746`](https://github.com/DEFRA/water-abstraction-system/pull/746)
+- Returns required - Select an existing return requirement from basic page [`#746`](https://github.com/DEFRA/water-abstraction-system/pull/746)
 - Bump dotenv from 16.4.4 to 16.4.5 [`#744`](https://github.com/DEFRA/water-abstraction-system/pull/744)
 - Determine match and allocate issues and status [`875f478`](https://github.com/DEFRA/water-abstraction-system/commit/875f4780b35ba4007d0d7a9c370c8329e0832488)
 
@@ -886,7 +886,7 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - Bump @aws-sdk/client-s3 from 3.472.0 to 3.473.0 [`#588`](https://github.com/DEFRA/water-abstraction-system/pull/588)
 - Add new page for add a note [`#587`](https://github.com/DEFRA/water-abstraction-system/pull/587)
 - Requirement approval page [`#585`](https://github.com/DEFRA/water-abstraction-system/pull/585)
-- Add check your answers page  for return required journey [`#584`](https://github.com/DEFRA/water-abstraction-system/pull/584)
+- Add check your answers page for return required journey [`#584`](https://github.com/DEFRA/water-abstraction-system/pull/584)
 - Create `fetch-licences` service [`#577`](https://github.com/DEFRA/water-abstraction-system/pull/577)
 - Add check your answers page (return requirements) [`#579`](https://github.com/DEFRA/water-abstraction-system/pull/579)
 - Bump @aws-sdk/client-s3 from 3.470.0 to 3.472.0 [`#583`](https://github.com/DEFRA/water-abstraction-system/pull/583)

README.md

@@ -12,28 +12,17 @@ This API provides an interface for calculating charges, queuing transactions and
 
 Make sure you already have:
 
-- [Node.js v16.*](https://nodejs.org/en/)
-- [PostgreSQL v12](https://www.postgresql.org/)
+- [Node.js v20.\*](https://nodejs.org/en/)
+- [PostgreSQL v14](https://www.postgresql.org/)
 
-## Installation
+## Running locally
 
-First clone the repository and then drop into your new local repo:
-
-```bash
-git clone https://github.com/DEFRA/water-abstraction-system.git && cd water-abstraction-system
-```
-
-Create the databases:
-
-```bash
-npm run create-db
-npm run create-test-db
-```
-
-Our preference is to run the database and API within Docker, so [install Docker](https://docs.docker.com/get-docker/) if you don't already have it.
+This is one of a number of apps that make up the Water Resource Licencing service. Because of the service's complex infrastructure there is a separate project available that will build a fully working WRLS environment, using [Docker](https://docs.docker.com/get-docker/). We recommend reaching out to the [Water Abstraction team](https://github.com/orgs/DEFRA/teams/water-abstraction) and requesting access to **wal-dev-environment** if you need to get this project up and running.
 
 ## Configuration
 
+> This is automatically setup when running locally using **wal-dev-environment**
+
 Any configuration is expected to be driven by environment variables when the service is run in production as per [12 factor app](https://12factor.net/config).
 
 However when running locally in development mode or in test it makes use of the [Dotenv](https://github.com/motdotla/dotenv) package. This is a shim that will load values stored in a `.env` file into the environment which the service will then pick up as though they were there all along.
@@ -48,6 +37,8 @@ If you have an idea you'd like to contribute please log an issue.
 
 All contributions should be submitted via a pull request.
 
+The code style is dictated by [Prettier](https://prettier.io/), and we follow [StandardJS](https://standardjs.com/) code rules as implemented by [neostandard](https://github.com/neostandard/neostandard). This is all managed through [ESLint](https://eslint.org/) so should play nice with all IDE's.
+
 ## License
 
 THIS INFORMATION IS LICENSED UNDER THE CONDITIONS OF THE OPEN GOVERNMENT LICENCE found at:

app/controllers/bill-licences.controller.js

@@ -11,7 +11,7 @@ const RemoveBillLicenceService = require('../services/bill-licences/remove-bill-
 const SubmitRemoveBillLicenceService = require('../services/bill-licences/submit-remove-bill-licence.service.js')
 const ViewBillLicenceService = require('../services/bill-licences/view-bill-licence.service.js')
 
-async function remove (request, h) {
+async function remove(request, h) {
   const { id } = request.params
 
   const pageData = await RemoveBillLicenceService.go(id)
@@ -22,7 +22,7 @@ async function remove (request, h) {
   })
 }
 
-async function submitRemove (request, h) {
+async function submitRemove(request, h) {
   const { id } = request.params
 
   try {
@@ -34,7 +34,7 @@ async function submitRemove (request, h) {
   }
 }
 
-async function view (request, h) {
+async function view(request, h) {
   const { id } = request.params
 
   const pageData = await ViewBillLicenceService.go(id)