Merge pull request #14 from Consensys/update-vale

Updates for vale

spelling/.vale.ini

@@ -1,16 +1,20 @@
 # Vale configuration
-
-# Styles directory
 # See vale_styles/README.md file for details and licencing information
+
+# Styles directory for all packages and config (vocab) files
+
 StylesPath = ./styles
 
-Packages = proselint, Microsoft, write-good
+
+# Packages to sync with. Remember never adapt these packages, all changes will be lost on update
+
+Packages = Microsoft, proselint, write-good
 
 Vocab = Consensys-common
 
 # The minimum alert level to display (suggestion, warning, or error).
 # CI builds will only fail on error-level alerts.
-MinAlertLevel = warning
+MinAlertLevel = suggestion
 
 [formats]
 mdx = md
@@ -28,21 +32,24 @@ TokenIgnores = ({![^!}]+!}),\
   (:[a-z\-]+:)
 
 # List of styles to load
-BasedOnStyles = Vale, proselint, write-good, Microsoft, Consensys
 
-# Style.Rule = {YES, NO} to enable or disable a specific rule
-Microsoft.Contractions = warning
+[*.md]
+BasedOnStyles = Vale, Microsoft, Consensys, proselint, write-good
+
+# Allows Consensys Headings to take precedence
+Microsoft.Headings = No 
 
-Microsoft.GeneralURL = NO
+# Allows Microsoft passive to take precedence
+write-good.Passive = No
+
+Microsoft.Contractions = warning
 
 # Microsoft.Acronyms is replaced by Consensys list
 Microsoft.Acronyms = NO
 
 # Microsoft.Avoid is not relevant
 Microsoft.Avoid = NO
 
-Microsoft.Headings = YES
-
 write-good.Weasel = NO
 
 proselint.Hyperbole = warning

spelling/README.md

@@ -53,4 +53,6 @@ Vale too.
 
 ### General
 2. Will links be false positives, e.g. Can linting for " CLI" work to avoid false positives for links?
-3. Can we use reject [here to prevent links being put in this format, is it covered another way?
+3. Can we use reject [here to prevent links being put in this format, is it covered another way?
+
+

spelling/styles/Consensys/Headings.yml

@@ -1,7 +1,7 @@
 extends: capitalization
 message: "'%s' should use sentence-style capitalization."
 link: 'https://docs.microsoft.com/en-us/style-guide/capitalization'
-level: suggestion
+level: warning
 scope: heading
 match: $sentence
 indicators:

spelling/styles/config/vocabularies/Consensys-common/reject.txt

@@ -36,7 +36,7 @@ Lib[sS]odium
 log[bB]ack|logBack
 log[sS]tash
 merkle
-[mM]etamask|[mM]eta[ -][mM]ask
+# [mM]etamask|[mM]eta[ -][mM]ask
 orion
 [pP]egaSys
 p[ -][cC]hain