From 1396b5716cad8a4db4d7f54f83fe1dabd9e1d620 Mon Sep 17 00:00:00 2001
From: Alan Cruikshanks <alan.cruikshanks@gmail.com>
Date: Wed, 23 Nov 2022 15:24:43 +0000
Subject: [PATCH] General housekeeping

In this change we're just getting on top of some basic things we've either ommitted when making changes or because we have made a concious decision about a way forward.

- Using kebab-case rather than snake_case for filenames
  - Though there is no standard or rule, it's our opinion that most javascript projects use kebab-case
- Ensuring all require statements include the extension
  - We know it's not needed. But as [Switch from CommonJS to ES6 modules](https://github.com/DEFRA/water-abstraction-system/pull/9) shows, we really want to switch to imports one day and this will set us up for that
- Including module JSDoc comments at the top of each file
  - We use JSDoc to comment our methods. I also reccommends CommonJS modules should include a standalone comment. When you do, VSCode will display the info when you hover over a `require()`