From 42132590bb1fbc155dca6260139c2c520d8e2df9 Mon Sep 17 00:00:00 2001 From: Karel van Klink <karel.vanklink@geant.org> Date: Thu, 28 Nov 2024 11:56:13 +0100 Subject: [PATCH] update vale config --- vale/.vale.ini | 25 +++++++++++-------- .../config/vocabularies/Sphinx/accept.txt | 5 ---- 2 files changed, 15 insertions(+), 15 deletions(-) delete mode 100644 vale/styles/config/vocabularies/Sphinx/accept.txt diff --git a/vale/.vale.ini b/vale/.vale.ini index 063fe579..305a1b4b 100644 --- a/vale/.vale.ini +++ b/vale/.vale.ini @@ -2,26 +2,28 @@ StylesPath = styles MinAlertLevel = suggestion -Vocab = geant-jargon, Sphinx +Vocab = geant-jargon Packages = proselint, Microsoft +[*] +; Replacing a ... with … shouldn't be holding back the entire CI pipeline +proselint.Typography = warning +; Same applies for not using contractions, the custom package actually lints in the opposite direction +Microsoft.Contractions = NO +custom.Contractions = YES +; Found to be too intrusive +Microsoft.Passive = NO +; We are not a general audience +Microsoft.GeneralURL = NO + [*.{py,rst}] ; We only lint .rst and .py files BasedOnStyles = Vale, proselint, Microsoft ; Some headers are generated and we have no real influence over them Microsoft.Headings = NO -; Found to be too intrusive -Microsoft.Passive = NO -; We are not a general audience -Microsoft.GeneralURL = NO ; It's okay to leave TODOs in the code, that's what they're for proselint.Annotations = NO -; Replacing a ... with … shouldn't be holding back the entire CI pipeline -proselint.Typography = warning -; Same applies for not using contractions -Microsoft.Contractions = NO -custom.Contractions = YES ; Using a "regular" - instead of an en dash is totally fine Microsoft.Negative = NO Microsoft.RangeFormat = NO @@ -36,5 +38,8 @@ Microsoft.Contractions = NO custom.Contractions = YES Microsoft.Passive = NO +[*.md] +BasedOnStyles = Vale, proselint, Microsoft + [formats] py = rst diff --git a/vale/styles/config/vocabularies/Sphinx/accept.txt b/vale/styles/config/vocabularies/Sphinx/accept.txt deleted file mode 100644 index 11d98e59..00000000 --- a/vale/styles/config/vocabularies/Sphinx/accept.txt +++ /dev/null @@ -1,5 +0,0 @@ -toctree -[Ss]ubpackages -virtualenv -[Pp]revious -mypy -- GitLab