diff --git a/spelling/.vale.ini b/spelling/.vale.ini index 3951a01..1ece8c8 100644 --- a/spelling/.vale.ini +++ b/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,12 +32,17 @@ 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 @@ -41,8 +50,6 @@ Microsoft.Acronyms = NO # Microsoft.Avoid is not relevant Microsoft.Avoid = NO -Microsoft.Headings = YES - write-good.Weasel = NO proselint.Hyperbole = warning \ No newline at end of file diff --git a/spelling/README.md b/spelling/README.md index 4c1bfbf..fbab88f 100644 --- a/spelling/README.md +++ b/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? \ No newline at end of file +3. Can we use reject [here to prevent links being put in this format, is it covered another way? + + diff --git a/spelling/styles/Consensys/Headings.yml b/spelling/styles/Consensys/Headings.yml index 4407249..65214d0 100644 --- a/spelling/styles/Consensys/Headings.yml +++ b/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: diff --git a/spelling/styles/config/vocabularies/Consensys-common/reject.txt b/spelling/styles/config/vocabularies/Consensys-common/reject.txt index 4409bd9..f440d00 100644 --- a/spelling/styles/config/vocabularies/Consensys-common/reject.txt +++ b/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