Vale test suite

.github/workflows/test-vale-styles.yml

@@ -9,15 +9,38 @@ jobs:
   npm-test:
     runs-on: ubuntu-latest
     steps:
+      - name: install asciidoctor
+        run: |
+          sudo apt-get install -y asciidoctor
+
+      - name: install vale
+        run: |
+          sudo snap install vale
+
       - name: checkout repo
         uses: actions/checkout@v4
 
       - uses: actions/setup-node@v4
         with:
           node-version: 22
 
+      - name: diagnose Vale
+        working-directory: ./ValeStyles
+        run: |
+          vale -v
+          vale ls-dirs
+          vale ls-config
+          vale ls-vars
+
       - name: npm test
         working-directory: ./ValeStyles
         run: |
           npm ci
           npm test
+
+      - name: Upload Vale HTML test
+        uses: actions/upload-artifact@v4
+        with:
+          name: Vale HTML test results
+          path: ValeStyles/test/adoc/styles.html
+          if-no-files-found: error

ValeStyles/.gitignore

@@ -0,0 +1 @@
+**/*.actual

ValeStyles/.vale.ini

@@ -0,0 +1,32 @@
+StylesPath = "."
+MinAlertLevel = suggestion 
+
+Vocab = Couchbase
+
+[asciidoctor]
+description = YES
+docname = YES
+doctitle = YES
+doctype = YES
+docfile = YES
+example-caption = YES
+figure-caption = YES
+important-caption = YES
+listing-caption = YES
+note-caption = YES
+outfile = YES
+part-signifier = YES
+preface-title = YES
+table-caption = YES
+tip-caption = YES
+toc-title = YES
+warning-caption = YES
+
+experimental = YES
+
+attribute-missing = drop
+
+[*.{adoc,md,txt}]
+BasedOnStyles = Vale, write-good, proselint, Couchbase, Google
+
+Vale.Spelling = NO

ValeStyles/Couchbase/Button.yml

@@ -2,6 +2,7 @@ extends: existence
 message: "Do not refer to a UI element with the word 'button', as in 'Click the Edit button'. Make sure to use the button macro (btn:[])."
 level: error
 link: https://docs.couchbase.com/styleguide/button-macro.html
+scope: raw
 
 tokens:
-  - '(?i)\bclick the(?: \*?[\w-]+\*?)* button\b'
+  - '(?i)\bclick the \*?[\w -]+\*? button\b'

ValeStyles/Couchbase/ButtonMacro.yml

@@ -3,6 +3,7 @@ message: Did you follow the guidelines for the button macro?
 link: https://docs.couchbase.com/styleguide/button-macro.html
 nonword: true
 level: suggestion
+scope: raw
 
 tokens: 
   - btn\:\[.+\]

ValeStyles/Couchbase/Contractions.yml

@@ -10,7 +10,6 @@ swap:
   how is: how's
   that is: that's
   they are: they're
-  we are: we're
   what is: what's
   where is: where's
   who is: who's

ValeStyles/Couchbase/Dialogs.yml

@@ -2,9 +2,9 @@ extends: existence
 message: Don't bold or capitalize the word "dialog".
 link: https://docs.couchbase.com/styleguide/dialogs.html
 level: error 
-nonword: true
 scope: raw
+nonword: true
 
 tokens: 
-  - '\*.+[Dd]ialog\*'
-  - '\*.+\*\sDialog'
+  - '\*[^*]*[Dd]ialog[^*]*\*'
+  - '\bDialog\b'

ValeStyles/Couchbase/DirectionalLanguage.yml

@@ -2,6 +2,7 @@ extends: existence
 message: Avoid directional language like '%s'.
 level: warning 
 link: https://docs.couchbase.com/styleguide/directional-language.html
+ignorecase: true
 
 tokens: 
   - left

ValeStyles/Couchbase/Dropdown.yml

@@ -5,5 +5,6 @@ level: error
 tokens: 
   - dropdown
   - drop down
+  - drop-down
   - dropdowns
-  - drop downs
+  - drop downs

ValeStyles/Couchbase/Italics.yml

@@ -1,9 +1,10 @@
 extends: existence
 message: Don't use italics. Find another way to add emphasis.
-level: error
 link: https://docs.couchbase.com/styleguide/italic.html
-scope: 
-  - raw
+scope: raw
+nonword: true
+level: error
+
 tokens:
   - '(?<!`)\b_\w.*?_\b(?!`)'
-  - '\|\s*_(.*?)_'
+  - '\|\s*_(.*?)_'

ValeStyles/Couchbase/Link.yml

@@ -4,4 +4,4 @@ level: error
 link: https://docs.couchbase.com/styleguide/ui-links.html
 
 tokens: 
-  - '(?i)\bclick the(?: \*?[\w-]+\*?)* link\b'
+  - '(?i)\bclick the(?: \*?[\w-]+\*?)* link\b'

ValeStyles/Couchbase/UnexplainedAcronym.yml

@@ -2,7 +2,7 @@ extends: conditional
 message: "'%s' hasn't been defined. Spell it out if it's unfamiliar to the audience."
 link: 'https://developers.google.com/style/abbreviations'
 level: error
-scope: text
+# scope: text
 ignorecase: false
 # Ensures that the existence of 'first' implies the existence of 'second'.
 first: '\b([A-Z]{3,5})\b'
@@ -94,7 +94,7 @@ exceptions:
   - NEST
   - NOT 
   - NOTE
-  - NULL 
+  - "NULL" # because YAML
   - NULLS
   - NVDA
   - ORDER
@@ -167,4 +167,4 @@ exceptions:
   - XOR
   - XSS
   - YAML
-  - ZIP
+  - ZIP

ValeStyles/Couchbase/Values.yml

@@ -2,7 +2,9 @@ extends: existence
 message: When comparing or describing a value, use 'greater' or 'less'.
 level: warning
 link: https://docs.couchbase.com/styleguide/values.html
+scope:
+  - raw # nothing is flagged if this is set to 'text'???
 
 tokens:
   - '\b(?:above|below|higher|lower)\b\s+\d+(?:\.\d+)?'
-  - '\b(?:above|below|higher|lower)\b(?:\s+the|\s+than)?(?:\s+\w+){0,5}?\s+(?:limit|threshold|maximum|minimum|cap|ceiling|floor|boundary|cutoff)\b'
+  - '\b(?:above|below|higher|lower)\b(?:\s+the|\s+than)?(?:\s+\w+){0,5}?\s+(?:limit|threshold|maximum|minimum|cap|ceiling|floor|boundary|cutoff)\b'