add support for vale locally and update CONTRIBUTING to reflect new wiki

This commit is contained in:
Deborah Barnard
2022-04-20 11:07:45 +01:00
parent 23895aa3a8
commit 9a0cd131f4
67 changed files with 5101 additions and 30 deletions

5
.vale.ini Normal file
View File

@@ -0,0 +1,5 @@
StylesPath = "styles"
MinAlertLevel = suggestion
Vocab = default
[*.md]
BasedOnStyles = alex, write-good, Microsoft, n8n-styles

View File

@@ -1,14 +1,12 @@
# Contributing
## Overview
If you want to contribute to this repository - thank you! Beforehand, we encourage you to have a look at the existing documentation to get an idea of the structure and writing conventions we use. In writing your documentation, please follow the guidelines described below, in order to ensure quality and consistency with our style.
If you want to contribute to this repository - thank you! Before you start, have a look at the existing documentation to get an idea of the structure and writing conventions n8n uses. In writing your documentation, please follow the guidelines described below, to ensure quality and consistency with n8n styles.
## Documenting nodes
* **Nodes and trigger nodes:** Create a directory with the name of the node at `docs/integrations/nodes/` or `docs/integrations/trigger-nodes` containing:
- A text file named `n8n-nodes-base.<node-nam>.md` describing the functionality of the relevant node.
* **Credentials:** Create a directory with the name of the node at `docs/integrations/credentials/` containing:
* **Nodes and trigger nodes:** Create a directory with the name of the node at `docs/integrations/nodes/` or `docs/integrations/trigger-nodes/` containing:
- A text file named `n8n-nodes-base.<node-name>.md` describing the functionality of the relevant node.
* **Credentials:** Create a document with the name of the node at `docs/integrations/credentials/` containing:
- A text file with the node name describing how to obtain credentials for the relevant node.
A standard node doc includes the following parts:
@@ -18,6 +16,7 @@ A standard node doc includes the following parts:
- Enter the resources and operations exactly as they are named in the nodes.
In the credentials doc:
* If there is more than one authentication method, list OAuth first.
* If possible, avoid documenting external products. Instead, provide links to the relevant product documentation. For example, for guidance on getting credentials (such as how to get an API token for a service), provide a link to the product's API authentication docs.
@@ -26,30 +25,7 @@ In the credentials doc:
n8n uses the [Microsoft Writing Style Guide](https://docs.microsoft.com/en-us/style-guide/welcome/).
Some quick tips:
* Plain language:
* Clearly explain each step of the process you are documenting.
* Use present tense, active voice, and "you"-form to address the readers.
* Keep your writing as concise as possible. [Hemingway](https://hemingwayapp.com/) is a free browser app to measure language complexity. There is no fixed rule about what grade to aim for, but the lower the reading grade, the better.
* Formatting:
* Make sure you match brand names precisely. For example: "GitHub", not "Github".
* Headings should be sentence case
* Use bold when referring to UI elements. For example, "Click **Save** to proceed."
* Add commit messages in [this](https://gist.github.com/parmentf/035de27d6ed1dce0b36a) format.
### Screenshots
If your contribution includes screenshots, please make sure that they meet the following criteria:
- Only the Editor UI appears in the screenshot. Anything else, like the browser frame, tabs, and so on, should be omitted.
- After zooming in once, the Editor UI is 23 boxes wide and 9 boxes tall.
- The nodes have a distance of two boxes between them.
- The nodes fit inside the boxes (as much as they can).
- The workflow is centered in the Editor canvas.
- If the workflow uses a Trigger node, the Start node doesn't appear in the Editor canvas.
- In recorded GIFs, the cursor movements in the GIF are slow and easy to follow. A good rule of thumb is that the speed should be about 75% of your regular speed. In any case, make sure that GIFs capture every step of the process at a steady pace.
Refer to [Styles](https://github.com/n8n-io/n8n-docs/wiki/Styles/) for a quickstart, and guidance on style linting.
## General checklist

View File

@@ -0,0 +1,9 @@
extends: existence
message: Use 'AM' or 'PM' (preceded by a space).
link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/date-time-terms
level: error
nonword: true
tokens:
- '\d{1,2}[AP]M'
- '\d{1,2} ?[ap]m'
- '\d{1,2} ?[aApP]\.[mM]\.'

View File

@@ -0,0 +1,25 @@
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: suggestion
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

View File

@@ -0,0 +1,64 @@
extends: conditional
message: "'%s' has no definition."
link: https://docs.microsoft.com/en-us/style-guide/acronyms
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})\)'
# ... with the exception of these:
exceptions:
- API
- ASP
- CLI
- CPU
- CSS
- CSV
- DEBUG
- DOM
- DPI
- FAQ
- GCC
- GDB
- GET
- GPU
- GTK
- GUI
- HTML
- HTTP
- HTTPS
- IDE
- JAR
- JSON
- JSX
- LESS
- LLDB
- NET
- NOTE
- NVDA
- OSS
- PATH
- PDF
- PHP
- POST
- RAM
- REPL
- RSA
- SCM
- SCSS
- SDK
- SQL
- SSH
- SSL
- SVG
- TBD
- TCP
- TODO
- URI
- URL
- USB
- UTF
- XML
- XSS
- YAML
- ZIP

View File

@@ -0,0 +1,270 @@
extends: existence
message: "Consider removing '%s'."
link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-simple-words-concise-sentences
ignorecase: true
level: warning
action:
name: remove
tokens:
- abnormally
- absentmindedly
- accidentally
- adventurously
- anxiously
- arrogantly
- awkwardly
- bashfully
- beautifully
- bitterly
- bleakly
- blindly
- blissfully
- boastfully
- boldly
- bravely
- briefly
- brightly
- briskly
- broadly
- busily
- calmly
- carefully
- carelessly
- cautiously
- cheerfully
- cleverly
- closely
- coaxingly
- colorfully
- continually
- coolly
- courageously
- crossly
- cruelly
- curiously
- daintily
- dearly
- deceivingly
- deeply
- defiantly
- deliberately
- delightfully
- diligently
- dimly
- doubtfully
- dreamily
- easily
- elegantly
- energetically
- enormously
- enthusiastically
- excitedly
- extremely
- fairly
- faithfully
- famously
- ferociously
- fervently
- fiercely
- fondly
- foolishly
- fortunately
- frankly
- frantically
- freely
- frenetically
- frightfully
- furiously
- generally
- generously
- gently
- gladly
- gleefully
- gracefully
- gratefully
- greatly
- greedily
- happily
- hastily
- healthily
- heavily
- helplessly
- honestly
- hopelessly
- hungrily
- innocently
- inquisitively
- intensely
- intently
- interestingly
- inwardly
- irritably
- jaggedly
- jealously
- jovially
- joyfully
- joyously
- jubilantly
- judgmentally
- justly
- keenly
- kiddingly
- kindheartedly
- knavishly
- knowingly
- knowledgeably
- lazily
- lightly
- limply
- lively
- loftily
- longingly
- loosely
- loudly
- lovingly
- loyally
- madly
- majestically
- meaningfully
- mechanically
- merrily
- miserably
- mockingly
- mortally
- mysteriously
- naturally
- nearly
- neatly
- nervously
- nicely
- noisily
- obediently
- obnoxiously
- oddly
- offensively
- optimistically
- overconfidently
- painfully
- partially
- patiently
- perfectly
- playfully
- politely
- poorly
- positively
- potentially
- powerfully
- promptly
- properly
- punctually
- quaintly
- queasily
- queerly
- questionably
- quickly
- quietly
- quirkily
- quizzically
- randomly
- rapidly
- rarely
- readily
- really
- reassuringly
- recklessly
- regularly
- reluctantly
- repeatedly
- reproachfully
- restfully
- righteously
- rightfully
- rigidly
- roughly
- rudely
- safely
- scarcely
- scarily
- searchingly
- sedately
- seemingly
- selfishly
- separately
- seriously
- shakily
- sharply
- sheepishly
- shrilly
- shyly
- silently
- sleepily
- slowly
- smoothly
- softly
- solemnly
- solidly
- speedily
- stealthily
- sternly
- strictly
- suddenly
- supposedly
- surprisingly
- suspiciously
- sweetly
- swiftly
- sympathetically
- tenderly
- tensely
- terribly
- thankfully
- thoroughly
- thoughtfully
- tightly
- tremendously
- triumphantly
- truthfully
- ultimately
- unabashedly
- unaccountably
- unbearably
- unethically
- unexpectedly
- unfortunately
- unimpressively
- unnaturally
- unnecessarily
- urgently
- usefully
- uselessly
- utterly
- vacantly
- vaguely
- vainly
- valiantly
- vastly
- verbally
- very
- viciously
- victoriously
- violently
- vivaciously
- voluntarily
- warmly
- weakly
- wearily
- wetly
- wholly
- wildly
- willfully
- wisely
- woefully
- wonderfully
- worriedly
- yawningly
- yearningly
- yieldingly
- youthfully
- zealously
- zestfully
- zestily

11
styles/Microsoft/Auto.yml Normal file
View File

@@ -0,0 +1,11 @@
extends: existence
message: "In general, don't hyphenate '%s'."
link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/a/auto
ignorecase: true
level: error
action:
name: convert
params:
- simple
tokens:
- 'auto-\w+'

View File

@@ -0,0 +1,14 @@
extends: existence
message: "Don't use '%s'. See the A-Z word list for details."
# See the A-Z word list
link: https://docs.microsoft.com/en-us/style-guide
ignorecase: true
level: error
tokens:
- abortion
- and so on
- app(?:lication)?s? (?:developer|program)
- app(?:lication)? file
- backbone
- backend
- contiguous selection

View File

@@ -0,0 +1,120 @@
extends: substitution
message: "Consider using '%s' instead of '%s'."
link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-simple-words-concise-sentences
ignorecase: true
level: suggestion
action:
name: replace
swap:
"approximate(?:ly)?": about
abundance: plenty
accelerate: speed up
accentuate: stress
accompany: go with
accomplish: carry out|do
accorded: given
accordingly: so
accrue: add
accurate: right|exact
acquiesce: agree
acquire: get|buy
additional: more|extra
address: discuss
addressees: you
adjacent to: next to
adjustment: change
admissible: allowed
advantageous: helpful
advise: tell
aggregate: total
aircraft: plane
alleviate: ease
allocate: assign|divide
alternatively: or
alternatives: choices|options
ameliorate: improve
amend: change
anticipate: expect
apparent: clear|plain
ascertain: discover|find out
assistance: help
attain: meet
attempt: try
authorize: allow
belated: late
bestow: give
cease: stop|end
collaborate: work together
commence: begin
compensate: pay
component: part
comprise: form|include
concept: idea
concerning: about
confer: give|award
consequently: so
consolidate: merge
constitutes: forms
contains: has
convene: meet
demonstrate: show|prove
depart: leave
designate: choose
desire: want|wish
determine: decide|find
detrimental: bad|harmful
disclose: share|tell
discontinue: stop
disseminate: send|give
eliminate: end
elucidate: explain
employ: use
enclosed: inside|included
encounter: meet
endeavor: try
enumerate: count
equitable: fair
equivalent: equal
exclusively: only
expedite: hurry
facilitate: ease
females: women
finalize: complete|finish
frequently: often
identical: same
incorrect: wrong
indication: sign
initiate: start|begin
itemized: listed
jeopardize: risk
liaise: work with|partner with
maintain: keep|support
methodology: method
modify: change
monitor: check|watch
multiple: many
necessitate: cause
notify: tell
numerous: many
objective: aim|goal
obligate: bind|compel
optimum: best|most
permit: let
portion: part
possess: own
previous: earlier
previously: before
prioritize: rank
procure: buy
provide: give|offer
purchase: buy
relocate: move
solicit: request
state-of-the-art: latest
subsequent: later|next
substantial: large
sufficient: enough
terminate: end
transmit: send
utilization: use
utilize: use

View File

@@ -0,0 +1,50 @@
extends: substitution
message: "Use '%s' instead of '%s'."
link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-contractions
level: error
ignorecase: true
action:
name: replace
swap:
are not: aren't
cannot: can't
could not: couldn't
did not: didn't
do not: don't
does not: doesn't
has not: hasn't
have not: haven't
how is: how's
is not: isn't
'it is(?!\.)': it's
'it''s(?=\.)': it is
should not: shouldn't
'that is(?!\.)': that's
'that''s(?=\.)': that is
'they are(?!\.)': they're
'they''re(?=\.)': they are
was not: wasn't
'we are(?!\.)': we're
'we''re(?=\.)': we are
'we have(?!\.)': we've
'we''ve(?=\.)': we have
were not: weren't
'what is(?!\.)': what's
'what''s(?=\.)': what is
'when is(?!\.)': when's
'when''s(?=\.)': when is
'where is(?!\.)': where's
'where''s(?=\.)': where is
will not: won't

View File

@@ -0,0 +1,13 @@
extends: existence
message: "Remove the spaces around '%s'."
link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/emes
ignorecase: true
nonword: true
level: error
action:
name: edit
params:
- remove
- ' '
tokens:
- '[—–]\s|\s[—–]'

View File

@@ -0,0 +1,8 @@
extends: existence
message: Use 'July 31, 2016' format, not '%s'.
link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/date-time-terms
ignorecase: true
level: error
nonword: true
tokens:
- '\d{1,2} (?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?) \d{4}'

View File

@@ -0,0 +1,40 @@
extends: existence
message: "Don't use ordinal numbers for dates."
link: https://docs.microsoft.com/en-us/style-guide/numbers#numbers-in-dates
level: error
nonword: true
ignorecase: true
raw:
- \b(?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?)\b\s*
tokens:
- first
- second
- third
- fourth
- fifth
- sixth
- seventh
- eighth
- ninth
- tenth
- eleventh
- twelfth
- thirteenth
- fourteenth
- fifteenth
- sixteenth
- seventeenth
- eighteenth
- nineteenth
- twentieth
- twenty-first
- twenty-second
- twenty-third
- twenty-fourth
- twenty-fifth
- twenty-sixth
- twenty-seventh
- twenty-eighth
- twenty-ninth
- thirtieth
- thirty-first

View File

@@ -0,0 +1,8 @@
extends: existence
message: "Always spell out the name of the month."
link: https://docs.microsoft.com/en-us/style-guide/numbers#numbers-in-dates
ignorecase: true
level: error
nonword: true
tokens:
- '\b\d{1,2}/\d{1,2}/(?:\d{4}|\d{2})\b'

View File

@@ -0,0 +1,9 @@
extends: existence
message: "In general, don't use an ellipsis."
link: https://docs.microsoft.com/en-us/style-guide/punctuation/ellipses
nonword: true
level: warning
action:
name: remove
tokens:
- '\.\.\.'

View File

@@ -0,0 +1,16 @@
extends: existence
message: "Use first person (such as '%s') sparingly."
link: https://docs.microsoft.com/en-us/style-guide/grammar/person
ignorecase: true
level: warning
nonword: true
tokens:
- (?:^|\s)I\s
- (?:^|\s)I,\s
- \bI'd\b
- \bI'll\b
- \bI'm\b
- \bI've\b
- \bme\b
- \bmy\b
- \bmine\b

View File

@@ -0,0 +1,12 @@
extends: substitution
message: "Use '%s' instead of '%s'."
link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-us-spelling-avoid-non-english-words
ignorecase: true
level: error
nonword: true
action:
name: replace
swap:
'\b(?:eg|e\.g\.)[\s,]': for example
'\b(?:ie|i\.e\.)[\s,]': that is

View File

@@ -0,0 +1,8 @@
extends: existence
message: "Don't use '%s'."
link: https://github.com/MicrosoftDocs/microsoft-style-guide/blob/master/styleguide/grammar/nouns-pronouns.md#pronouns-and-gender
level: error
ignorecase: true
tokens:
- he/she
- s/he

View File

@@ -0,0 +1,44 @@
extends: substitution
message: "Consider using '%s' instead of '%s'."
ignorecase: true
level: error
swap:
(?:alumna|alumnus): graduate
(?:alumnae|alumni): graduates
air(?:m[ae]n|wom[ae]n): pilot(s)
anchor(?:m[ae]n|wom[ae]n): anchor(s)
authoress: author
camera(?:m[ae]n|wom[ae]n): camera operator(s)
chair(?:m[ae]n|wom[ae]n): chair(s)
congress(?:m[ae]n|wom[ae]n): member(s) of congress
door(?:m[ae]|wom[ae]n): concierge(s)
draft(?:m[ae]n|wom[ae]n): drafter(s)
fire(?:m[ae]n|wom[ae]n): firefighter(s)
fisher(?:m[ae]n|wom[ae]n): fisher(s)
fresh(?:m[ae]n|wom[ae]n): first-year student(s)
garbage(?:m[ae]n|wom[ae]n): waste collector(s)
lady lawyer: lawyer
ladylike: courteous
landlord: building manager
mail(?:m[ae]n|wom[ae]n): mail carriers
man and wife: husband and wife
man enough: strong enough
mankind: human kind
manmade: manufactured
manpower: personnel
men and girls: men and women
middle(?:m[ae]n|wom[ae]n): intermediary
news(?:m[ae]n|wom[ae]n): journalist(s)
ombuds(?:man|woman): ombuds
oneupmanship: upstaging
poetess: poet
police(?:m[ae]n|wom[ae]n): police officer(s)
repair(?:m[ae]n|wom[ae]n): technician(s)
sales(?:m[ae]n|wom[ae]n): salesperson or sales people
service(?:m[ae]n|wom[ae]n): soldier(s)
steward(?:ess)?: flight attendant
tribes(?:m[ae]n|wom[ae]n): tribe member(s)
waitress: waiter
woman doctor: doctor
woman scientist[s]?: scientist(s)
work(?:m[ae]n|wom[ae]n): worker(s)

View File

@@ -0,0 +1,11 @@
extends: existence
message: "For a general audience, use 'address' rather than 'URL'."
link: https://docs.microsoft.com/en-us/style-guide/urls-web-addresses
level: warning
action:
name: replace
params:
- URL
- address
tokens:
- URL

View File

@@ -0,0 +1,7 @@
extends: existence
message: "Avoid using acronyms in a title or heading."
link: https://docs.microsoft.com/en-us/style-guide/acronyms#be-careful-with-acronyms-in-titles-and-headings
level: warning
scope: heading
tokens:
- '[A-Z]{2,4}'

View File

@@ -0,0 +1,8 @@
extends: existence
message: "Capitalize '%s'."
link: https://docs.microsoft.com/en-us/style-guide/punctuation/colons
nonword: true
level: error
scope: heading
tokens:
- ':\s[a-z]'

View File

@@ -0,0 +1,13 @@
extends: existence
message: "Don't use end punctuation in headings."
link: https://docs.microsoft.com/en-us/style-guide/punctuation/periods
nonword: true
level: warning
scope: heading
action:
name: edit
params:
- remove
- '.?!'
tokens:
- '[a-z][.?!](?:\s|$)'

View File

@@ -0,0 +1,28 @@
extends: capitalization
message: "'%s' should use sentence-style capitalization."
link: https://docs.microsoft.com/en-us/style-guide/capitalization
level: suggestion
scope: heading
match: $sentence
indicators:
- ':'
exceptions:
- Azure
- CLI
- Code
- Cosmos
- Docker
- Emmet
- I
- Kubernetes
- Linux
- macOS
- Marketplace
- MongoDB
- REPL
- Studio
- TypeScript
- URLs
- Visual
- VS
- Windows

View File

@@ -0,0 +1,14 @@
extends: existence
message: "'%s' doesn't need a hyphen."
link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/hyphens
level: warning
ignorecase: false
nonword: true
action:
name: edit
params:
- replace
- '-'
- ' '
tokens:
- '\s[^\s-]+ly-'

View File

@@ -0,0 +1,13 @@
extends: existence
message: "Form a negative number with an en dash, not a hyphen."
link: https://docs.microsoft.com/en-us/style-guide/numbers
nonword: true
level: error
action:
name: edit
params:
- replace
- '-'
- ''
tokens:
- '\s-\d+\s'

View File

@@ -0,0 +1,13 @@
extends: existence
message: "Don't add -ly to an ordinal number."
link: https://docs.microsoft.com/en-us/style-guide/numbers
level: error
action:
name: edit
params:
- trim
- ly
tokens:
- firstly
- secondly
- thirdly

View File

@@ -0,0 +1,8 @@
extends: existence
message: "Use the Oxford comma in '%s'."
link: https://docs.microsoft.com/en-us/style-guide/punctuation/commas
scope: sentence
level: suggestion
nonword: true
tokens:
- '(?:[^\s,]+,){1,} \w+ (?:and|or) \w+[.?!]'

View File

@@ -0,0 +1,183 @@
extends: existence
message: "'%s' looks like passive voice."
ignorecase: true
level: suggestion
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

View File

@@ -0,0 +1,7 @@
extends: existence
message: "Use a numeral plus the units."
link: https://docs.microsoft.com/en-us/style-guide/numbers
nonword: true
level: error
tokens:
- '\b[a-zA-z]+\spercent\b'

View File

@@ -0,0 +1,7 @@
extends: existence
message: 'Punctuation should be inside the quotes.'
link: https://docs.microsoft.com/en-us/style-guide/punctuation/quotation-marks
level: error
nonword: true
tokens:
- '["“][^"”“]+["”][.,]'

View File

@@ -0,0 +1,13 @@
extends: existence
message: "Use an en dash in a range of numbers."
link: https://docs.microsoft.com/en-us/style-guide/numbers
nonword: true
level: error
action:
name: edit
params:
- replace
- '-'
- ''
tokens:
- '\b\d+\s?[-]\s?\d+\b'

View File

@@ -0,0 +1,13 @@
extends: existence
message: "Use 'to' instead of a dash in '%s'."
link: https://docs.microsoft.com/en-us/style-guide/numbers
nonword: true
level: error
action:
name: edit
params:
- replace
- '[-]'
- 'to'
tokens:
- '\b(?:AM|PM)\s?[-]\s?.+(?:AM|PM)\b'

View File

@@ -0,0 +1,7 @@
extends: existence
message: "In most cases, use 'from' or 'through' to describe a range of numbers."
link: 'https://docs.microsoft.com/en-us/style-guide/numbers'
nonword: true
level: warning
tokens:
- '\b\d+\s?[-]\s?\d+\b'

View File

@@ -0,0 +1,8 @@
extends: existence
message: "Try to simplify this sentence."
link: https://docs.microsoft.com/en-us/style-guide/punctuation/semicolons
nonword: true
scope: sentence
level: suggestion
tokens:
- ';'

View File

@@ -0,0 +1,7 @@
extends: occurrence
message: "Try to keep sentences short (< 30 words)."
scope: sentence
level: suggestion
max: 30
token: \b(\w+)\b

View File

@@ -0,0 +1,8 @@
extends: existence
message: "'%s' should have one space."
link: https://docs.microsoft.com/en-us/style-guide/punctuation/periods
level: error
nonword: true
tokens:
- '[a-z][.?!] {2,}[A-Z]'
- '[a-z][.?!][A-Z]'

View File

@@ -0,0 +1,7 @@
extends: existence
message: "Don't use '%s' unless space is limited."
link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/hyphens
ignorecase: true
level: warning
tokens:
- '\w+- and \w+-'

View File

@@ -0,0 +1,43 @@
extends: substitution
message: "Prefer '%s' over '%s'."
level: warning
ignorecase: true
action:
name: replace
swap:
'(?:agent|virtual assistant|intelligent personal assistant)': personal digital assistant
'(?:drive C:|drive C>|C: drive)': drive C
'(?:internet bot|web robot)s?': bot(s)
'(?:microsoft cloud|the cloud)': cloud
'(?:mobile|smart) ?phone': phone
'24/7': every day
'audio(?:-| )book': audiobook
'back(?:-| )light': backlight
'chat ?bots?': chatbot(s)
adaptor: adapter
administrate: administer
afterwards: afterward
alphabetic: alphabetical
alphanumerical: alphanumeric
anti-aliasing: antialiasing
anti-malware: antimalware
anti-spyware: antispyware
anti-virus: antivirus
appendixes: appendices
artificial intelligence: artificial intelligence
assembler: assembly language
bpp: bpp
bps: bps
caap: CaaP
conversation-as-a-platform: conversation as a platform
eb: EB
gb: GB
gbps: Gbps
kb: KB
keypress: keystroke
mb: MB
pb: PB
tb: TB
zb: ZB
viz: namely
ergo: therefore

View File

@@ -0,0 +1,10 @@
extends: substitution
message: "Use '%s' instead of '%s'."
ignorecase: true
level: error
action:
name: replace
swap:
URL for: URL of
an URL: a URL

View File

@@ -0,0 +1,16 @@
extends: existence
message: "Don't spell out the number in '%s'."
link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/units-of-measure-terms
level: error
raw:
- '[a-zA-Z]+\s'
tokens:
- '(?:centi|milli)?meters'
- '(?:kilo)?grams'
- '(?:kilo)?meters'
- '(?:mega)?pixels'
- cm
- inches
- lb
- miles
- pounds

View File

@@ -0,0 +1,25 @@
extends: existence
message: "Verify your use of '%s' with the A-Z word list."
link: 'https://docs.microsoft.com/en-us/style-guide'
level: suggestion
ignorecase: true
tokens:
- above
- accessible
- actionable
- against
- alarm
- alert
- alias
- allows?
- and/or
- as well as
- assure
- author
- avg
- beta
- ensure
- he
- insure
- sample
- she

11
styles/Microsoft/We.yml Normal file
View File

@@ -0,0 +1,11 @@
extends: existence
message: "Try to avoid using first-person plural like '%s'."
link: https://docs.microsoft.com/en-us/style-guide/grammar/person#avoid-first-person-plural
level: warning
ignorecase: true
tokens:
- we
- we'(?:ve|re)
- ours?
- us
- let's

View File

@@ -0,0 +1,122 @@
extends: substitution
message: "Consider using '%s' instead of '%s'."
link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-simple-words-concise-sentences
ignorecase: true
level: warning
action:
name: replace
swap:
(?:give|gave) rise to: lead to
(?:previous|prior) to: before
a (?:large)? majority of: most
a (?:large)? number of: many
a myriad of: myriad
adversely impact: hurt
all across: across
all of a sudden: suddenly
all of these: these
all of: all
all-time record: record
almost all: most
almost never: seldom
along the lines of: similar to
an adequate number of: enough
an appreciable number of: many
an estimated: about
any and all: all
are in agreement: agree
as a matter of fact: in fact
as a means of: to
as a result of: because of
as of yet: yet
as per: per
at a later date: later
at all times: always
at the present time: now
at this point in time: at this point
based in large part on: based on
based on the fact that: because
basic necessity: necessity
because of the fact that: because
came to a realization: realized
came to an abrupt end: ended abruptly
carry out an evaluation of: evaluate
close down: close
closed down: closed
complete stranger: stranger
completely separate: separate
concerning the matter of: regarding
conduct a review of: review
conduct an investigation: investigate
conduct experiments: experiment
continue on: continue
despite the fact that: although
disappear from sight: disappear
drag and drop: drag
drag-and-drop: drag
doomed to fail: doomed
due to the fact that: because
during the period of: during
during the time that: while
emergency situation: emergency
except when: unless
excessive number: too many
extend an invitation: invite
fall down: fall
fell down: fell
for the duration of: during
gather together: gather
has the ability to: can
has the capacity to: can
has the opportunity to: could
hold a meeting: meet
if this is not the case: if not
in a careful manner: carefully
in a thoughtful manner: thoughtfully
in a timely manner: timely
in an effort to: to
in between: between
in lieu of: instead of
in many cases: often
in most cases: usually
in order to: to
in some cases: sometimes
in spite of the fact that: although
in spite of: despite
in the (?:very)? near future: soon
in the event that: if
in the neighborhood of: roughly
in the vicinity of: close to
it would appear that: apparently
lift up: lift
made reference to: referred to
make reference to: refer to
mix together: mix
none at all: none
not in a position to: unable
not possible: impossible
of major importance: important
perform an assessment of: assess
pertaining to: about
place an order: order
plays a key role in: is essential to
present time: now
readily apparent: apparent
some of the: some
span across: span
subsequent to: after
successfully complete: complete
sufficient number (?:of)?: enough
take action: act
take into account: consider
the question as to whether: whether
there is no doubt but that: doubtless
this day and age: this age
this is a subject that: this subject
time (?:frame|period): time
under the provisions of: under
until such time as: until
used for fuel purposes: used for fuel
whether or not: whether
with regard to: regarding
with the exception of: except for

View File

@@ -0,0 +1,4 @@
{
"feed": "https://github.com/errata-ai/Microsoft/releases.atom",
"vale_version": ">=1.0.0"
}

View File

@@ -0,0 +1 @@
n8n

View File

@@ -0,0 +1,3 @@
N8n
n8N
N8N

248
styles/alex/Ablist.yml Normal file
View File

@@ -0,0 +1,248 @@
---
extends: substitution
message: When referring to a person, consider using '%s' instead of '%s'.
ignorecase: true
level: warning
action:
name: replace
swap:
ablebodied: non-disabled
addict: person with a drug addiction|person recovering from a drug addiction
addicts: people with a drug addiction|people recovering from a drug addiction
adhd: disorganized|distracted|energetic|hyperactive|impetuous|impulsive|inattentive|restless|unfocused
afflicted with MD: person who has muscular dystrophy
afflicted with a disability: has a disability|person with a disability|people with
disabilities
afflicted with a intellectual disability: person with an intellectual disability
afflicted with a polio: polio|person who had polio
afflicted with aids: person with AIDS
afflicted with an injury: sustain an injury|receive an injury
afflicted with disabilities: has a disability|person with a disability|people with
disabilities
afflicted with injuries: sustain injuries|receive injuries
afflicted with intellectual disabilities: person with an intellectual disability
afflicted with multiple sclerosis: person who has multiple sclerosis
afflicted with muscular dystrophy: person who has muscular dystrophy
afflicted with polio: polio|person who had polio
afflicted with psychosis: person with a psychotic condition|person with psychosis
afflicted with schizophrenia: person with schizophrenia
aids victim: person with AIDS
alcohol abuser: someone with an alcohol problem
alcoholic: someone with an alcohol problem
amputee: person with an amputation
anorexic: thin|slim
asylum: psychiatric hospital|mental health hospital
barren: empty|sterile|infertile
batshit: rude|malicious|mean|disgusting|incredible|vile|person with symptoms of
mental illness|person with mental illness|person with symptoms of a mental disorder|person
with a mental disorder
bedlam: chaos|hectic|pandemonium
binge: enthusiastic|spree
bipolar: fluctuating|person with bipolar disorder
birth defect: has a disability|person with a disability|people with disabilities
blind eye to: careless|heartless|indifferent|insensitive
blind to: careless|heartless|indifferent|insensitive
blinded by: careless|heartless|indifferent|insensitive
bony: thin|slim
bound to a wheelchair: uses a wheelchair
buckteeth: person with prominent teeth|prominent teeth
bucktoothed: person with prominent teeth|prominent teeth
challenged: has a disability|person with a disability|people with disabilities
cleftlipped: person with a cleft-lip and palate
confined to a wheelchair: uses a wheelchair
contard: disagreeable|uneducated|ignorant|naive|inconsiderate
crazy: rude|malicious|mean|disgusting|incredible|vile|person with symptoms of mental
illness|person with mental illness|person with symptoms of a mental disorder|person
with a mental disorder
cretin: creep|fool
cripple: person with a limp
crippled: person with a limp
daft: absurd|foolish
deaf and dumb: deaf
deaf ear to: careless|heartless|indifferent|insensitive
deaf to: careless|heartless|indifferent|insensitive
deafened by: careless|heartless|indifferent|insensitive
deafmute: deaf
delirious: rude|malicious|mean|disgusting|incredible|vile|person with symptoms of
mental illness|person with mental illness|person with symptoms of a mental disorder|person
with a mental disorder
demented: person with dementia
depressed: sad|blue|bummed out|person with seasonal affective disorder|person with
psychotic depression|person with postpartum depression
detox: treatment
detox center: treatment center
diffability: has a disability|person with a disability|people with disabilities
differently abled: has a disability|person with a disability|people with disabilities
disabled: turned off|has a disability|person with a disability|people with disabilities
downs syndrome: Down Syndrome
dumb: foolish|ludicrous|speechless|silent
dummy: test double|placeholder|fake|stub
dummyobject: test double|placeholder|fake|stub
dummyvalue: test double|placeholder|fake|stub
dummyvariable: test double|placeholder|fake|stub
dwarf: person with dwarfism|little person|little people|LP|person of short stature
dyslexic: person with dyslexia
epileptic: person with epilepsy
family burden: with family support needs
feeble minded: foolish|ludicrous|silly
feebleminded: foolish|ludicrous|silly
fucktard: disagreeable|uneducated|ignorant|naive|inconsiderate
gimp: person with a limp
handicapable: has a disability|person with a disability|people with disabilities
handicapped: person with a handicap|accessible
handicapped parking: accessible parking
hare lip: cleft-lip and palate
harelip: cleft-lip and palate
harelipped: person with a cleft-lip and palate
has intellectual issues: person with an intellectual disability
hearing impaired: hard of hearing|partially deaf|partial hearing loss|deaf
hearing impairment: hard of hearing|partially deaf|partial hearing loss|deaf
idiot: foolish|ludicrous|silly
imbecile: foolish|ludicrous|silly
infantile paralysis: polio|person who had polio
insane: rude|malicious|mean|disgusting|incredible|vile|person with symptoms of mental
illness|person with mental illness|person with symptoms of a mental disorder|person
with a mental disorder
insanely: incredibly
insanity: rude|malicious|mean|disgusting|incredible|vile|person with symptoms of
mental illness|person with mental illness|person with symptoms of a mental disorder|person
with a mental disorder
insomnia: restlessness|sleeplessness
insomniac: person who has insomnia
insomniacs: people who have insomnia
intellectually disabled: person with an intellectual disability
intellectually disabled people: people with intellectual disabilities
invalid: turned off|has a disability|person with a disability|people with disabilities
junkie: person with a drug addiction|person recovering from a drug addiction
junkies: people with a drug addiction|people recovering from a drug addiction
lame: boring|dull
learning disabled: person with learning disabilities
libtard: disagreeable|uneducated|ignorant|naive|inconsiderate
loony: rude|malicious|mean|disgusting|incredible|vile|person with symptoms of mental
illness|person with mental illness|person with symptoms of a mental disorder|person
with a mental disorder
loony bin: chaos|hectic|pandemonium
low iq: foolish|ludicrous|unintelligent
lunacy: rude|malicious|mean|disgusting|incredible|vile|person with symptoms of mental
illness|person with mental illness|person with symptoms of a mental disorder|person
with a mental disorder
lunatic: rude|malicious|mean|disgusting|incredible|vile|person with symptoms of
mental illness|person with mental illness|person with symptoms of a mental disorder|person
with a mental disorder
madhouse: chaos|hectic|pandemonium
maniac: fanatic|zealot|enthusiast
manic: person with schizophrenia
mental: rude|malicious|mean|disgusting|incredible|vile|person with symptoms of mental
illness|person with mental illness|person with symptoms of a mental disorder|person
with a mental disorder
mental case: rude|malicious|mean|disgusting|incredible|vile|person with symptoms
of mental illness|person with mental illness|person with symptoms of a mental
disorder|person with a mental disorder
mental defective: rude|malicious|mean|disgusting|incredible|vile|person with symptoms
of mental illness|person with mental illness|person with symptoms of a mental
disorder|person with a mental disorder
mentally ill: rude|malicious|mean|disgusting|incredible|vile|person with symptoms
of mental illness|person with mental illness|person with symptoms of a mental
disorder|person with a mental disorder
midget: person with dwarfism|little person|little people|LP|person of short stature
mongoloid: person with Down Syndrome
moron: rude|malicious|mean|disgusting|incredible|vile|person with symptoms of mental
illness|person with mental illness|person with symptoms of a mental disorder|person
with a mental disorder
moronic: rude|malicious|mean|disgusting|incredible|vile|person with symptoms of
mental illness|person with mental illness|person with symptoms of a mental disorder|person
with a mental disorder
multiple sclerosis victim: person who has multiple sclerosis
neurotic: has an anxiety disorder|obsessive|pedantic|niggly|picky
nuts: rude|malicious|mean|disgusting|incredible|vile|person with symptoms of mental
illness|person with mental illness|person with symptoms of a mental disorder|person
with a mental disorder
o.c.d: has an anxiety disorder|obsessive|pedantic|niggly|picky
o.c.d.: has an anxiety disorder|obsessive|pedantic|niggly|picky
ocd: has an anxiety disorder|obsessive|pedantic|niggly|picky
panic attack: fit of terror|scare
paraplegic: person with paraplegia
psycho: rude|malicious|mean|disgusting|incredible|vile|person with symptoms of mental
illness|person with mental illness|person with symptoms of a mental disorder|person
with a mental disorder
psychopathology: rude|malicious|mean|disgusting|incredible|vile|person with symptoms
of mental illness|person with mental illness|person with symptoms of a mental
disorder|person with a mental disorder
psychotic: person with a psychotic condition|person with psychosis
quadriplegic: person with quadriplegia
rehab: treatment
rehab center: treatment center
restricted to a wheelchair: uses a wheelchair
retard: silly|dullard|person with Down Syndrome|person with developmental disabilities|delay|hold
back
retarded: silly|dullard|person with Down Syndrome|person with developmental disabilities|delay|hold
back
retards: "sillies|dullards|people with developmental disabilities|people with Down\u2019\
s Syndrome|delays|holds back"
sane: correct|adequate|sufficient|consistent|valid|coherent|sensible|reasonable
sanity check: check|assertion|validation|smoke test
schizo: person with schizophrenia
schizophrenic: person with schizophrenia
senile: person with dementia
short bus: silly|dullard|person with Down Syndrome|person with developmental disabilities|delay|hold
back
simpleton: foolish|ludicrous|unintelligent
small person: person with dwarfism|little person|little people|LP|person of short
stature
sociopath: person with a personality disorder|person with psychopathic personality
sociopaths: people with psychopathic personalities|people with a personality disorder
spastic: person with cerebral palsy|twitch|flinch
spaz: person with cerebral palsy|twitch|flinch|hectic
special: has a disability|person with a disability|people with disabilities
special needs: has a disability|person with a disability|people with disabilities
special olympians: athletes|Special Olympics athletes
special olympic athletes: athletes|Special Olympics athletes
specially abled: has a disability|person with a disability|people with disabilities
stammering: stuttering|disfluency of speech
stroke victim: individual who has had a stroke
stupid: foolish|ludicrous|unintelligent
stutterer: person who stutters
suffer from aids: person with AIDS
suffer from an injury: sustain an injury|receive an injury
suffer from injuries: sustain injuries|receive injuries
suffering from a disability: has a disability|person with a disability|people with
disabilities
suffering from a polio: polio|person who had polio
suffering from a stroke: individual who has had a stroke
suffering from aids: person with AIDS
suffering from an injury: sustain an injury|receive an injury
suffering from an intellectual disability: person with an intellectual disability
suffering from disabilities: has a disability|person with a disability|people with
disabilities
suffering from injuries: sustain injuries|receive injuries
suffering from intellectual disabilities: person with an intellectual disability
suffering from multiple sclerosis: person who has multiple sclerosis
suffering from polio: polio|person who had polio
suffering from psychosis: person with a psychotic condition|person with psychosis
suffering from schizophrenia: person with schizophrenia
suffers from MD: person who has muscular dystrophy
suffers from aids: person with AIDS
suffers from an injury: sustain an injury|receive an injury
suffers from disabilities: has a disability|person with a disability|people with
disabilities
suffers from injuries: sustain injuries|receive injuries
suffers from intellectual disabilities: person with an intellectual disability
suffers from multiple sclerosis: person who has multiple sclerosis
suffers from muscular dystrophy: person who has muscular dystrophy
suffers from polio: polio|person who had polio
suffers from psychosis: person with a psychotic condition|person with psychosis
suffers from schizophrenia: person with schizophrenia
tourettes disorder: Tourette syndrome
tourettes syndrome: Tourette syndrome
vertically challenged: person with dwarfism|little person|little people|LP|person
of short stature
victim of a stroke: individual who has had a stroke
victim of aids: person with AIDS
victim of an injury: sustain an injury|receive an injury
victim of injuries: sustain injuries|receive injuries
victim of multiple sclerosis: person who has multiple sclerosis
victim of polio: polio|person who had polio
victim of psychosis: person with a psychotic condition|person with psychosis
wacko: foolish|ludicrous|unintelligent
whacko: foolish|ludicrous|unintelligent
wheelchair bound: uses a wheelchair

View File

@@ -0,0 +1,16 @@
---
extends: existence
message: Using '%s' may come across as condescending.
link: https://css-tricks.com/words-avoid-educational-writing/
level: error
ignorecase: true
tokens:
- obvious
- obviously
- simple
- simply
- easy
- easily
- of course
- clearly
- everyone knows

108
styles/alex/Gendered.yml Normal file
View File

@@ -0,0 +1,108 @@
---
extends: substitution
message: "Consider using '%s' instead of '%s'."
ignorecase: true
level: warning
action:
name: replace
swap:
ancient man: ancient civilization|ancient people
authoress: author|writer
average housewife: average consumer|average household|average homemaker
average man: average person
average working man: average wage earner|average taxpayer
aviatrix: aviator
bitch: whine|complain|cry
bitching: whining|complaining|crying
brotherhood of man: the human family
calendar girl: model
call girl: escort|prostitute|sex worker
churchman: cleric|practicing Christian|pillar of the Church
english master: english coordinator|senior teacher of english
englishmen: the english
executrix: executor
father of *: founder of
fellowship: camaraderie|community|organization
founding father: the founders|founding leaders|forebears
frenchmen: french|the french
freshman: first-year student|fresher
freshwoman: first-year student|fresher
housemaid: house worker|domestic help
housewife: homemaker|homeworker
housewives: homemakers|homeworkers
industrial man: industrial civilization|industrial people
lady doctor: doctor
ladylike: courteous|cultured
leading lady: lead
like a man: resolutely|bravely
mad man: fanatic|zealot|enthusiast
mad men: fanatics|zealots|enthusiasts
madman: fanatic|zealot|enthusiast
madmen: fanatics|zealots|enthusiasts
maiden: virgin
maiden flight: first flight
maiden name: birth name
maiden race: first race
maiden speech: first speech
maiden voyage: first voyage
man a desk: staff a desk
man enough: strong enough
man hour: staff hour|hour of work
man hours: staff hours|hours of work|hours of labor|hours
man in the street: ordinary citizen|typical person|average person
man of action: dynamo
man of letters: scholar|writer|literary figure
man of the land: farmer|rural worker|grazier|landowner|rural community|country people|country
folk
man of the world: sophisticate
man sized task: a demanding task|a big job
man the booth: staff the booth
man the phones: answer the phones
manhour: staff hour|hour of work
manhours: staff hours|hours of work|hours of labor|hours
mankind: humankind
manmade: manufactured|artificial|synthetic|machine-made|constructed
manned: staffed|crewed|piloted
manpower: human resources|workforce|personnel|staff|labor|personnel|labor force|staffing|combat
personnel
mans best friend: a faithful dog
mansized task: a demanding task|a big job
master copy: pass key|original
master key: pass key|original
master of ceremonies: emcee|moderator|convenor
master plan: grand scheme|guiding principles
master the art: become skilled
masterful: skilled|authoritative|commanding
mastermind: genius|creator|instigator|oversee|launch|originate
masterpiece: "work of genius|chef d\u2019oeuvre"
masterplan: vision|comprehensive plan
masterstroke: trump card|stroke of genius
men of science: scientists
midwife: birthing nurse
miss.: ms.
moan: whine|complain|cry
moaning: whining|complaining|crying
modern man: modern civilization|modern people
motherly: loving|warm|nurturing
mrs.: ms.
no mans land: unoccupied territory|wasteland|deathtrap
office girls: administrative staff
oneupmanship: upstaging|competitiveness
poetess: poet
railwayman: railway worker
sportsmanlike: fair|sporting
sportsmanship: fairness|good humor|sense of fair play
statesman like: diplomatic
statesmanlike: diplomatic
stockman: cattle worker|farmhand|drover
tax man: tax commissioner|tax office|tax collector
tradesmans entrance: service entrance
unmanned: robotic|automated
usherette: usher
wife beater: tank top|sleeveless undershirt
wifebeater: tank top|sleeveless undershirt
woman lawyer: lawyer
woman painter: painter
working mother: wage or salary earning woman|two-income family
working wife: wage or salary earning woman|two-income family
workmanship: quality construction|expertise

55
styles/alex/LGBTQ.yml Normal file
View File

@@ -0,0 +1,55 @@
---
extends: substitution
message: Consider using '%s' instead of '%s'.
ignorecase: true
level: warning
action:
name: replace
swap:
bathroom bill: non-discrimination law|non-discrimination ordinance
bi: bisexual
biologically female: assigned female at birth|designated female at birth
biologically male: assigned male at birth|designated male at birth
born a man: assigned male at birth|designated male at birth
born a woman: assigned female at birth|designated female at birth
dyke: gay
fag: gay
faggot: gay
gay agenda: gay issues
gay lifestyle: gay lives|gay/lesbian lives
gay rights: equal rights|civil rights for gay people
gender pronoun: pronoun|pronouns
gender pronouns: pronoun|pronouns
genetically female: assigned female at birth|designated female at birth
genetically male: assigned male at birth|designated male at birth
hermaphrodite: person who is intersex|person|intersex person
hermaphroditic: intersex
heshe: transgender person|person
homo: gay
homosexual: gay|gay man|lesbian|gay person/people
homosexual agenda: gay issues
homosexual couple: couple
homosexual lifestyle: gay lives|gay/lesbian lives
homosexual marriage: gay marriage|same-sex marriage
homosexual relations: relationship
homosexual relationship: relationship
preferred pronoun: pronoun|pronouns
preferred pronouns: pronoun|pronouns
pseudo hermaphrodite: person who is intersex|person|intersex person
pseudo hermaphroditic: intersex
pseudohermaphrodite: person who is intersex|person|intersex person
pseudohermaphroditic: intersex
sex change: transition|gender confirmation surgery
sex change operation: sex reassignment surgery|gender confirmation surgery
sexchange: transition|gender confirmation surgery
sexual preference: sexual orientation|orientation
she male: transgender person|person
shehe: transgender person|person
shemale: transgender person|person
sodomite: gay
special rights: equal rights|civil rights for gay people
tranny: transgender
transgendered: transgender
transgenderism: being transgender|the movement for transgender equality
transgenders: transgender people
transvestite: cross-dresser

11
styles/alex/Press.yml Normal file
View File

@@ -0,0 +1,11 @@
---
extends: substitution
message: Consider using '%s' instead of '%s'.
ignorecase: true
level: warning
action:
name: replace
swap:
islamist: muslim|person of Islamic faith|fanatic|zealot|follower of islam|follower
of the islamic faith
islamists: muslims|people of Islamic faith|fanatics|zealots

1781
styles/alex/Profanity.yml Normal file

File diff suppressed because it is too large Load Diff

27
styles/alex/README.md Normal file
View File

@@ -0,0 +1,27 @@
Based on [alex](https://github.com/get-alex/alex).
> Catch insensitive, inconsiderate writing
```
(The MIT License)
Copyright (c) 2015 Titus Wormer <tituswormer@gmail.com>
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.
```

87
styles/alex/Race.yml Normal file
View File

@@ -0,0 +1,87 @@
---
extends: substitution
message: Consider using '%s' instead of '%s'.
ignorecase: true
level: warning
action:
name: replace
swap:
Gipsy: Nomad|Traveler|Roma|Romani
Indian country: enemy territory
animal spirit: favorite|inspiration|personal interest|personality type
black list: blocklist|wronglist|banlist|deny list
blacklist: blocklist|wronglist|banlist|deny list
blacklisted: blocklisted|wronglisted|banlisted|deny-listed
blacklisting: blocklisting|wronglisting|banlisting|deny-listing
bugreport: bug report|snapshot
circle the wagons: defend
dream catcher: favorite|inspiration|personal interest|personality type
eskimo: Inuit
eskimos: Inuits
ghetto: projects|urban
goy: a person who is not Jewish|not Jewish
goyim: a person who is not Jewish|not Jewish
goyum: a person who is not Jewish|not Jewish
grandfather clause: legacy policy|legacy clause|deprecation policy
grandfather policy: legacy policy|legacy clause|deprecation policy
grandfathered: deprecated
grandfathering: deprecate
gyp: Nomad|Traveler|Roma|Romani
gyppo: Nomad|Traveler|Roma|Romani
gypsy: Nomad|Traveler|Roma|Romani
hymie: Jewish person
indian give: "go back on one\u2019s offer"
indian giver: "go back on one\u2019s offer"
japs: Japanese person|Japanese people
jump the reservation: disobey|endure|object to|oppose|resist
latina: Latinx
latino: Latinx
long time no hear: "I haven\u2019t seen you in a long time|it\u2019s been a long\
\ time"
long time no see: "I haven\u2019t seen you in a long time|it\u2019s been a long\
\ time"
master: primary|hub|reference
masters: primaries|hubs|references
mexican: Latinx
natives are becoming restless: dissatisfied|frustrated
natives are getting restless: dissatisfied|frustrated
natives are growing restless: dissatisfied|frustrated
natives are restless: dissatisfied|frustrated
non white: person of color|people of color
nonwhite: person of color|people of color
off reserve: disobey|endure|object to|oppose|resist
off the reservation: disobey|endure|object to|oppose|resist
on the warpath: defend
oriental: Asian person
orientals: Asian people
pinays: Filipinos|Filipino people
pinoys: Filipinos|Filipino people
pocahontas: Native American
pow wow: conference|gathering|meeting
powwow: conference|gathering|meeting
primitive: simple|indigenous|hunter-gatherer
red indian: Native American
red indians: Native American People
redskin: Native American
redskins: Native American People
sand niggers: Arabs|Middle Eastern People
savage: simple|indigenous|hunter-gatherer
shlomo: Jewish person
shyster: Jewish person
sophisticated culture: complex culture
sophisticated technology: complex technology
spade: a Black person
spirit animal: favorite|inspiration|personal interest|personality type
stone age: simple|indigenous|hunter-gatherer
too many chiefs: too many chefs in the kitchen|too many cooks spoil the broth
totem: favorite|inspiration|personal interest|personality type
towel heads: Arabs|Middle Eastern People
tribe: society|community
white list: passlist|alrightlist|safelist|allow list
white space: space|blank
white spaces: space|blank
whitelist: passlist|alrightlist|safelist|allow list
whitelisted: passlisted|alrightlisted|safelisted|allow-listed
whitelisting: passlisting|alrightlisting|safelisting|allow-listing
whitespace: space|blank
whitespaces: space|blank

24
styles/alex/Suicide.yml Normal file
View File

@@ -0,0 +1,24 @@
---
extends: substitution
message: When referring to a person, consider using '%s' instead of '%s'.
ignorecase: true
level: warning
action:
name: replace
swap:
commit suicide: die by suicide
committed suicide: died by suicide
complete suicide: die by suicide
completed suicide: died by suicide
epidemic of suicides: rise in suicides
failed attempt: suicide attempt|attempted suicide
failed suicide: suicide attempt|attempted suicide
hang: the app froze|the app stopped responding|the app stopped responding to events|the
app became unresponsive
hanged: the app froze|the app stopped responding|the app stopped responding to events|the
app became unresponsive
successful suicide: die by suicide
suicide epidemic: rise in suicides
suicide failure: suicide attempt|attempted suicide
suicide note: a note from the deceased
suicide pact: rise in suicides

4
styles/alex/meta.json Normal file
View File

@@ -0,0 +1,4 @@
{
"feed": "https://github.com/errata-ai/alex/releases.atom",
"vale_version": ">=1.0.0"
}

View File

@@ -0,0 +1,702 @@
extends: existence
message: "Try to avoid using clichés like '%s'."
ignorecase: true
level: warning
tokens:
- a chip off the old block
- a clean slate
- a dark and stormy night
- a far cry
- a fine kettle of fish
- a loose cannon
- a penny saved is a penny earned
- a tough row to hoe
- a word to the wise
- ace in the hole
- acid test
- add insult to injury
- against all odds
- air your dirty laundry
- all fun and games
- all in a day's work
- all talk, no action
- all thumbs
- all your eggs in one basket
- all's fair in love and war
- all's well that ends well
- almighty dollar
- American as apple pie
- an axe to grind
- another day, another dollar
- armed to the teeth
- as luck would have it
- as old as time
- as the crow flies
- at loose ends
- at my wits end
- avoid like the plague
- babe in the woods
- back against the wall
- back in the saddle
- back to square one
- back to the drawing board
- bad to the bone
- badge of honor
- bald faced liar
- ballpark figure
- banging your head against a brick wall
- baptism by fire
- barking up the wrong tree
- bat out of hell
- be all and end all
- beat a dead horse
- beat around the bush
- been there, done that
- beggars can't be choosers
- behind the eight ball
- bend over backwards
- benefit of the doubt
- bent out of shape
- best thing since sliced bread
- bet your bottom dollar
- better half
- better late than never
- better mousetrap
- better safe than sorry
- between a rock and a hard place
- beyond the pale
- bide your time
- big as life
- big cheese
- big fish in a small pond
- big man on campus
- bigger they are the harder they fall
- bird in the hand
- bird's eye view
- birds and the bees
- birds of a feather flock together
- bit the hand that feeds you
- bite the bullet
- bite the dust
- bitten off more than he can chew
- black as coal
- black as pitch
- black as the ace of spades
- blast from the past
- bleeding heart
- blessing in disguise
- blind ambition
- blind as a bat
- blind leading the blind
- blood is thicker than water
- blood sweat and tears
- blow off steam
- blow your own horn
- blushing bride
- boils down to
- bolt from the blue
- bone to pick
- bored stiff
- bored to tears
- bottomless pit
- boys will be boys
- bright and early
- brings home the bacon
- broad across the beam
- broken record
- brought back to reality
- bull by the horns
- bull in a china shop
- burn the midnight oil
- burning question
- burning the candle at both ends
- burst your bubble
- bury the hatchet
- busy as a bee
- by hook or by crook
- call a spade a spade
- called onto the carpet
- calm before the storm
- can of worms
- can't cut the mustard
- can't hold a candle to
- case of mistaken identity
- cat got your tongue
- cat's meow
- caught in the crossfire
- caught red-handed
- checkered past
- chomping at the bit
- cleanliness is next to godliness
- clear as a bell
- clear as mud
- close to the vest
- cock and bull story
- cold shoulder
- come hell or high water
- cool as a cucumber
- cool, calm, and collected
- cost a king's ransom
- count your blessings
- crack of dawn
- crash course
- creature comforts
- cross that bridge when you come to it
- crushing blow
- cry like a baby
- cry me a river
- cry over spilt milk
- crystal clear
- curiosity killed the cat
- cut and dried
- cut through the red tape
- cut to the chase
- cute as a bugs ear
- cute as a button
- cute as a puppy
- cuts to the quick
- dark before the dawn
- day in, day out
- dead as a doornail
- devil is in the details
- dime a dozen
- divide and conquer
- dog and pony show
- dog days
- dog eat dog
- dog tired
- don't burn your bridges
- don't count your chickens
- don't look a gift horse in the mouth
- don't rock the boat
- don't step on anyone's toes
- don't take any wooden nickels
- down and out
- down at the heels
- down in the dumps
- down the hatch
- down to earth
- draw the line
- dressed to kill
- dressed to the nines
- drives me up the wall
- dull as dishwater
- dyed in the wool
- eagle eye
- ear to the ground
- early bird catches the worm
- easier said than done
- easy as pie
- eat your heart out
- eat your words
- eleventh hour
- even the playing field
- every dog has its day
- every fiber of my being
- everything but the kitchen sink
- eye for an eye
- face the music
- facts of life
- fair weather friend
- fall by the wayside
- fan the flames
- feast or famine
- feather your nest
- feathered friends
- few and far between
- fifteen minutes of fame
- filthy vermin
- fine kettle of fish
- fish out of water
- fishing for a compliment
- fit as a fiddle
- fit the bill
- fit to be tied
- flash in the pan
- flat as a pancake
- flip your lid
- flog a dead horse
- fly by night
- fly the coop
- follow your heart
- for all intents and purposes
- for the birds
- for what it's worth
- force of nature
- force to be reckoned with
- forgive and forget
- fox in the henhouse
- free and easy
- free as a bird
- fresh as a daisy
- full steam ahead
- fun in the sun
- garbage in, garbage out
- gentle as a lamb
- get a kick out of
- get a leg up
- get down and dirty
- get the lead out
- get to the bottom of
- get your feet wet
- gets my goat
- gilding the lily
- give and take
- go against the grain
- go at it tooth and nail
- go for broke
- go him one better
- go the extra mile
- go with the flow
- goes without saying
- good as gold
- good deed for the day
- good things come to those who wait
- good time was had by all
- good times were had by all
- greased lightning
- greek to me
- green thumb
- green-eyed monster
- grist for the mill
- growing like a weed
- hair of the dog
- hand to mouth
- happy as a clam
- happy as a lark
- hasn't a clue
- have a nice day
- have high hopes
- have the last laugh
- haven't got a row to hoe
- head honcho
- head over heels
- hear a pin drop
- heard it through the grapevine
- heart's content
- heavy as lead
- hem and haw
- high and dry
- high and mighty
- high as a kite
- hit paydirt
- hold your head up high
- hold your horses
- hold your own
- hold your tongue
- honest as the day is long
- horns of a dilemma
- horse of a different color
- hot under the collar
- hour of need
- I beg to differ
- icing on the cake
- if the shoe fits
- if the shoe were on the other foot
- in a jam
- in a jiffy
- in a nutshell
- in a pig's eye
- in a pinch
- in a word
- in hot water
- in the gutter
- in the nick of time
- in the thick of it
- in your dreams
- it ain't over till the fat lady sings
- it goes without saying
- it takes all kinds
- it takes one to know one
- it's a small world
- it's only a matter of time
- ivory tower
- Jack of all trades
- jockey for position
- jog your memory
- joined at the hip
- judge a book by its cover
- jump down your throat
- jump in with both feet
- jump on the bandwagon
- jump the gun
- jump to conclusions
- just a hop, skip, and a jump
- just the ticket
- justice is blind
- keep a stiff upper lip
- keep an eye on
- keep it simple, stupid
- keep the home fires burning
- keep up with the Joneses
- keep your chin up
- keep your fingers crossed
- kick the bucket
- kick up your heels
- kick your feet up
- kid in a candy store
- kill two birds with one stone
- kiss of death
- knock it out of the park
- knock on wood
- knock your socks off
- know him from Adam
- know the ropes
- know the score
- knuckle down
- knuckle sandwich
- knuckle under
- labor of love
- ladder of success
- land on your feet
- lap of luxury
- last but not least
- last hurrah
- last-ditch effort
- law of the jungle
- law of the land
- lay down the law
- leaps and bounds
- let sleeping dogs lie
- let the cat out of the bag
- let the good times roll
- let your hair down
- let's talk turkey
- letter perfect
- lick your wounds
- lies like a rug
- life's a bitch
- life's a grind
- light at the end of the tunnel
- lighter than a feather
- lighter than air
- like clockwork
- like father like son
- like taking candy from a baby
- like there's no tomorrow
- lion's share
- live and learn
- live and let live
- long and short of it
- long lost love
- look before you leap
- look down your nose
- look what the cat dragged in
- looking a gift horse in the mouth
- looks like death warmed over
- loose cannon
- lose your head
- lose your temper
- loud as a horn
- lounge lizard
- loved and lost
- low man on the totem pole
- luck of the draw
- luck of the Irish
- make hay while the sun shines
- make money hand over fist
- make my day
- make the best of a bad situation
- make the best of it
- make your blood boil
- man of few words
- man's best friend
- mark my words
- meaningful dialogue
- missed the boat on that one
- moment in the sun
- moment of glory
- moment of truth
- money to burn
- more power to you
- more than one way to skin a cat
- movers and shakers
- moving experience
- naked as a jaybird
- naked truth
- neat as a pin
- needle in a haystack
- needless to say
- neither here nor there
- never look back
- never say never
- nip and tuck
- nip it in the bud
- no guts, no glory
- no love lost
- no pain, no gain
- no skin off my back
- no stone unturned
- no time like the present
- no use crying over spilled milk
- nose to the grindstone
- not a hope in hell
- not a minute's peace
- not in my backyard
- not playing with a full deck
- not the end of the world
- not written in stone
- nothing to sneeze at
- nothing ventured nothing gained
- now we're cooking
- off the top of my head
- off the wagon
- off the wall
- old hat
- older and wiser
- older than dirt
- older than Methuselah
- on a roll
- on cloud nine
- on pins and needles
- on the bandwagon
- on the money
- on the nose
- on the rocks
- on the spot
- on the tip of my tongue
- on the wagon
- on thin ice
- once bitten, twice shy
- one bad apple doesn't spoil the bushel
- one born every minute
- one brick short
- one foot in the grave
- one in a million
- one red cent
- only game in town
- open a can of worms
- open and shut case
- open the flood gates
- opportunity doesn't knock twice
- out of pocket
- out of sight, out of mind
- out of the frying pan into the fire
- out of the woods
- out on a limb
- over a barrel
- over the hump
- pain and suffering
- pain in the
- panic button
- par for the course
- part and parcel
- party pooper
- pass the buck
- patience is a virtue
- pay through the nose
- penny pincher
- perfect storm
- pig in a poke
- pile it on
- pillar of the community
- pin your hopes on
- pitter patter of little feet
- plain as day
- plain as the nose on your face
- play by the rules
- play your cards right
- playing the field
- playing with fire
- pleased as punch
- plenty of fish in the sea
- point with pride
- poor as a church mouse
- pot calling the kettle black
- pretty as a picture
- pull a fast one
- pull your punches
- pulling your leg
- pure as the driven snow
- put it in a nutshell
- put one over on you
- put the cart before the horse
- put the pedal to the metal
- put your best foot forward
- put your foot down
- quick as a bunny
- quick as a lick
- quick as a wink
- quick as lightning
- quiet as a dormouse
- rags to riches
- raining buckets
- raining cats and dogs
- rank and file
- rat race
- reap what you sow
- red as a beet
- red herring
- reinvent the wheel
- rich and famous
- rings a bell
- ripe old age
- ripped me off
- rise and shine
- road to hell is paved with good intentions
- rob Peter to pay Paul
- roll over in the grave
- rub the wrong way
- ruled the roost
- running in circles
- sad but true
- sadder but wiser
- salt of the earth
- scared stiff
- scared to death
- sealed with a kiss
- second to none
- see eye to eye
- seen the light
- seize the day
- set the record straight
- set the world on fire
- set your teeth on edge
- sharp as a tack
- shoot for the moon
- shoot the breeze
- shot in the dark
- shoulder to the wheel
- sick as a dog
- sigh of relief
- signed, sealed, and delivered
- sink or swim
- six of one, half a dozen of another
- skating on thin ice
- slept like a log
- slinging mud
- slippery as an eel
- slow as molasses
- smart as a whip
- smooth as a baby's bottom
- sneaking suspicion
- snug as a bug in a rug
- sow wild oats
- spare the rod, spoil the child
- speak of the devil
- spilled the beans
- spinning your wheels
- spitting image of
- spoke with relish
- spread like wildfire
- spring to life
- squeaky wheel gets the grease
- stands out like a sore thumb
- start from scratch
- stick in the mud
- still waters run deep
- stitch in time
- stop and smell the roses
- straight as an arrow
- straw that broke the camel's back
- strong as an ox
- stubborn as a mule
- stuff that dreams are made of
- stuffed shirt
- sweating blood
- sweating bullets
- take a load off
- take one for the team
- take the bait
- take the bull by the horns
- take the plunge
- takes one to know one
- takes two to tango
- the more the merrier
- the real deal
- the real McCoy
- the red carpet treatment
- the same old story
- there is no accounting for taste
- thick as a brick
- thick as thieves
- thin as a rail
- think outside of the box
- third time's the charm
- this day and age
- this hurts me worse than it hurts you
- this point in time
- three sheets to the wind
- through thick and thin
- throw in the towel
- tie one on
- tighter than a drum
- time and time again
- time is of the essence
- tip of the iceberg
- tired but happy
- to coin a phrase
- to each his own
- to make a long story short
- to the best of my knowledge
- toe the line
- tongue in cheek
- too good to be true
- too hot to handle
- too numerous to mention
- touch with a ten foot pole
- tough as nails
- trial and error
- trials and tribulations
- tried and true
- trip down memory lane
- twist of fate
- two cents worth
- two peas in a pod
- ugly as sin
- under the counter
- under the gun
- under the same roof
- under the weather
- until the cows come home
- unvarnished truth
- up the creek
- uphill battle
- upper crust
- upset the applecart
- vain attempt
- vain effort
- vanquish the enemy
- vested interest
- waiting for the other shoe to drop
- wakeup call
- warm welcome
- watch your p's and q's
- watch your tongue
- watching the clock
- water under the bridge
- weather the storm
- weed them out
- week of Sundays
- went belly up
- wet behind the ears
- what goes around comes around
- what you see is what you get
- when it rains, it pours
- when push comes to shove
- when the cat's away
- when the going gets tough, the tough get going
- white as a sheet
- whole ball of wax
- whole hog
- whole nine yards
- wild goose chase
- will wonders never cease?
- wisdom of the ages
- wise as an owl
- wolf at the door
- words fail me
- work like a dog
- world weary
- worst nightmare
- worth its weight in gold
- wrong side of the bed
- yanking your chain
- yappy as a dog
- years young
- you are what you eat
- you can run but you can't hide
- you only live once
- you're the boss
- young and foolish
- young and vibrant

View File

@@ -0,0 +1,32 @@
extends: existence
message: "Try to avoid using '%s'."
ignorecase: true
level: suggestion
tokens:
- am
- are
- aren't
- be
- been
- being
- he's
- here's
- here's
- how's
- i'm
- is
- isn't
- it's
- she's
- that's
- there's
- they're
- was
- wasn't
- we're
- were
- weren't
- what's
- where's
- who's
- you're

View File

@@ -0,0 +1,11 @@
extends: repetition
message: "'%s' is repeated!"
level: warning
alpha: true
action:
name: edit
params:
- truncate
- " "
tokens:
- '[^\s]+'

View File

@@ -0,0 +1,183 @@
extends: existence
message: "'%s' may be passive voice. Use active voice if you can."
ignorecase: true
level: warning
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

View File

@@ -0,0 +1,27 @@
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.
```

5
styles/write-good/So.yml Normal file
View File

@@ -0,0 +1,5 @@
extends: existence
message: "Don't start a sentence with '%s'."
level: error
raw:
- '(?:[;-]\s)so[\s,]|\bSo[\s,]'

View File

@@ -0,0 +1,6 @@
extends: existence
message: "Don't start a sentence with '%s'."
ignorecase: false
level: error
raw:
- '(?:[;-]\s)There\s(is|are)|\bThere\s(is|are)\b'

View File

@@ -0,0 +1,221 @@
extends: existence
message: "'%s' is too wordy."
ignorecase: true
level: warning
tokens:
- a number of
- abundance
- accede to
- accelerate
- accentuate
- accompany
- accomplish
- accorded
- accrue
- acquiesce
- acquire
- additional
- adjacent to
- adjustment
- admissible
- advantageous
- adversely impact
- advise
- aforementioned
- aggregate
- aircraft
- all of
- all things considered
- alleviate
- allocate
- along the lines of
- already existing
- alternatively
- amazing
- ameliorate
- anticipate
- apparent
- appreciable
- as a matter of fact
- as a means of
- as far as I'm concerned
- as of yet
- as to
- as yet
- ascertain
- assistance
- at the present time
- at this time
- attain
- attributable to
- authorize
- because of the fact that
- belated
- benefit from
- bestow
- by means of
- by virtue of
- by virtue of the fact that
- cease
- close proximity
- commence
- comply with
- concerning
- consequently
- consolidate
- constitutes
- demonstrate
- depart
- designate
- discontinue
- due to the fact that
- each and every
- economical
- eliminate
- elucidate
- employ
- endeavor
- enumerate
- equitable
- equivalent
- evaluate
- evidenced
- exclusively
- expedite
- expend
- expiration
- facilitate
- factual evidence
- feasible
- finalize
- first and foremost
- for all intents and purposes
- for the most part
- for the purpose of
- forfeit
- formulate
- have a tendency to
- honest truth
- however
- if and when
- impacted
- implement
- in a manner of speaking
- in a timely manner
- in a very real sense
- in accordance with
- in addition
- in all likelihood
- in an effort to
- in between
- in excess of
- in lieu of
- in light of the fact that
- in many cases
- in my opinion
- in order to
- in regard to
- in some instances
- in terms of
- in the case of
- in the event that
- in the final analysis
- in the nature of
- in the near future
- in the process of
- inception
- incumbent upon
- indicate
- indication
- initiate
- irregardless
- is applicable to
- is authorized to
- is responsible for
- it is
- it is essential
- it seems that
- it was
- magnitude
- maximum
- methodology
- minimize
- minimum
- modify
- monitor
- multiple
- necessitate
- nevertheless
- not certain
- not many
- not often
- not unless
- not unlike
- notwithstanding
- null and void
- numerous
- objective
- obligate
- obtain
- on the contrary
- on the other hand
- one particular
- optimum
- overall
- owing to the fact that
- participate
- particulars
- pass away
- pertaining to
- point in time
- portion
- possess
- preclude
- previously
- prior to
- prioritize
- procure
- proficiency
- provided that
- purchase
- put simply
- readily apparent
- refer back
- regarding
- relocate
- remainder
- remuneration
- requirement
- reside
- residence
- retain
- satisfy
- shall
- should you wish
- similar to
- solicit
- span across
- strategize
- subsequent
- substantial
- successfully complete
- sufficient
- terminate
- the month of
- the point I am trying to make
- therefore
- time period
- took advantage of
- transmit
- transpire
- type of
- until such time as
- utilization
- utilize
- validate
- various different
- what I mean to say is
- whether or not
- with respect to
- with the exception of
- witnessed

View File

@@ -0,0 +1,207 @@
extends: existence
message: "'%s' is a weasel word!"
ignorecase: true
level: warning
tokens:
- absolutely
- accidentally
- additionally
- allegedly
- alternatively
- angrily
- anxiously
- approximately
- awkwardly
- badly
- barely
- beautifully
- blindly
- boldly
- bravely
- brightly
- briskly
- bristly
- bubbly
- busily
- calmly
- carefully
- carelessly
- cautiously
- cheerfully
- clearly
- closely
- coldly
- completely
- consequently
- correctly
- courageously
- crinkly
- cruelly
- crumbly
- cuddly
- currently
- daily
- daringly
- deadly
- definitely
- deliberately
- doubtfully
- dumbly
- eagerly
- early
- easily
- elegantly
- enormously
- enthusiastically
- equally
- especially
- eventually
- exactly
- exceedingly
- exclusively
- extremely
- fairly
- faithfully
- fatally
- fiercely
- finally
- fondly
- few
- foolishly
- fortunately
- frankly
- frantically
- generously
- gently
- giggly
- gladly
- gracefully
- greedily
- happily
- hardly
- hastily
- healthily
- heartily
- helpfully
- honestly
- hourly
- hungrily
- hurriedly
- immediately
- impatiently
- inadequately
- ingeniously
- innocently
- inquisitively
- interestingly
- irritably
- jiggly
- joyously
- justly
- kindly
- largely
- lately
- lazily
- likely
- literally
- lonely
- loosely
- loudly
- loudly
- luckily
- madly
- many
- mentally
- mildly
- monthly
- mortally
- mostly
- mysteriously
- neatly
- nervously
- nightly
- noisily
- normally
- obediently
- occasionally
- only
- openly
- painfully
- particularly
- patiently
- perfectly
- politely
- poorly
- powerfully
- presumably
- previously
- promptly
- punctually
- quarterly
- quickly
- quietly
- rapidly
- rarely
- really
- recently
- recklessly
- regularly
- remarkably
- relatively
- reluctantly
- repeatedly
- rightfully
- roughly
- rudely
- sadly
- safely
- selfishly
- sensibly
- seriously
- sharply
- shortly
- shyly
- significantly
- silently
- simply
- sleepily
- slowly
- smartly
- smelly
- smoothly
- softly
- solemnly
- sparkly
- speedily
- stealthily
- sternly
- stupidly
- substantially
- successfully
- suddenly
- surprisingly
- suspiciously
- swiftly
- tenderly
- tensely
- thoughtfully
- tightly
- timely
- truthfully
- unexpectedly
- unfortunately
- usually
- very
- victoriously
- violently
- vivaciously
- warmly
- waverly
- weakly
- wearily
- weekly
- wildly
- wisely
- worldly
- wrinkly
- yearly

View File

@@ -0,0 +1,4 @@
{
"feed": "https://github.com/errata-ai/write-good/releases.atom",
"vale_version": ">=1.0.0"
}