fixes for vale

Author: m4sterbunny

spelling/.vale.ini

@@ -5,8 +5,11 @@
 
 StylesPath = ./styles
 
+# The ignore config references project-words.txt
+
 Spelling.Ignore = config/ignore/Consensys-common
 
+
 # Packages to sync with. Remember never adapt the external packages, all changes will be lost on update
 
 Packages = Microsoft, proselint, write-good
@@ -15,10 +18,11 @@ Vocab = Consensys-common
 
 # The minimum alert level to display (suggestion, warning, or error).
 # Builds not set to fail too many false positives
-MinAlertLevel = suggestion
+MinAlertLevel = warning
 
 [formats]
 mdx = md
+yaml = yml
 
 # Global settings (applied to every syntax)
 [*.{md,yml}]

spelling/README.md

@@ -39,21 +39,19 @@ be compiled to this one sot.
 
 If API specs are managed as YAML files, need to test whether Vale can handle linting YAMLs.
 
-## Testing Vale Here
-
-This heading should trigger warning for non-compliance with sentence case. Metamask should upset 
-Vale too.
-
 ## ToDo
 
+### Incorporate project-words.txt from repos
+[x] Besu
+[x] Teku
+
 ### Overrides
 
 Attempted to overcome false positives with:
 
-1. /styles/ignore which references the Consensys-common/ignore.txt text file (which should override Vale.Spelling)
-2. With styles/Consensys/Overridesyaml which is a dummy extend of "existence" to allow use of an exceptions
-list {I am not convinced this is working and its not a ssot method as it will need to repeat the ignore items 
-for Vale.Spelling}
+1. /styles/ignore which references the Consensys-common/ignore.txt text file 
+2. With styles/Consensys/ProjectWords.yml which is a dummy extend of "existence" to allow use of an exceptions
+list
 
 
 

spelling/styles/Consensys/Acronyms.yml

@@ -15,6 +15,7 @@ exceptions:
   - CLI
   - CORS
   - CPU
+  - CSS
   - CSV
   - DEBUG
   - ECDSA
@@ -26,6 +27,7 @@ exceptions:
   - GET
   - GPU
   - gRPC
+  - GTag
   - GUI
   - HEX
   - HTML
@@ -40,13 +42,14 @@ exceptions:
   - JDK
   - JRE
   - JSON
+  - JSX
   - JVM
   - KMS
   - P2P
   - PATH
   - PBFT
   - PKCS
-  - POA
+  - PoA
   - POS
   - POST
   - PostgreSQL
@@ -63,6 +66,7 @@ exceptions:
   - SSL
   - SVG
   - TCP
+  - TKBU
   - TLS
   - TOC
   - TOML

spelling/styles/Consensys/CaseSensitive-Substitution.yaml

@@ -1,5 +1,5 @@
 extends: substitution
-message: For system-specific term, consider %s instead of "%s"
+message: For component of a system or named entity, consider standard format, %s instead of "%s"
 ignorecase: false
 level: warn
 action:
@@ -11,3 +11,5 @@ swap:
   prover: Prover
   # Linea Voyage
   voyage: Voyage
+  besu: Besu
+  Dapp: dapp

spelling/styles/Consensys/Overrides.yml

@@ -0,0 +1,9 @@
+extends: substitution
+message: "Prefer Consensys style."
+level: error
+ignorecase: true
+action:
+  name: replace
+swap:
+  ′: "'"
+  ″: '"'