Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Vale issues 'config/vocabularies/words' directory does not exist #168

Closed
3 tasks done
aidenvaines-bjss opened this issue Jul 8, 2024 · 1 comment · Fixed by #170
Closed
3 tasks done

Vale issues 'config/vocabularies/words' directory does not exist #168

aidenvaines-bjss opened this issue Jul 8, 2024 · 1 comment · Fixed by #170
Labels
bug Something isn't working triage

Comments

@aidenvaines-bjss
Copy link
Contributor

Is there an existing issue for this?

  • I have searched the existing Issues

Current Behavior

When CI runs '.github/actions/check-english-usage/action.yaml' action, the command check=all ./scripts/githooks/check-english-usage.sh fails with this error:

E100 [vocab] Runtime error

'config/vocabularies/words' directory does not exist

Expected Behavior

Actual output should look like this:

❯ check=branch ./scripts/githooks/check-english-usage.sh

 docs/pages/terraform-csis/index.md
 19:321  error  Did you really mean             Vale.Spelling 
                'longword'?                                
 21:26   error  Did you really mean 'xyz'?    Vale.Spelling 
 34:60   error  Did you really mean 'abc'?   Vale.Spelling 

✖ 3 errors, 0 warnings and 0 suggestions in 4 files.

Steps To Reproduce

make some spelling mistakes in repo. run check=branch ./scripts/githooks/check-english-usage.sh

Visible on this internal PR https://github.com/NHSDigital/nhs-notify-internal/actions/runs/9810021470/job/27089235437?pr=61 should you have access

Output

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct

Sensitive Information Declaration

  • I confirm that neither PII/PID nor sensitive data are included in this form
@aidenvaines-bjss aidenvaines-bjss added bug Something isn't working triage labels Jul 8, 2024
@aidenvaines-bjss
Copy link
Contributor Author

The latest vale container jdkato/vale is 3.6.0, the 2.29.7 pinned release is well over a year old

I had vale installed locally so the `scripts/githooks/check-english-usage.sh' script was picking that up over using the container.

According to the documentation:https://vale.sh/docs/topics/vocab/

In versions of Vale prior to 3.0, vocabularies were stored in /Vocab. When upgrading from an older version of Vale, you’ll need to move your vocabularies to the new /config/vocabularies location.

the .tool-versions file does contain this line
# docker/jdkato/vale v2.29.7@sha256:5ccfac574231b006284513ac3e4e9f38833989d83f2a68db149932c09de85149 # SEE: https://hub.docker.com/r/jdkato/vale/tags

PR incoming to increase the version and fix the folder structures to be 3.0+ compliant

github-merge-queue bot pushed a commit that referenced this issue Jul 22, 2024
<!-- 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
#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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working triage
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant