diff --git a/.vale.ini b/.vale.ini index e6eeffbd17..197e583a67 100644 --- a/.vale.ini +++ b/.vale.ini @@ -23,7 +23,7 @@ SkippedScopes = script, style, pre, figure # Styles to load # -------------- # What styles, located in the StylesPath folder, should Vale load? -BasedOnStyles = CheDocs,PlainLanguage,Vale,proselint,write-good,Microsoft,IBM +BasedOnStyles = CheDocs,IBM,Vale # Enabling or disabling specific rules in a style @@ -37,18 +37,18 @@ BasedOnStyles = CheDocs,PlainLanguage,Vale,proselint,write-good,Microsoft,IBM # CheDocs.CommonTerms = NO # CheDocs.Links-che6 = NO # CheDocs.Links = NO -# Microsoft.Foreign = NO -# Microsoft.HeadingPunctuation = NO -# Microsoft.Spacing = NO -# PlainLanguage.PassiveVoice = NO -# PlainLanguage.SentenceLength = NO -# PlainLanguage.Slash = NO -# PlainLanguage.Wordiness = NO -# PlainLanguage.Words = NO -# proselint.Annotations = NO -# proselint.Spelling = NO -# proselint.Very = NO -# write-good.ThereIs = NO +# CheDocs.SentenceLength = NO +# IBM.Foreign = NO +# IBM.HeadingPunctuation = NO +# IBM.Spacing = NO +# IBM.PassiveVoice = NO +# IBM.Slash = NO +# IBM.Wordiness = NO +# IBM.Words = NO +# IBM.Annotations = NO +# IBM.Spelling = NO +# IBM.Very = NO +# IBM.ThereIs = NO # IBM.terms = NO # IBM.Usage = NO Vale.Spelling = YES diff --git a/.vale/styles/PlainLanguage/SentenceLength.yml b/.vale/styles/CheDocs/SentenceLength.yml similarity index 91% rename from .vale/styles/PlainLanguage/SentenceLength.yml rename to .vale/styles/CheDocs/SentenceLength.yml index 0bd5a09773..c94febc965 100644 --- a/.vale/styles/PlainLanguage/SentenceLength.yml +++ b/.vale/styles/CheDocs/SentenceLength.yml @@ -3,6 +3,7 @@ extends: occurrence message: 'Keep sentences short and to the point' description: 'A good rule-of-thumb is to break up any sentence longer than 21 words into two or more separate thoughts.' scope: sentence +source: PLainLanguage level: warning max: 21 token: '\b(\w+)\b' diff --git a/.vale/styles/proselint/Annotations.yml b/.vale/styles/IBM/Annotations.yml similarity index 87% rename from .vale/styles/proselint/Annotations.yml rename to .vale/styles/IBM/Annotations.yml index 70e98c60b1..a8c06f5c3b 100644 --- a/.vale/styles/proselint/Annotations.yml +++ b/.vale/styles/IBM/Annotations.yml @@ -3,6 +3,7 @@ extends: existence message: "'%s' left in text." ignorecase: false level: error +source: proselint tokens: - XXX - FIXME diff --git a/.vale/styles/Microsoft/Foreign.yml b/.vale/styles/IBM/Foreign.yml similarity index 94% rename from .vale/styles/Microsoft/Foreign.yml rename to .vale/styles/IBM/Foreign.yml index edb314760c..6bd25e67ad 100644 --- a/.vale/styles/Microsoft/Foreign.yml +++ b/.vale/styles/IBM/Foreign.yml @@ -6,6 +6,7 @@ level: error nonword: true action: name: replace +source: Microsoft swap: '\b(?:eg|e\.g\.)[\s,]': for example '\b(?:ie|i\.e\.)[\s,]': that is diff --git a/.vale/styles/Microsoft/HeadingPunctuation.yml b/.vale/styles/IBM/HeadingPunctuation.yml similarity index 93% rename from .vale/styles/Microsoft/HeadingPunctuation.yml rename to .vale/styles/IBM/HeadingPunctuation.yml index 7873a9119b..f47bd827ab 100644 --- a/.vale/styles/Microsoft/HeadingPunctuation.yml +++ b/.vale/styles/IBM/HeadingPunctuation.yml @@ -4,6 +4,7 @@ link: https://docs.microsoft.com/en-us/style-guide/punctuation/periods nonword: true level: warning scope: heading +source: Microsoft action: name: edit params: diff --git a/.vale/styles/proselint/README.md b/.vale/styles/IBM/README-proselint.md similarity index 100% rename from .vale/styles/proselint/README.md rename to .vale/styles/IBM/README-proselint.md diff --git a/.vale/styles/write-good/README.md b/.vale/styles/IBM/README-write-good.md similarity index 100% rename from .vale/styles/write-good/README.md rename to .vale/styles/IBM/README-write-good.md diff --git a/.vale/styles/PlainLanguage/Slash.yml b/.vale/styles/IBM/Slash.yml similarity index 84% rename from .vale/styles/PlainLanguage/Slash.yml rename to .vale/styles/IBM/Slash.yml index 9d718c06a5..07df5ba8fc 100644 --- a/.vale/styles/PlainLanguage/Slash.yml +++ b/.vale/styles/IBM/Slash.yml @@ -3,5 +3,6 @@ extends: existence message: "Use either 'or' or 'and' in '%s'" ignorecase: true level: error +source: PlainLanguage tokens: - '\w+/\w+' diff --git a/.vale/styles/Microsoft/Spacing.yml b/.vale/styles/IBM/Spacing.yml similarity index 92% rename from .vale/styles/Microsoft/Spacing.yml rename to .vale/styles/IBM/Spacing.yml index bbd10e51df..c86a760eff 100644 --- a/.vale/styles/Microsoft/Spacing.yml +++ b/.vale/styles/IBM/Spacing.yml @@ -3,6 +3,7 @@ message: "'%s' should have one space." link: https://docs.microsoft.com/en-us/style-guide/punctuation/periods level: error nonword: true +source: Microsoft tokens: - '[a-z][.?!] {2,}[A-Z]' - '[a-z][.?!][A-Z]' diff --git a/.vale/styles/proselint/Spelling.yml b/.vale/styles/IBM/Spelling.yml similarity index 95% rename from .vale/styles/proselint/Spelling.yml rename to .vale/styles/IBM/Spelling.yml index 7a4de8f8ec..4fd8054fc0 100644 --- a/.vale/styles/proselint/Spelling.yml +++ b/.vale/styles/IBM/Spelling.yml @@ -3,6 +3,7 @@ extends: consistency message: "Use General American spelling of '%s'." level: error ignorecase: true +source: proselint either: advisor: adviser analyse: analyze diff --git a/.vale/styles/write-good/ThereIs.yml b/.vale/styles/IBM/ThereIs.yml similarity index 88% rename from .vale/styles/write-good/ThereIs.yml rename to .vale/styles/IBM/ThereIs.yml index 82d20295e6..6a4002b903 100644 --- a/.vale/styles/write-good/ThereIs.yml +++ b/.vale/styles/IBM/ThereIs.yml @@ -3,5 +3,6 @@ extends: existence message: "Don't start a sentence with '%s'" ignorecase: true level: error +source: write-good raw: - '(?:^[^\w]*|[;-]\s)There\b\s(is|are)\b' diff --git a/.vale/styles/proselint/Very.yml b/.vale/styles/IBM/Very.yml similarity index 83% rename from .vale/styles/proselint/Very.yml rename to .vale/styles/IBM/Very.yml index c6c01e9224..b3f50c3be3 100644 --- a/.vale/styles/proselint/Very.yml +++ b/.vale/styles/IBM/Very.yml @@ -3,5 +3,6 @@ extends: existence message: "Remove '%s'." ignorecase: true level: error +source: proselint tokens: - very diff --git a/.vale/styles/PlainLanguage/Wordiness.yml b/.vale/styles/IBM/Wordiness.yml similarity index 99% rename from .vale/styles/PlainLanguage/Wordiness.yml rename to .vale/styles/IBM/Wordiness.yml index 477656a005..9d0535c2f4 100644 --- a/.vale/styles/PlainLanguage/Wordiness.yml +++ b/.vale/styles/IBM/Wordiness.yml @@ -3,6 +3,7 @@ extends: substitution message: Consider using '%s' instead of '%s' ignorecase: true level: warning +source: PlainLanguage swap: (?:give|gave) rise to: lead to (?:previous|prior) to: before diff --git a/.vale/styles/PlainLanguage/Words.yml b/.vale/styles/IBM/Words.yml similarity index 83% rename from .vale/styles/PlainLanguage/Words.yml rename to .vale/styles/IBM/Words.yml index 9c188681e7..8aae769367 100644 --- a/.vale/styles/PlainLanguage/Words.yml +++ b/.vale/styles/IBM/Words.yml @@ -3,5 +3,6 @@ extends: substitution message: Use '%s' instead of '%s.' level: error ignorecase: true +source: PlainLanguage swap: shall: must