diff --git a/styles/RedHat/Abbreviations.yml b/styles/RedHat/Abbreviations.yml deleted file mode 100644 index 102fee4..0000000 --- a/styles/RedHat/Abbreviations.yml +++ /dev/null @@ -1,9 +0,0 @@ ---- -extends: existence -level: error -link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/abbreviations/ -message: "Do not use periods in all-uppercase abbreviations such as '%s'." -nonword: true -# source: "IBM - Periods with abbreviations, p. 5" -tokens: - - '\b(?:[A-Z]\.){3,5}' diff --git a/styles/RedHat/CaseSensitiveTerms.yml b/styles/RedHat/CaseSensitiveTerms.yml deleted file mode 100644 index 3e451ff..0000000 --- a/styles/RedHat/CaseSensitiveTerms.yml +++ /dev/null @@ -1,327 +0,0 @@ ---- -extends: substitution -ignorecase: false -level: error -link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/casesensitiveterms/ -message: "Use '%s' rather than '%s'." -action: - name: replace -swap: - "(?{7}\s.*$' diff --git a/styles/RedHat/ObviousTerms.yml b/styles/RedHat/ObviousTerms.yml deleted file mode 100644 index fd3f2a3..0000000 --- a/styles/RedHat/ObviousTerms.yml +++ /dev/null @@ -1,16 +0,0 @@ ---- -extends: existence -level: suggestion -# link: -message: "Consider not documenting %s because it is self-explanatory." -scope: sentence -# source: -action: - name: remove -tokens: - - 'User field' - - 'Username field' - - 'Password field' - - 'Mail field' - - 'Description field' - - 'Name field' diff --git a/styles/RedHat/OxfordComma.yml b/styles/RedHat/OxfordComma.yml deleted file mode 100644 index 2f9d108..0000000 --- a/styles/RedHat/OxfordComma.yml +++ /dev/null @@ -1,9 +0,0 @@ ---- -extends: existence -level: suggestion -link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/oxfordcomma/ -message: "Use the Oxford comma in '%s'." -scope: sentence -nonword: true -tokens: - - '(?:[^\s,]+,){1,} \w+ (?:and|or) \w+[.?!]' diff --git a/styles/RedHat/PascalCamelCase.yml b/styles/RedHat/PascalCamelCase.yml deleted file mode 100644 index a2f3ea1..0000000 --- a/styles/RedHat/PascalCamelCase.yml +++ /dev/null @@ -1,190 +0,0 @@ ---- -extends: existence -ignorecase: false -level: suggestion -scope: [list, sentence] -link: https://redhat-documentation.github.io/asciidoc-markup-conventions -message: "Consider wrapping this Pascal or Camel case term ('%s') in backticks." -# source: https://github.com/redhat-documentation/vale-at-red-hat/tree/main/.vale/styles/RedHat/PascalCamelCase.yml -tokens: - #PascalCase - - ([A-Z]+[a-z]+){2,} - - ([A-Z]+[a-z]+[A-Z]+){1,} - - ([A-Z]+[A-Z]+[a-z]+){1,} - #camelCase - - ([a-z]+)([A-Z]+[a-z]+){1,} -exceptions: - - '\b[A-Z]{2,}s?' - - 'vCPUs?' - - 3scale - - AGPLv - - AMQ - - API - - AppStream - - AsciiDoc - - AssertJ - - BaseOS - - BitBucket - - BlueStore - - CaaS - - camelCase - - CapEx - - CentOS - - CephFS - - CheckTree - - ClassLoader - - CloudForms - - CodeReady - - ConfigMaps? - - ConnectX - - Convert2RHEL - - CoreOS - - DaemonSet - - DDoS - - DevOps - - DevWorkspace - - DNSSec - - eServer - - eXpress - - eXtenSion - - FaaS - - FCoE - - FileStore - - FireWire - - FreeRADIUS - - GbE - - GBps - - GiB - - GitHub - - GitLab - - GitOps - - GlusterFS - - GNUPro - - GnuTLS - - GraalVM - - GraphQL - - GTID - - HashBase - - HdrHistogram - - Helm - - HyperShift - - IaaS - - IBoE - - IconBurst - - IdM - - IKEv - - InfiniBand - - InnoDB - - IntelliJ - - IntelliSense - - IPoIB - - IPsec - - IPv - - ISeries - - JavaScript - - JBoss - - JetBrains - - JUnit - - kBps - - KiB - - LangTags - - LGPLv - - libOSMesa - - LibreOffice - - libXNVCtrl - - LightPulse - - LinuxONE - - LiquidIO - - ManageIQ - - MariaDB - - MBps - - MegaRAID - - MiB - - MicroProfile - - MongoDB - - MoreUtils - - MySQL - - NetBIOS - - NetcoredebugOutput - - NetWeaver - - NetworkManager - - NetXen - - NetXtreme - - NFSv - - NMState - - NuGet - - NVidia - - NVMe - - OAuth - - objectClass - - OmniSharp - - OneConnect - - OpenEXR - - OpenID - - OpenIPMI - - OpenJDK - - OpenRAN - - OpenRewrite - - OpenSCAP - - OpenShift - - OpenSSH - - OpenSSL - - OpenStack - - OpenTelemetry - - OpenTracing - - OperatorHub - - OpEx - - OSBuild - - OTel - - PaaS - - PackageKit - - PathTools - - PCIe - - PipeWire - - PostgreSQL - - PostScript - - PowerPC - - PowerShell - - ProLiant - - PulseAudio - - PyPA - - PyPI - - QLogic - - ReaR - - RedBoot - - relaxngDatatype - - RESTEasy - - RHEL - - RoCE - - SaaS - - SeaBIOS - - SELinux - - SmallRye - - SmartNIC - - SmartState - - SQLite - - StarOffice - - STMicroelectronics - - SuperLU - - SysV - - TBps - - TiB - - TuneD - - TypeScript - - UltraSPARC - - USBGuard - - vCenter - - vDisk - - vHost - - VMware - - vSphere - - vSwitch - - WebAuthn - - WebSocket - - WireGuard - - XEmacs - - xPaaS - - XString - - XWayland - - YouTube - - ZCentral diff --git a/styles/RedHat/PassiveVoice.yml b/styles/RedHat/PassiveVoice.yml deleted file mode 100644 index 67b16af..0000000 --- a/styles/RedHat/PassiveVoice.yml +++ /dev/null @@ -1,193 +0,0 @@ ---- -extends: existence -ignorecase: true -level: suggestion -link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/passivevoice/ -message: "'%s' is passive voice. In general, use active voice. Consult the style guide for acceptable use of passive voice." -# source: "https://redhat-documentation.github.io/supplementary-style-guide/#prerequisites; IBM - Voice, p.35" -raw: - - \b(am|are|were|being|is|been|was|be)\b\s* -tokens: - - '[\w]+ed' - - awoken - - beat - - become - - been - - begun - - bent - - beset - - bet - - bid - - bidden - - bitten - - bled - - blown - - born - - bought - - bound - - bred - - broadcast - - broken - - brought - - built - - burnt - - burst - - cast - - caught - - chosen - - clung - - come - - cost - - crept - - cut - - dealt - - dived - - done - - drawn - - dreamt - - driven - - drunk - - dug - - eaten - - fallen - - fed - - felt - - fit - - fled - - flown - - flung - - forbidden - - foregone - - forgiven - - forgotten - - forsaken - - fought - - found - - frozen - - given - - gone - - gotten - - ground - - grown - - heard - - held - - hidden - - hit - - hung - - hurt - - kept - - knelt - - knit - - known - - laid - - lain - - leapt - - learnt - - led - - left - - lent - - let - - lighted - - lost - - made - - meant - - met - - misspelt - - mistaken - - mown - - overcome - - overdone - - overtaken - - overthrown - - paid - - pled - - proven - - put - - quit - - read - - rid - - ridden - - risen - - run - - rung - - said - - sat - - sawn - - seen - - sent - - set - - sewn - - shaken - - shaven - - shed - - shod - - shone - - shorn - - shot - - shown - - shrunk - - shut - - slain - - slept - - slid - - slit - - slung - - smitten - - sold - - sought - - sown - - sped - - spent - - spilt - - spit - - split - - spoken - - spread - - sprung - - spun - - stolen - - stood - - stridden - - striven - - struck - - strung - - stuck - - stung - - stunk - - sung - - sunk - - swept - - swollen - - sworn - - swum - - swung - - taken - - taught - - thought - - thrived - - thrown - - thrust - - told - - torn - - trodden - - understood - - upheld - - upset - - wed - - wept - - withheld - - withstood - - woken - - won - - worn - - wound - - woven - - written - - wrung -exceptions: - - deprecated - - displayed - - imported - - supported - - tested - - trusted diff --git a/styles/RedHat/ProductCentricWriting.yml b/styles/RedHat/ProductCentricWriting.yml deleted file mode 100644 index 3721699..0000000 --- a/styles/RedHat/ProductCentricWriting.yml +++ /dev/null @@ -1,8 +0,0 @@ ---- -extends: existence -ignorecase: true -level: suggestion -link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/productcentricwriting/ -message: "Do not use transitive verb constructions like '%s' to grant abilities to inanimate objects. Whenever possible, use direct, user-focused sentences where the subject of the sentence performs the action." -tokens: - - '(allows?|enables?|lets?|permits?)\s(you|customers|the customer|the user|users)' diff --git a/styles/RedHat/README-IBM.adoc b/styles/RedHat/README-IBM.adoc deleted file mode 100644 index 7e27b01..0000000 --- a/styles/RedHat/README-IBM.adoc +++ /dev/null @@ -1,9 +0,0 @@ -= README for Rules from the IBM Style Guide - -All rights for the IBM Style Guide belong to IBM. - -Our sources of inspiration: - -* link:https://github.com/errata-ai/IBM[The primary Vale implementation of the IBM Style Guide] - -* https://www.ibm.com/developerworks/library/styleguidelines/index.html[The DeveloperWorks version of the IBM Style Guide] diff --git a/styles/RedHat/README-proselint.md b/styles/RedHat/README-proselint.md deleted file mode 100644 index b08cef9..0000000 --- a/styles/RedHat/README-proselint.md +++ /dev/null @@ -1,13 +0,0 @@ - -Copyright © 2014–2015, Jordan Suchow, Michael Pacer, and Lara A. Ross -All rights reserved. - -Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: - -1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. - -2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. - -3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/styles/RedHat/README-write-good.md b/styles/RedHat/README-write-good.md deleted file mode 100644 index ba919b6..0000000 --- a/styles/RedHat/README-write-good.md +++ /dev/null @@ -1,28 +0,0 @@ - -Based on [write-good](https://github.com/btford/write-good). - -> Naive linter for English prose for developers who can't write good and wanna learn to do other stuff good too. - -``` -The MIT License (MIT) - -Copyright (c) 2014 Brian Ford - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. -``` diff --git a/styles/RedHat/ReadabilityGrade.yml b/styles/RedHat/ReadabilityGrade.yml deleted file mode 100644 index a401a67..0000000 --- a/styles/RedHat/ReadabilityGrade.yml +++ /dev/null @@ -1,9 +0,0 @@ ---- -extends: readability -grade: 9 -message: "Simplify your language. The calculated Flesch–Kincaid grade level of %s is above the recommended reading grade level of 9." -link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/readabilitygrade/ -level: suggestion -metrics: - - Flesch-Kincaid - diff --git a/styles/RedHat/ReleaseNotes.yml b/styles/RedHat/ReleaseNotes.yml deleted file mode 100644 index 10ee9c9..0000000 --- a/styles/RedHat/ReleaseNotes.yml +++ /dev/null @@ -1,11 +0,0 @@ ---- -extends: substitution -ignorecase: false -level: suggestion -link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/releasenotes/ -message: "For release notes, consider using '%s' rather than '%s'." -# source: "https://redhat-documentation.github.io/supplementary-style-guide/#release-notes" -# swap maps tokens in form of bad: good -swap: - Now: With this update - Previously: Before this update diff --git a/styles/RedHat/RepeatedWords.yml b/styles/RedHat/RepeatedWords.yml deleted file mode 100644 index 3893d9b..0000000 --- a/styles/RedHat/RepeatedWords.yml +++ /dev/null @@ -1,16 +0,0 @@ ---- -extends: repetition -message: "'%s' is repeated." -level: warning -link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/repeatedwords/ -ignorecase: false -alpha: true -action: - name: edit - params: - - regex - - '(\w+)(\s\w+)' # pattern - - "$1" # replace -tokens: - - '[^\s\.]+' - - '[^\s]+' diff --git a/styles/RedHat/SelfReferentialText.yml b/styles/RedHat/SelfReferentialText.yml deleted file mode 100644 index 36adbf4..0000000 --- a/styles/RedHat/SelfReferentialText.yml +++ /dev/null @@ -1,14 +0,0 @@ ---- -extends: existence -ignorecase: true -level: suggestion -link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/selfreferentialtext/ -message: "Avoid using self-referential text such as '%s'." -# source: "IBM - Audience and medium, p. 22" -tokens: - - this topic - - this module - - this assembly - - this chapter - - this section - - this subsection diff --git a/styles/RedHat/SentenceLength.yml b/styles/RedHat/SentenceLength.yml deleted file mode 100644 index c21f0bc..0000000 --- a/styles/RedHat/SentenceLength.yml +++ /dev/null @@ -1,9 +0,0 @@ ---- -extends: occurrence -level: suggestion -link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/sentencelength/ -message: "Try to keep sentences to an average of 32 words or fewer." -scope: sentence -# source: "IBM - Conversational style" -max: 32 -token: \b(\w+)\b diff --git a/styles/RedHat/SimpleWords.yml b/styles/RedHat/SimpleWords.yml deleted file mode 100644 index 452e7e4..0000000 --- a/styles/RedHat/SimpleWords.yml +++ /dev/null @@ -1,120 +0,0 @@ ---- -extends: substitution -ignorecase: true -level: suggestion -link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/simplewords/ -message: "Use simple language. Consider using '%s' rather than '%s'." -action: - name: replace -swap: - "(?__' - - '<[a-z_]+-[a-z_-]+>' \ No newline at end of file diff --git a/styles/RedHat/Using.yml b/styles/RedHat/Using.yml deleted file mode 100644 index 869cdc9..0000000 --- a/styles/RedHat/Using.yml +++ /dev/null @@ -1,14 +0,0 @@ ---- -extends: sequence -message: "Use 'by using' instead of 'using' when it follows a noun for clarity and grammatical correctness." -link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/using/ -level: warning -action: - name: edit - params: - - regex - - '(\w+)( using)' # pattern - - "$1 by using" # replace -tokens: - - tag: NN|NNP|NNPS|NNS - - pattern: using diff --git a/styles/RedHat/collate-output.tmpl b/styles/RedHat/collate-output.tmpl deleted file mode 100644 index 449aa42..0000000 --- a/styles/RedHat/collate-output.tmpl +++ /dev/null @@ -1,66 +0,0 @@ -{{- /* See https://github.com/errata-ai/vale/issues/614 */ -}} -{{- /* See https://vale.sh/manual/output/ */ -}} - -{{- /* Keep track of our various counts */ -}} - -{{- $e := 0 -}} -{{- $w := 0 -}} -{{- $s := 0 -}} -{{- $f := 0 -}} - -{{- /* Range over the linted files */ -}} - -{{- range .Files}} -{{$table := newTable true}} - -{{- $f = add1 $f -}} -{{- .Path | underline | indent 1 -}} -{{- "\n" -}} - -{{- $msgToLoc := dict -}} -{{- $msgToLvl := dict -}} -{{- $msgToChk := dict -}} - -{{- /* Range over the file's alerts */ -}} - -{{- range .Alerts -}} - -{{- $error := "" -}} -{{- if eq .Severity "error" -}} - {{- $error = .Severity | red -}} - {{- $e = add1 $e -}} -{{- else if eq .Severity "warning" -}} - {{- $error = .Severity | yellow -}} - {{- $w = add1 $w -}} -{{- else -}} - {{- $error = .Severity | blue -}} - {{- $s = add1 $s -}} -{{- end}} - -{{- $loc := printf "%d:%d" .Line (index .Span 0) -}} - -{{- $locations := get $msgToLoc .Message -}} - -{{- $_ := set $msgToLoc .Message (cat $locations $loc) -}} -{{- $_ := set $msgToLvl .Message $error -}} -{{- $_ := set $msgToChk .Message .Check -}} - -{{end -}} - -{{- range keys $msgToLoc -}} - -{{- $msg := . -}} -{{- $loc := trimPrefix "," ((splitList " " (get $msgToLoc $msg)) | join ",") -}} -{{- $lvl := get $msgToLvl $msg -}} -{{- $chk := get $msgToChk $msg -}} - -{{- $row := list $loc $lvl $msg $chk | toStrings -}} -{{- $table = addRow $table $row -}} - -{{end -}} - -{{- $table = renderTable $table -}} - -{{end}} - -{{- $e}} {{"errors" | red}}, {{$w}} {{"warnings" | yellow}} and {{$s}} {{"suggestions" | blue}} in {{$f}} {{$f | int | plural "file" "files"}}. diff --git a/styles/RedHat/meta.json b/styles/RedHat/meta.json deleted file mode 100644 index 6099c80..0000000 --- a/styles/RedHat/meta.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "feed": "https://github.com/redhat-documentation/vale-at-red-hat/releases.atom", - "vale_version": ">=2.20.0" -}