Fix code style checks (#541)

Author: frankieroberto

.eslintrc.js

@@ -4,16 +4,13 @@
 module.exports = {
   extends: ['prettier'],
   ignorePatterns: [
-    '**/app/**',
+    '**/lib/**',
     '**/public/**',
 
     // Enable dotfile linting
     '!.*',
     'node_modules',
-    'node_modules/.*',
-
-    // Prevent CHANGELOG history changes
-    'CHANGELOG.md'
+    'node_modules/.*'
   ],
   overrides: [
     {
@@ -32,13 +29,7 @@ module.exports = {
       parserOptions: {
         ecmaVersion: 'latest'
       },
-      plugins: [
-        '@typescript-eslint',
-        'import',
-        'jsdoc',
-        'n',
-        'promise'
-      ],
+      plugins: ['@typescript-eslint', 'import', 'jsdoc', 'n', 'promise'],
       rules: {
         // Always import Node.js packages from `node:*`
         'import/enforce-node-protocol-usage': ['error', 'always'],

.github/workflows/code-style.yml

@@ -0,0 +1,20 @@
+name: Code style checks
+
+on: pull_request
+
+jobs:
+  lint:
+    name: Code style checks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/setup-node@v6
+        with:
+          node-version-file: .nvmrc
+      # Ensure npm 11.5.1 or later is installed
+      - name: Update npm
+        run: npm install -g npm@latest
+      - name: Install dependencies
+        run: npm ci
+      - name: Run code style checks
+        run: npm run lint

.nvmrc

@@ -0,0 +1 @@
+22

app/data/session-data-defaults.js

@@ -1,7 +1,7 @@
-const organisations = require('./organisations')
 const allOrganisations = require('./all-organisations')
-const regions = require('./regions')
 const featureFlags = require('./feature-flags')
+const organisations = require('./organisations')
+const regions = require('./regions')
 const users = require('./users')
 const vaccines = require('./vaccines')
 

app/filters.js

@@ -1,67 +1,34 @@
 const prototypeFilters = require('@x-govuk/govuk-prototype-filters');
 
-/**
- * @param {Environment} env
- */
-module.exports = function (env) {
-  const filters = prototypeFilters;
-
-  /* ------------------------------------------------------------------
-    add your methods to the filters obj below this comment block:
-    @example:
-
-    filters.sayHi = function(name) {
-        return 'Hi ' + name + '!'
-    }
-
-    Which in your templates would be used as:
-
-    {{ 'Paul' | sayHi }} => 'Hi Paul'
-
-    Notice the first argument of your filters method is whatever
-    gets 'piped' via '|' to the filter.
-
-    Filters can take additional arguments, for example:
-
-    filters.sayHi = function(name,tone) {
-      return (tone == 'formal' ? 'Greetings' : 'Hi') + ' ' + name + '!'
-    }
-
-    Which would be used like this:
-
-    {{ 'Joel' | sayHi('formal') }} => 'Greetings Joel!'
-    {{ 'Gemma' | sayHi }} => 'Hi Gemma!'
 
-    For more on filters and how to write them see the Nunjucks
-    documentation.
-
-  ------------------------------------------------------------------ */
+module.exports = function () {
+  const filters = prototypeFilters;
 
   /**
    * Find an object by ID in an array
+   *
    * @param {Array} array - Array to search
    * @param {string} id - ID to find
-   * @returns {Object} Found object or undefined
-  */
+   * @returns {object} Found object or undefined
+   */
   const findById = (array, id) => {
     if (!array || !Array.isArray(array)) return undefined
     return array.find(item => item.id === id)
   }
-  
-  filters.findById = findById
 
+  filters.findById = findById
 
   filters.dayName = function(isoDate) {
     const date = new Date(Date.parse(isoDate))
     const dateFormatter = new Intl.DateTimeFormat('en-GB', {weekday: 'short'});
-  
+
     return dateFormatter.format(date)
   }
-  
+
   filters.pluck = function(array, attribute) {
     return array.map((item) => item[attribute])
   }
-  
+
   filters.capitaliseFirstLetter = function(string) {
     if (string) {
       return string.charAt(0) .toUpperCase() + string.slice(1)
@@ -78,23 +45,23 @@ module.exports = function (env) {
    * January, rather than 0 (which is the default for
    * JavaScript date objects).
    *
-   * @param {Integer, string} monthNumber - number of the month
-   * @returns {String} Full name of the month in English
-  */
+   * @param {number|string} monthNumber - number of the month
+   * @returns {string} Full name of the month in English
+   */
   filters.monthName = function(monthNumber) {
-  
+
     try {
       monthNumber = parseInt(monthNumber)
-  
+
       if (!monthNumber || (monthNumber < 1) || (monthNumber > 12)) {
         throw new Error('Invalid monthNumber - must be between 1 and 12')
       }
-  
+
       const date = new Date(Date.UTC(2000, (monthNumber - 1), 1, 0, 0, 0));
       const dateFormatter = new Intl.DateTimeFormat('en-GB', {month: 'long'});
-  
+
       return dateFormatter.format(date)
-  
+
     } catch (error) {
       return error.message.split(':')[0]
     }

app/routes/helpers.js

@@ -16,7 +16,7 @@ module.exports = router => {
     const vaccines = data.vaccines
     const siteId = "RW3NM"
 
-    for (vaccine of vaccines) {
+    for (let vaccine of vaccines) {
 
       const organisationVaccine = organisationVaccines.find((organisationVaccine) => organisationVaccine.name === vaccine.name)
 
@@ -29,7 +29,7 @@ module.exports = router => {
         })
       }
 
-      for (vaccineProduct of vaccine.products) {
+      for (let vaccineProduct of vaccine.products) {
 
         const numberOfBatchesToAdd = 1 + Math.floor(Math.random() * 10)
 

app/routes/home.js

@@ -99,7 +99,7 @@ module.exports = router => {
       })
     }
 
-    for (vaccine of uniqueVaccinesRecorded) {
+    for (let vaccine of uniqueVaccinesRecorded) {
       totalsByVaccine.push({
         vaccine: vaccine,
         today: countVaccinations(vaccinationsRecorded, {
@@ -123,7 +123,7 @@ module.exports = router => {
 
     const siteIds = [...new Set(vaccinationsRecorded.map((vaccination) => vaccination.siteId))]
 
-    for (siteId of siteIds) {
+    for (let siteId of siteIds) {
       totalsBySite.push({
         siteId: siteId,
         today: countVaccinations(vaccinationsRecorded, {

app/routes/lists.js

@@ -1,5 +1,5 @@
-const { randomItem } = require('../lib/utils/random-item.js')
 const { dateFromYearMonthDay } = require('../lib/utils/date-from-year-month-day.js')
+const { randomItem } = require('../lib/utils/random-item.js')
 
 
 module.exports = router => {
@@ -227,7 +227,7 @@ module.exports = router => {
 
     const nhsNumbers = data.nhsNumbers.split(/\n/)
 
-    for (nhsNumber of nhsNumbers) {
+    for (let nhsNumber of nhsNumbers) {
       patientList.patients.push({
         nhsNumber: nhsNumber,
         firstName: randomItem(listOfFirstNames),

app/routes/record-vaccinations.js

@@ -151,7 +151,7 @@ module.exports = router => {
     let vaccinesAvailable = JSON.parse(JSON.stringify(data.vaccines)).filter((vaccine) => vaccinesAdded.includes(vaccine.name))
 
     // Filter all vaccine products to only show ones with batches added
-    for (vaccineAvailable of vaccinesAvailable) {
+    for (let vaccineAvailable of vaccinesAvailable) {
       vaccineAvailable.products = vaccineAvailable.products.filter((vaccineProduct) => vaccineProductsAdded.includes(vaccineProduct.name))
     }
 
@@ -206,7 +206,6 @@ module.exports = router => {
   router.get('/record-vaccinations/patient', (req, res) => {
 
     const data = req.session.data
-    const showError = data.showError
     const nhsNumberKnown = data.nhsNumberKnown
     const nhsNumber = String(data.nhsNumber).replaceAll(' ', '')
 
@@ -392,11 +391,11 @@ module.exports = router => {
 
   router.post('/record-vaccinations/create-a-record', (req, res) => {
     const data = req.session.data
-    const firstName = req.session.data.firstName;
-    const lastName = req.session.data.lastName;
-    const dateOfBirth = req.session.data.dateOfBirth;
-    const postcode = req.session.data.postcode;
-    const gender = req.session.data.gender;
+    const firstName = data.firstName;
+    const lastName = data.lastName;
+    const dateOfBirth = data.dateOfBirth;
+    const postcode = data.postcode;
+    const gender = data.gender;
 
     if (firstName != '' && lastName != '' && dateOfBirth.day != '' && dateOfBirth.month != '' && dateOfBirth.year != '' && postcode != '' && gender != '') {
 
@@ -774,7 +773,6 @@ module.exports = router => {
   router.get('/record-vaccinations/batch', (req, res) => {
     let error
     const data = req.session.data
-    const currentOrganisation = res.locals.currentOrganisation
 
     const vaccine = data.vaccineStock.find(function(batch) {
       return (batch.vaccineProduct === data.vaccineProduct) &&
@@ -846,7 +844,6 @@ module.exports = router => {
 
     const data = req.session.data
     const vaccineBatch = data.vaccineBatch
-    const vaccine = data.vaccine
 
     const vaccineOptions = data.vaccineStock.find(function(batch) {
       return (batch.vaccineProduct === data.vaccineProduct) &&
@@ -1159,8 +1156,6 @@ module.exports = router => {
   router.post('/record-vaccinations/answer-dose-amount', (req, res) => {
     const data = req.session.data
     const doseAmount = data.doseAmount
-    let redirectPath
-
 
     if (doseAmount && doseAmount != "") {
       res.redirect("/record-vaccinations/check")

app/routes/records.js

@@ -154,7 +154,6 @@ module.exports = router => {
     const firstName = data.firstName;
     const lastName = data.lastName;
     const dateOfBirth = data.dateOfBirth;
-    const postcode = data.postcode;
 
     if (firstName && lastName && dateOfBirth) {