feat: add test framework (#157)

* fix: scope of specific rules

* fix: spelling scoping

* fix: spelling ignores

* feat: customise spelling filters

* chore: revert hyphenated words inclusion

* feat: add POC tests

* feat: improve test framework

* feat: add tests

* chore: backup initial tests

* feat: implement copilot assisted test suite

* fix: remove blockignore

* Apply suggestions from code review

chore: apply review suggestions

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* feat: testing and rule update

* feat: rule 004 testing update

* chore: add comment regarding missing rules

* fix: apply suggested changes

* fix: test case name

* fix: clarify rule

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: SecondSkoll

.github/workflows/pytest.yml

@@ -0,0 +1,39 @@
+name: Vale + Pytest
+
+on:
+  pull_request:
+    branches: [ main ]
+  # Allow manual trigger
+  workflow_dispatch: {}
+
+permissions:
+  contents: read
+
+jobs:
+  tests:
+    name: Pytest (Vale rules)
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [ '3.10', '3.12' ] 
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: 'pip'
+
+      - name: Install Python dependencies
+        run: |
+          pip install -r tests/requirements.txt
+
+      - name: Run pytest suite
+        env:
+          # Set to 1 once manifest covers ALL style rules to enforce coverage.
+          VALE_ENFORCE_COVERAGE: 0
+        run: |
+          python -m pytest -q || python -m pytest -vv
+

.gitignore

@@ -1,3 +1,7 @@
 node_modules
 coverage
 build/
+.venv
+.vscode
+.pytest_cache/
+tests/__pycache__/

getting-started.md

@@ -147,3 +147,12 @@ in the root directory `documentation-style-guide/`.
 **My rule isn't getting applied to the text**
 * Make sure the rule file uses the extension `.yml` instead of `.yaml`
 * There might be a hidden syntax issue - consider using a local YAML linter or [online tool](https://jsonformatter.org/yaml-validator) to validate your rule.
+
+### Conditionally ignoring rules
+
+Some rules can be ignored conditionally, these conditions can come in a variety
+of forms.
+
+Rulesets that extend the default `existence` rule can use the dictionary to
+ignore specific terms (including hyphenated terms or terms consisting of
+multiple words).

styles/Canonical/003-Ubuntu-names-versions.yml

@@ -6,6 +6,7 @@ message: |
 link: https://docs.ubuntu.com/styleguide/en/#ubuntu
 nonword: true
 ignorecase: true
+vocab: false
 scope: 
   - sentence
   - list

styles/Canonical/004-Canonical-product-names.yml

@@ -1,20 +1,20 @@
 extends: substitution
-message: "Use '%s' instead of '%s'"
+message: "Use '%[1]s' instead of '%[2]s'"
 link: https://docs.ubuntu.com/styleguide/en/#other-canonical-products
-ignorecase: true
 level: error
 scope:
   - sentence & ~blockquote
   - list
   - heading
   - table.header
   - table.cell
-action:
-  name: replace
+ignorecase: true
+nonword: true
 swap:
-  Anbox Cloud: Anbox Cloud
+  "(?<=Anbox )Cloud": "Cloud" # Because Anbox is a dictionary term, multi-word capture does not work
   Anbox: Anbox
-  Charmed Kubeflow: Charmed Kubeflow
+  Kubeflow: "Kubeflow"
+  "Charmed(?= kubeflow)": "Charmed"
   Canononical Observability Stack: Canonical Observability Stack
   Juju: Juju
   Landscape(?! environment| layout): Landscape
@@ -27,8 +27,12 @@ swap:
   MicroOVN: MicroOVN
   MicroStack: MicroStack
   Multipass: Multipass
+  (?<=Canonical )Observability Stack: Observability Stack
   Snapcraft: Snapcraft
-  snapd: snapd
+  snapd: snapd # Vale seems to allow normal capitalisation, may need specific existence rule for Snapd
   Ubuntu Core: Ubuntu Core
-  Ubuntu Pro: Ubuntu Pro
+  (?<=Ubuntu )Pro: Pro
   Ubuntu Server: Ubuntu Server
+
+# Not working with multi-word terms that have the first word in the accept list
+# Workaround is to positive lookbehind for the term

styles/Canonical/025a-latinisms-with-english-equivalents.yml

@@ -1,19 +1,16 @@
-# 025 - Latinisms that have English equivalents
-
 extends: substitution
 message: "Instead of '%[2]s', use %[1]s."
 link: https://docs.ubuntu.com/styleguide/en#latin-words-and-phrases
-level: suggestion
+level: error
 scope:
   - sentence
   - list
   - heading
   - table.header
   - table.cell
-nonword: true
 ignorecase: true
-swap:
-  \ba\spriori\b: "'self-evident', 'presupposed', 'presumed', or 'assumed'"
+swap: # Multiple word terms need to use "this\\sword" to match properly
+  "a\\spriori": "'self-evident', 'presupposed', 'presumed', or 'assumed'"
   \bad\shoc\b: "'unscheduled', 'unexpected', 'improvised', 'temporary', or 'bespoke'"
   \bad\sinfinitum\b: "'and so on', 'to the fullest extent', or 'recursively'"
   \bcf\.?\b: "'refer to'"
@@ -39,4 +36,4 @@ swap:
   \b(?:versus|vs\.(?!\w)|vs(?![\.\w])): "'compared to/with' or 'opposed to'"
   \bvia\b: "'through', 'with', or 'using'"
   \bvice\sversa\b: "'the reverse' or 'the other way around'"
-  \b(viz\.(?!\w)|viz(?![\w\.])): "'specifically' or 'namely'"
+  \b(?:viz\.(?!\w)|viz(?![\w\.])): "'specifically' or 'namely'"

styles/Canonical/400-Enforce-inclusive-terms.yml

@@ -18,7 +18,7 @@ tokens:
   - (?<!jenkins\-)slaves?
   - chairman
   - foreman
-  - dumm(y|ies)
+  - dum(b|my|mies)
   - grandfather(ed)?
   - guys?
   - hangs?

styles/Canonical/500-Repeated-words.yml

@@ -10,4 +10,7 @@ scope:
 alpha: true
 ignorecase: true
 tokens:
-  - '[^\s]+'
+  - '(\w\n?)+'
+
+
+  ## Currently not detecting across multiple lines

styles/config/vocabularies/Canonical/accept.txt

@@ -177,6 +177,7 @@ Linkerd
 Linux
 LinuxONE
 Livepatch
+LTS
 LTV
 LXC
 LXD
@@ -295,7 +296,7 @@ SLA
 SMTP
 Snapcraft
 snapcrafting
-Snapd
+snapd
 Snap Store Proxy
 SOW
 Spark

styles/config/vocabularies/Canonical/reject.txt

@@ -1 +1,2 @@
-ROCKcraft
+ROCKcraft
+Snapd