From 81e5f864d459bb2ac8a41e0c9af74e35f6b613c1 Mon Sep 17 00:00:00 2001
From: Aiden Vaines <54067008+aidenvaines-bjss@users.noreply.github.com>
Date: Mon, 22 Jul 2024 16:58:00 +0100
Subject: [PATCH] Issue/168 Upgrade Vale (#170)

<!-- markdownlint-disable-next-line first-line-heading -->
## Description

<!-- Describe your changes in detail. -->
Upgrades Vale to v3.6 and restructure the vocab directory accordingly,
should resolve
https://github.com/nhs-england-tools/repository-template/issues/168

## Context

<!-- Why is this change required? What problem does it solve? -->
The version of Vale being used is from Nov 17, 2023 and has some bugs

## Type of changes

<!-- What types of changes does your code introduce? Put an `x` in all
the boxes that apply. -->

- [x] Refactoring (non-breaking change)
- [ ] New feature (non-breaking change which adds functionality)
- [x] Breaking change (fix or feature that would change existing
functionality)
- [x] Bug fix (non-breaking change which fixes an issue)

## Checklist

<!-- Go over all the following points, and put an `x` in all the boxes
that apply. -->

- [x] I am familiar with the [contributing
guidelines](../docs/CONTRIBUTING.md)
- [x] I have followed the code style of the project
- [ ] I have added tests to cover my changes
- [x] I have updated the documentation accordingly
- [ ] This PR is a result of pair or mob programming

---

## Sensitive Information Declaration

To ensure the utmost confidentiality and protect your and others
privacy, we kindly ask you to NOT including [PII (Personal Identifiable
Information) / PID (Personal Identifiable
Data)](https://digital.nhs.uk/data-and-information/keeping-data-safe-and-benefitting-the-public)
or any other sensitive data in this PR (Pull Request) and the codebase
changes. We will remove any PR that do contain any sensitive
information. We really appreciate your cooperation in this matter.

- [x] I confirm that neither PII/PID nor sensitive data are included in
this PR and the codebase changes.
---
 .tool-versions                                       |  3 ++-
 .../{Vocab => config/vocabularies}/words/accept.txt  | 12 ++++++------
 .../{Vocab => config/vocabularies}/words/reject.txt  |  0
 3 files changed, 8 insertions(+), 7 deletions(-)
 rename scripts/config/vale/styles/{Vocab => config/vocabularies}/words/accept.txt (100%)
 rename scripts/config/vale/styles/{Vocab => config/vocabularies}/words/reject.txt (100%)

diff --git a/.tool-versions b/.tool-versions
index 32db55a4..0c02acd7 100644
--- a/.tool-versions
+++ b/.tool-versions
@@ -2,6 +2,7 @@
 
 terraform 1.7.0
 pre-commit 3.6.0
+vale 3.6.0
 
 # ==============================================================================
 # The section below is reserved for Docker image versions.
@@ -15,7 +16,7 @@ pre-commit 3.6.0
 # docker/ghcr.io/nhs-england-tools/github-runner-image 20230909-321fd1e-rt@sha256:ce4fd6035dc450a50d3cbafb4986d60e77cb49a71ab60a053bb1b9518139a646 # SEE: https://github.com/nhs-england-tools/github-runner-image/pkgs/container/github-runner-image
 # docker/hadolint/hadolint 2.12.0-alpine@sha256:7dba9a9f1a0350f6d021fb2f6f88900998a4fb0aaf8e4330aa8c38544f04db42 # SEE: https://hub.docker.com/r/hadolint/hadolint/tags
 # docker/hashicorp/terraform 1.5.6@sha256:180a7efa983386a27b43657ed610e9deed9e6c3848d54f9ea9b6cb8a5c8c25f5 # SEE: https://hub.docker.com/r/hashicorp/terraform/tags
-# docker/jdkato/vale v2.29.7@sha256:5ccfac574231b006284513ac3e4e9f38833989d83f2a68db149932c09de85149 # SEE: https://hub.docker.com/r/jdkato/vale/tags
+# docker/jdkato/vale v3.6.0@sha256:0ef22c8d537f079633cfff69fc46f69a2196072f69cab1ab232e8a79a388e425 # SEE: https://hub.docker.com/r/jdkato/vale/tags
 # docker/koalaman/shellcheck latest@sha256:e40388688bae0fcffdddb7e4dea49b900c18933b452add0930654b2dea3e7d5c # SEE: https://hub.docker.com/r/koalaman/shellcheck/tags
 # docker/mstruebing/editorconfig-checker 2.7.1@sha256:dd3ca9ea50ef4518efe9be018d669ef9cf937f6bb5cfe2ef84ff2a620b5ddc24 # SEE: https://hub.docker.com/r/mstruebing/editorconfig-checker/tags
 # docker/sonarsource/sonar-scanner-cli 5.0.1@sha256:494ecc3b5b1ee1625bd377b3905c4284e4f0cc155cff397805a244dee1c7d575 # SEE: https://hub.docker.com/r/sonarsource/sonar-scanner-cli/tags
diff --git a/scripts/config/vale/styles/Vocab/words/accept.txt b/scripts/config/vale/styles/config/vocabularies/words/accept.txt
similarity index 100%
rename from scripts/config/vale/styles/Vocab/words/accept.txt
rename to scripts/config/vale/styles/config/vocabularies/words/accept.txt
index 2c35a52b..479da717 100644
--- a/scripts/config/vale/styles/Vocab/words/accept.txt
+++ b/scripts/config/vale/styles/config/vocabularies/words/accept.txt
@@ -1,18 +1,18 @@
+[A-Z]+s
 Bitwarden
+bot
 Cyber
 Dependabot
 Gitleaks
 Grype
+idempotence
 OAuth
 Octokit
+onboarding
 Podman
 Python
+sed
 Syft
 Terraform
-Trufflehog
-bot
-idempotence
-onboarding
-sed
 toolchain
-[A-Z]+s
+Trufflehog
diff --git a/scripts/config/vale/styles/Vocab/words/reject.txt b/scripts/config/vale/styles/config/vocabularies/words/reject.txt
similarity index 100%
rename from scripts/config/vale/styles/Vocab/words/reject.txt
rename to scripts/config/vale/styles/config/vocabularies/words/reject.txt