chore: add prettier and lint-staged (#9)

.github/workflows/conventional-commits.yaml

@@ -9,7 +9,7 @@ on:
   workflow_call:
     inputs:
       title:
-        description: 'PR title'
+        description: "PR title"
         type: string
         required: true
 

.husky/pre-commit

@@ -0,0 +1 @@
+npx --no -- lint-staged

.lintstagedrc

@@ -0,0 +1,3 @@
+{
+  "*": ["prettier --ignore-unknown --write"]
+}

commitlint.config.ts

@@ -1,11 +1,11 @@
-import type {UserConfig} from '@commitlint/types';
+import type { UserConfig } from "@commitlint/types";
 import * as fs from "fs";
 
 const Configuration: UserConfig = {
-  extends: ['@commitlint/config-conventional'],
+  extends: ["@commitlint/config-conventional"],
   rules: {
-    'scope-enum': [2, 'always', fs.readdirSync('app').filter((file) => fs.statSync(`app/${file}`).isDirectory())],
-  }
+    "scope-enum": [2, "always", fs.readdirSync("app").filter((file) => fs.statSync(`app/${file}`).isDirectory())],
+  },
 };
 
 module.exports = Configuration;

docs/rfc/rfc-001-mono-repository.md

@@ -11,10 +11,11 @@ The VOL project consists of three separate repositories: [olcs-backend](http://g
 ## Proposal
 
 Create a mono-repository by merging the following repositories:
-- [olcs-backend](http://github.com/dvsa/olcs-backend)
-- [olcs-selfserve](http://github.com/dvsa/olcs-selfserve)
-- [olcs-internal](http://github.com/dvsa/olcs-internal)
-- [vol-docker-compose](http://github.com/dvsa/vol-docker-compose)
+
+-   [olcs-backend](http://github.com/dvsa/olcs-backend)
+-   [olcs-selfserve](http://github.com/dvsa/olcs-selfserve)
+-   [olcs-internal](http://github.com/dvsa/olcs-internal)
+-   [vol-docker-compose](http://github.com/dvsa/vol-docker-compose)
 
 Subdirectories within the mono-repository will be named without their prefixes, i.e., `api`, `selfserve`, `internal`, and `vol-docker-compose` will be replaced.
 
@@ -32,8 +33,8 @@ GitHub Action workflows will be designed to execute only on sub-projects with de
 
 ## Implementation
 
-- Create a new repository named `vol-app`.
-- Adopt a directory structure similar to the following:
+-   Create a new repository named `vol-app`.
+-   Adopt a directory structure similar to the following:
     ```
     |__ `.github`
     |       |__ `workflows/`
@@ -53,4 +54,4 @@ GitHub Action workflows will be designed to execute only on sub-projects with de
     |__ `docker-compose.yaml`
     |__ ...
     ```
-- Import repositories while retaining their git history for relevant commits during the merge.
+-   Import repositories while retaining their git history for relevant commits during the merge.

docs/rfc/rfc-002-documentation-as-code.md

@@ -15,6 +15,7 @@ Traditional documentation stored in platforms like Confluence is often difficult
 Documentation will be authored in Markdown and stored within the mono-repository (as proposed in RFC-001) under the `/docs` directory.
 
 Additional tools proposed include:
-- Utilizing the Docusaurus library to build the static site.
-- Using GitHub Pages for serving the documentation.
-- Employing GitHub Actions for deployment.
+
+-   Utilizing the Docusaurus library to build the static site.
+-   Using GitHub Pages for serving the documentation.
+-   Employing GitHub Actions for deployment.