diff --git a/.vale.ini b/.vale.ini index 283850b8..fcd2acef 100644 --- a/.vale.ini +++ b/.vale.ini @@ -4,7 +4,7 @@ MinAlertLevel = suggestion Vocab = EPNix # External packages -Packages = alex, Google, Microsoft, proselint, Readability, RedHat, write-good +Packages = alex, Google, Microsoft, proselint, RedHat, write-good # Only Markdown and .txt files; change to whatever you're using. [*.md] # List of styles to load. @@ -20,7 +20,30 @@ RedHat.Contractions = NO # Already done by Microsoft.We Google.We = NO -# ??? corresponds to 7th grade -> 12-13 years old -Readability.AutomatedReadability = YES +# Already done by Vale.Spelling +RedHat.Spelling = NO + +# Already done by RedHat.PassiveVoice +Google.Passive = NO +Microsoft.Passive = NO +write-good.Passive = NO + +# Already done by RedHat.Definitions +Microsoft.Acronyms = NO +Google.Acronyms = NO + +# Already done by RedHat.Headings +Google.Headings = NO +Microsoft.Headings = NO + +# Already done by Microsoft.SentenceLength, which is shorter +RedHat.SentenceLength = NO + +# Already done by RedHat.Ellipses +Google.Ellipses = NO +Microsoft.Ellipses = NO + +# Already done by Microsoft.Quotes +Google.Quotes = NO write-good.E-Prime = NO diff --git a/doc/vale/Readability/AutomatedReadability.yml b/doc/vale/Readability/AutomatedReadability.yml deleted file mode 100644 index dd9fe669..00000000 --- a/doc/vale/Readability/AutomatedReadability.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: metric -message: "Try to keep the Automated Readability Index (%s) below 8." -link: https://en.wikipedia.org/wiki/Automated_readability_index - -formula: | - (4.71 * (characters / words)) + (0.5 * (words / sentences)) - 21.43 - -condition: "> 8" diff --git a/doc/vale/Readability/ColemanLiau.yml b/doc/vale/Readability/ColemanLiau.yml deleted file mode 100644 index d478303c..00000000 --- a/doc/vale/Readability/ColemanLiau.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: metric -message: "Try to keep the Coleman–Liau Index grade (%s) below 9." -link: https://en.wikipedia.org/wiki/Coleman%E2%80%93Liau_index - -formula: | - (0.0588 * (characters / words) * 100) - (0.296 * (sentences / words) * 100) - 15.8 - -condition: "> 9" diff --git a/doc/vale/Readability/FleschKincaid.yml b/doc/vale/Readability/FleschKincaid.yml deleted file mode 100644 index 3f60f205..00000000 --- a/doc/vale/Readability/FleschKincaid.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: metric -message: "Try to keep the Flesch–Kincaid grade level (%s) below 8." -link: https://en.wikipedia.org/wiki/Flesch%E2%80%93Kincaid_readability_tests - -formula: | - (0.39 * (words / sentences)) + (11.8 * (syllables / words)) - 15.59 - -condition: "> 8" diff --git a/doc/vale/Readability/FleschReadingEase.yml b/doc/vale/Readability/FleschReadingEase.yml deleted file mode 100644 index 61797667..00000000 --- a/doc/vale/Readability/FleschReadingEase.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: metric -message: "Try to keep the Flesch reading ease score (%s) above 70." -link: https://en.wikipedia.org/wiki/Flesch%E2%80%93Kincaid_readability_tests - -formula: | - 206.835 - (1.015 * (words / sentences)) - (84.6 * (syllables / words)) - -condition: "< 70" diff --git a/doc/vale/Readability/GunningFog.yml b/doc/vale/Readability/GunningFog.yml deleted file mode 100644 index 302c0eeb..00000000 --- a/doc/vale/Readability/GunningFog.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: metric -message: "Try to keep the Gunning-Fog index (%s) below 10." -link: https://en.wikipedia.org/wiki/Gunning_fog_index - -formula: | - 0.4 * ((words / sentences) + 100 * (complex_words / words)) - -condition: "> 10" diff --git a/doc/vale/Readability/LIX.yml b/doc/vale/Readability/LIX.yml deleted file mode 100644 index f5b0f4e8..00000000 --- a/doc/vale/Readability/LIX.yml +++ /dev/null @@ -1,17 +0,0 @@ -extends: metric -message: "Try to keep the LIX score (%s) below 35." - -link: https://en.wikipedia.org/wiki/Lix_(readability_test) -# Very Easy: 20 - 25 -# -# Easy: 30 - 35 -# -# Medium: 40 - 45 -# -# Difficult: 50 - 55 -# -# Very Difficult: 60+ -formula: | - (words / sentences) + ((long_words * 100) / words) - -condition: "> 35" diff --git a/doc/vale/Readability/SMOG.yml b/doc/vale/Readability/SMOG.yml deleted file mode 100644 index e7f5913b..00000000 --- a/doc/vale/Readability/SMOG.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: metric -message: "Try to keep the SMOG grade (%s) below 10." -link: https://en.wikipedia.org/wiki/SMOG - -formula: | - 1.0430 * math.sqrt((polysyllabic_words * 30.0) / sentences) + 3.1291 - -condition: "> 10" diff --git a/doc/vale/Readability/meta.json b/doc/vale/Readability/meta.json deleted file mode 100644 index 0ff71c30..00000000 --- a/doc/vale/Readability/meta.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "feed": "https://github.com/errata-ai/Readability/releases.atom", - "vale_version": ">=2.13.0" -} \ No newline at end of file diff --git a/doc/vale/RedHat/CaseSensitiveTerms.yml b/doc/vale/RedHat/CaseSensitiveTerms.yml index 5039ef07..ae2659c9 100644 --- a/doc/vale/RedHat/CaseSensitiveTerms.yml +++ b/doc/vale/RedHat/CaseSensitiveTerms.yml @@ -9,18 +9,27 @@ action: name: replace swap: "(?