090823 - add TDBX Vale GH action

.github/styles/MongoDB/Abbreviations.yml

@@ -0,0 +1,84 @@
+extends: conditional
+message: "Spell out '%s', unless it is a common abbreviation is common it is not
+the first use in this article or topic."
+link: 'https://docs.mongodb.com/meta/style-guide/style/abbreviations/'
+level: suggestion
+ignorecase: false
+# Ensures that the existence of 'first' implies the existence of 'second'.
+first: '\b([A-Z]{3,5})\b'
+second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)'
+exceptions:
+  - API
+  - ASCII
+  - BIOS
+  - BSON
+  - CD
+  - CD-ROM
+  - CGI
+  - CLI
+  - CPU
+  - CSS
+  - CSV
+  - DNS
+  - DVD
+  - FAQ
+  - FTP
+  - GB
+  - GHz
+  - GMT
+  - GNU
+  - GUI
+  - GUID
+  - HTML
+  - HTTP
+  - HTTPS
+  - ID
+  - IEEE
+  - IMAP
+  - I/O
+  - IP
+  - JSON
+  - KB
+  - Kbps
+  - KBps
+  - kHz
+  - KMS
+  - LAN
+  - LDAP
+  - MB
+  - MHz
+  - NIC
+  - NTFS
+  - OLE
+  - OS
+  - PEM
+  - PDF
+  - PHP
+  - POP
+  - PROD
+  - PSA
+  - RAM
+  - REST
+  - ROM
+  - SaaS
+  - SGML
+  - SMTP
+  - SQL
+  - SSD
+  - SSH
+  - SSL
+  - TCP
+  - TCP/IP
+  - TLS
+  - TTL
+  - URI
+  - URL
+  - USB
+  - USD
+  - UTC
+  - VLAN
+  - WAN
+  - XFS
+  - XML
+  - YAML
+  - ZIP

.github/styles/MongoDB/AbbreviationsPeriods.yml

@@ -0,0 +1,8 @@
+# Based on: https://github.com/errata-ai/Google/blob/master/Google/Periods.yml
+extends: existence
+message: "Don't use periods with acronyms or initialisms such as '%s'."
+link: 'https://docs.mongodb.com/meta/style-guide/style/abbreviations/'
+level: suggestion
+nonword: true
+tokens:
+  - '\b(?:[A-Z]\.){3,}'

.github/styles/MongoDB/Accessibility.yml

@@ -0,0 +1,27 @@
+# Based on: https://github.com/errata-ai/Microsoft/blob/master/Microsoft/Accessibility.yml
+
+extends: existence
+message: "Don't use language (such as '%s') that defines people by their disability."
+link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/accessibility-terms
+level: error
+ignorecase: true
+tokens:
+  - a victim of
+  - able-bodied
+  - affected by
+  - an epileptic
+  - crippled
+  - disabled
+  - dumb
+  - handicapped
+  - handicaps
+  - healthy
+  - lame
+  - maimed
+  - missing a limb
+  - mute
+  - normal
+  - sight-impaired
+  - stricken with
+  - suffers from
+  - vision-impaired

.github/styles/MongoDB/Adverbs.yml

@@ -0,0 +1,9 @@
+extends: existence
+message: "You can remove most adverbs. Use your best judgment."
+link: 'https://docs.mongodb.com/meta/style-guide/writing/write-clear-concise-sentences-paragraphs/#use-the-necessary-words'
+level: suggestion
+ignorecase: true
+scope: sentence
+nonword: false
+tokens:
+  - '\b(\w+ly)'

.github/styles/MongoDB/Antecedents.yml

@@ -0,0 +1,12 @@
+extends: existence
+message: "Avoid using the antecedent '%s' at the beginning of sentences or clauses."
+link: 'https://docs.mongodb.com/meta/style-guide/writing/use-pronouns-carefully/'
+level: suggestion
+ignorecase: false
+scope: sentence
+nonword: true
+tokens:
+  - '(\sIt is)'
+  - '(\sThis)'
+  - '(\sThere (is|are))'
+  - '(\sThat)'

.github/styles/MongoDB/Avoid.yml

@@ -0,0 +1,18 @@
+extends: existence
+message: "Don't use '%s'."
+link: 'https://docs.mongodb.com/meta/style-guide/terminology/alphabetical-terms/'
+ignorecase: true
+level: error
+tokens:
+  - abortion
+  - and/or
+  - and so on
+  - slash mark
+  - billion
+  - biweekly
+  - bimonthly
+  - front end
+  - front-end
+  - if necessary
+  - respectively
+  - trillion

.github/styles/MongoDB/AvoidAccessible.yml

@@ -0,0 +1,8 @@
+extends: existence
+message: "Use accessible only to refer to things that all people, including those with disabilities, can easily use. Don’t use it to mean simple or open."
+link: 'https://docs.mongodb.com/meta/style-guide/terminology/alphabetical-terms/'
+level: error
+ignorecase: false
+nonword: false
+tokens:
+  - accessible

.github/styles/MongoDB/AvoidFirstPerson.yml

@@ -0,0 +1,23 @@
+# Based on https://github.com/errata-ai/Google/blob/master/Google/We.yml
+
+extends: existence
+message: "Avoid first-person pronouns such as '%s' where possible."
+link: 'https://docs.mongodb.com/meta/style-guide/writing/write-to-the-user/#write-to-the-user'
+ignorecase: true
+level: suggestion
+nonword: true
+tokens:
+  - (?:^|\s)I\s
+  - (?:^|\s)I,\s
+  - \bI'm\b
+  - \bI've\b
+  - \bme\b
+  - \bmy\b
+  - \bmine\b
+  - (?:^|\s)We\s
+  - (?:^|\s)We,\s
+  - \bWe're\b
+  - \bWe've\b
+  - \bus\b
+  - \bours?\b
+  - let's

.github/styles/MongoDB/AvoidFutureTense.yml

@@ -0,0 +1,11 @@
+# Based on: https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/.vale/gitlab
+extends: existence
+message: 'Avoid using future tense where possible.'
+ignorecase: true
+level: warning
+link: 'https://docs.mongodb.com/meta/style-guide/writing/use-present-tense/'
+raw:
+  - "(going to( |\n|[[:punct:]])[a-zA-Z]*|"
+  - "will( |\n|[[:punct:]])[a-zA-Z]*|"
+  - "won't( |\n|[[:punct:]])[a-zA-Z]*|"
+  - "[a-zA-Z]*'ll( |\n|[[:punct:]])[a-zA-Z]*)"

.github/styles/MongoDB/AvoidObscure.yml

@@ -0,0 +1,15 @@
+extends: substitution
+message: "Use '%s' instead of '%s'."
+link: 'https://docs.mongodb.com/meta/style-guide/terminology/general-term-guidelines/avoid-obscure-words/'
+level: error
+ignorecase: true
+action:
+  name: replace
+swap:
+  '(?:eg|e\.g\.)[\s,]': for example, such as
+  etc: and so on
+  '(?:ie|i\.e\.)[\s,]': that is
+  as per: according to, by way of
+  via: through, by
+  '(?:vs\.)[\s,]': versus
+  ergo: therefore