mirror of
https://github.com/inspec/inspec
synced 2024-11-10 07:04:15 +00:00
Add vale config to inspec repository
Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
This commit is contained in:
parent
d60f7a8c86
commit
be7cc0932a
79 changed files with 3134 additions and 1 deletions
17
docs-chef-io/.vale.ini
Normal file
17
docs-chef-io/.vale.ini
Normal file
|
@ -0,0 +1,17 @@
|
|||
# Vale configuration file.
|
||||
#
|
||||
# For more information, see https://errata-ai.gitbook.io/vale/getting-started/configuration.
|
||||
|
||||
StylesPath = tools/vale
|
||||
MinAlertLevel = suggestion
|
||||
|
||||
[*.md]
|
||||
BasedOnStyles = Microsoft, write-good, chef
|
||||
|
||||
Microsoft.Contractions = NO
|
||||
Microsoft.Headings = NO
|
||||
Microsoft.GeneralURL = NO
|
||||
Microsoft.RangeFormat = NO
|
||||
|
||||
# Ignore SVG markup
|
||||
TokenIgnores = (\*\*\{\w*\}\*\*)
|
|
@ -73,7 +73,6 @@ There are two ways to preview the documentation in `inspec`:
|
|||
- submit a PR
|
||||
- `make serve`
|
||||
|
||||
|
||||
### Submit a PR
|
||||
|
||||
When you submit a PR to `inspec/inspec`, Netlify will build the documentation
|
||||
|
|
9
docs-chef-io/tools/vale/Microsoft/AMPM.yml
Normal file
9
docs-chef-io/tools/vale/Microsoft/AMPM.yml
Normal 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]\.'
|
25
docs-chef-io/tools/vale/Microsoft/Accessibility.yml
Normal file
25
docs-chef-io/tools/vale/Microsoft/Accessibility.yml
Normal 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
|
64
docs-chef-io/tools/vale/Microsoft/Acronyms.yml
Normal file
64
docs-chef-io/tools/vale/Microsoft/Acronyms.yml
Normal 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
|
270
docs-chef-io/tools/vale/Microsoft/Adverbs.yml
Normal file
270
docs-chef-io/tools/vale/Microsoft/Adverbs.yml
Normal 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
docs-chef-io/tools/vale/Microsoft/Auto.yml
Normal file
11
docs-chef-io/tools/vale/Microsoft/Auto.yml
Normal 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+'
|
14
docs-chef-io/tools/vale/Microsoft/Avoid.yml
Normal file
14
docs-chef-io/tools/vale/Microsoft/Avoid.yml
Normal file
|
@ -0,0 +1,14 @@
|
|||
extends: existence
|
||||
message: "Don't use '%s'."
|
||||
# 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
|
120
docs-chef-io/tools/vale/Microsoft/ComplexWords.yml
Normal file
120
docs-chef-io/tools/vale/Microsoft/ComplexWords.yml
Normal 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
|
30
docs-chef-io/tools/vale/Microsoft/Contractions.yml
Normal file
30
docs-chef-io/tools/vale/Microsoft/Contractions.yml
Normal file
|
@ -0,0 +1,30 @@
|
|||
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
|
||||
should not: shouldn't
|
||||
that is: that's
|
||||
they are: they're
|
||||
was not: wasn't
|
||||
we are: we're
|
||||
we have: we've
|
||||
were not: weren't
|
||||
what is: what's
|
||||
when is: when's
|
||||
where is: where's
|
||||
will not: won't
|
13
docs-chef-io/tools/vale/Microsoft/Dashes.yml
Normal file
13
docs-chef-io/tools/vale/Microsoft/Dashes.yml
Normal 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[—–]'
|
8
docs-chef-io/tools/vale/Microsoft/DateFormat.yml
Normal file
8
docs-chef-io/tools/vale/Microsoft/DateFormat.yml
Normal 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}'
|
40
docs-chef-io/tools/vale/Microsoft/DateNumbers.yml
Normal file
40
docs-chef-io/tools/vale/Microsoft/DateNumbers.yml
Normal 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
|
8
docs-chef-io/tools/vale/Microsoft/DateOrder.yml
Normal file
8
docs-chef-io/tools/vale/Microsoft/DateOrder.yml
Normal 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'
|
9
docs-chef-io/tools/vale/Microsoft/Ellipses.yml
Normal file
9
docs-chef-io/tools/vale/Microsoft/Ellipses.yml
Normal 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:
|
||||
- '\.\.\.'
|
13
docs-chef-io/tools/vale/Microsoft/FirstPerson.yml
Normal file
13
docs-chef-io/tools/vale/Microsoft/FirstPerson.yml
Normal file
|
@ -0,0 +1,13 @@
|
|||
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'm\b
|
||||
- \bme\b
|
||||
- \bmy\b
|
||||
- \bmine\b
|
12
docs-chef-io/tools/vale/Microsoft/Foreign.yml
Normal file
12
docs-chef-io/tools/vale/Microsoft/Foreign.yml
Normal 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
|
||||
|
8
docs-chef-io/tools/vale/Microsoft/Gender.yml
Normal file
8
docs-chef-io/tools/vale/Microsoft/Gender.yml
Normal 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
|
44
docs-chef-io/tools/vale/Microsoft/GenderBias.yml
Normal file
44
docs-chef-io/tools/vale/Microsoft/GenderBias.yml
Normal 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)
|
11
docs-chef-io/tools/vale/Microsoft/GeneralURL.yml
Normal file
11
docs-chef-io/tools/vale/Microsoft/GeneralURL.yml
Normal 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
|
7
docs-chef-io/tools/vale/Microsoft/HeadingAcronyms.yml
Normal file
7
docs-chef-io/tools/vale/Microsoft/HeadingAcronyms.yml
Normal 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}'
|
8
docs-chef-io/tools/vale/Microsoft/HeadingColons.yml
Normal file
8
docs-chef-io/tools/vale/Microsoft/HeadingColons.yml
Normal 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]'
|
13
docs-chef-io/tools/vale/Microsoft/HeadingPunctuation.yml
Normal file
13
docs-chef-io/tools/vale/Microsoft/HeadingPunctuation.yml
Normal 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|$)'
|
28
docs-chef-io/tools/vale/Microsoft/Headings.yml
Normal file
28
docs-chef-io/tools/vale/Microsoft/Headings.yml
Normal 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
|
14
docs-chef-io/tools/vale/Microsoft/Hyphens.yml
Normal file
14
docs-chef-io/tools/vale/Microsoft/Hyphens.yml
Normal 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-'
|
13
docs-chef-io/tools/vale/Microsoft/Negative.yml
Normal file
13
docs-chef-io/tools/vale/Microsoft/Negative.yml
Normal 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'
|
13
docs-chef-io/tools/vale/Microsoft/Ordinal.yml
Normal file
13
docs-chef-io/tools/vale/Microsoft/Ordinal.yml
Normal 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
|
8
docs-chef-io/tools/vale/Microsoft/OxfordComma.yml
Normal file
8
docs-chef-io/tools/vale/Microsoft/OxfordComma.yml
Normal 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+[.?!]'
|
183
docs-chef-io/tools/vale/Microsoft/Passive.yml
Normal file
183
docs-chef-io/tools/vale/Microsoft/Passive.yml
Normal 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
|
7
docs-chef-io/tools/vale/Microsoft/Percentages.yml
Normal file
7
docs-chef-io/tools/vale/Microsoft/Percentages.yml
Normal 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'
|
7
docs-chef-io/tools/vale/Microsoft/Quotes.yml
Normal file
7
docs-chef-io/tools/vale/Microsoft/Quotes.yml
Normal 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:
|
||||
- '["“][^"”“]+["”][.,]'
|
13
docs-chef-io/tools/vale/Microsoft/RangeFormat.yml
Normal file
13
docs-chef-io/tools/vale/Microsoft/RangeFormat.yml
Normal 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'
|
13
docs-chef-io/tools/vale/Microsoft/RangeTime.yml
Normal file
13
docs-chef-io/tools/vale/Microsoft/RangeTime.yml
Normal 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'
|
7
docs-chef-io/tools/vale/Microsoft/Ranges.yml
Normal file
7
docs-chef-io/tools/vale/Microsoft/Ranges.yml
Normal 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'
|
8
docs-chef-io/tools/vale/Microsoft/Semicolon.yml
Normal file
8
docs-chef-io/tools/vale/Microsoft/Semicolon.yml
Normal 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:
|
||||
- ';'
|
7
docs-chef-io/tools/vale/Microsoft/SentenceLength.yml
Normal file
7
docs-chef-io/tools/vale/Microsoft/SentenceLength.yml
Normal 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
|
||||
|
8
docs-chef-io/tools/vale/Microsoft/Spacing.yml
Normal file
8
docs-chef-io/tools/vale/Microsoft/Spacing.yml
Normal 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]'
|
7
docs-chef-io/tools/vale/Microsoft/Suspended.yml
Normal file
7
docs-chef-io/tools/vale/Microsoft/Suspended.yml
Normal 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+-'
|
43
docs-chef-io/tools/vale/Microsoft/Terms.yml
Normal file
43
docs-chef-io/tools/vale/Microsoft/Terms.yml
Normal 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
|
10
docs-chef-io/tools/vale/Microsoft/URLFormat.yml
Normal file
10
docs-chef-io/tools/vale/Microsoft/URLFormat.yml
Normal 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
|
||||
|
16
docs-chef-io/tools/vale/Microsoft/Units.yml
Normal file
16
docs-chef-io/tools/vale/Microsoft/Units.yml
Normal 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
|
25
docs-chef-io/tools/vale/Microsoft/Vocab.yml
Normal file
25
docs-chef-io/tools/vale/Microsoft/Vocab.yml
Normal 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
docs-chef-io/tools/vale/Microsoft/We.yml
Normal file
11
docs-chef-io/tools/vale/Microsoft/We.yml
Normal 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
|
122
docs-chef-io/tools/vale/Microsoft/Wordiness.yml
Normal file
122
docs-chef-io/tools/vale/Microsoft/Wordiness.yml
Normal 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
|
4
docs-chef-io/tools/vale/Microsoft/meta.json
Normal file
4
docs-chef-io/tools/vale/Microsoft/meta.json
Normal file
|
@ -0,0 +1,4 @@
|
|||
{
|
||||
"feed": "https://github.com/errata-ai/Microsoft/releases.atom",
|
||||
"vale_version": ">=1.0.0"
|
||||
}
|
0
docs-chef-io/tools/vale/Vocab/tech-blogging/accept.txt
Normal file
0
docs-chef-io/tools/vale/Vocab/tech-blogging/accept.txt
Normal file
0
docs-chef-io/tools/vale/Vocab/tech-blogging/reject.txt
Normal file
0
docs-chef-io/tools/vale/Vocab/tech-blogging/reject.txt
Normal file
7
docs-chef-io/tools/vale/chef/OxfordComma.yml
Normal file
7
docs-chef-io/tools/vale/chef/OxfordComma.yml
Normal file
|
@ -0,0 +1,7 @@
|
|||
extends: existence
|
||||
message: 'Use the Oxford comma in a list of three or more items.'
|
||||
link: 'https://contribute.jquery.org/style-guide/prose/#grammar'
|
||||
scope: sentence
|
||||
level: warning
|
||||
tokens:
|
||||
- '(?:[^,]+,){1,}\s\w+\sand'
|
24
docs-chef-io/tools/vale/chef/acronyms.yml
Normal file
24
docs-chef-io/tools/vale/chef/acronyms.yml
Normal file
|
@ -0,0 +1,24 @@
|
|||
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:
|
||||
- REST
|
||||
- API
|
||||
- CMDB
|
||||
- URL
|
||||
- FQDN
|
||||
- CPU
|
||||
- https
|
||||
- JSON
|
||||
- AWS
|
||||
- VPN
|
||||
- CIDR
|
||||
- DHCP
|
||||
- ARN
|
||||
- IAM
|
11
docs-chef-io/tools/vale/chef/capitalize.yml
Normal file
11
docs-chef-io/tools/vale/chef/capitalize.yml
Normal file
|
@ -0,0 +1,11 @@
|
|||
extends: substitution
|
||||
message: "Use '%s' instead of '%s'"
|
||||
level: error
|
||||
ignorecase: false
|
||||
swap:
|
||||
'Microsoft Windows': Windows
|
||||
'windows': Windows
|
||||
'linux': Linux
|
||||
'postgreSQL' : PostgreSQL
|
||||
'postgresql' : PostgreSQL
|
||||
|
6
docs-chef-io/tools/vale/chef/chef_automate.yml
Normal file
6
docs-chef-io/tools/vale/chef/chef_automate.yml
Normal file
|
@ -0,0 +1,6 @@
|
|||
extends: substitution
|
||||
message: "Use '%s' instead of '%s'"
|
||||
level: error
|
||||
ignorecase: false
|
||||
swap:
|
||||
'(?:[^\s]*) ?Automate': Chef Automate
|
7
docs-chef-io/tools/vale/chef/chef_desktop.yml
Normal file
7
docs-chef-io/tools/vale/chef/chef_desktop.yml
Normal file
|
@ -0,0 +1,7 @@
|
|||
extends: substitution
|
||||
message: "Use '%s' instead of '%s'"
|
||||
level: error
|
||||
ignorecase: true
|
||||
swap:
|
||||
# '(?[^\s]*(Windows|macOS))? Desktop': Chef Desktop
|
||||
'chefdesktop': Chef Desktop
|
6
docs-chef-io/tools/vale/chef/chef_habitat.yml
Normal file
6
docs-chef-io/tools/vale/chef/chef_habitat.yml
Normal file
|
@ -0,0 +1,6 @@
|
|||
extends: substitution
|
||||
message: "Use Use '%s' instead of 'Habitat'."
|
||||
level: error
|
||||
swap:
|
||||
'(?:[^\s]* ){0,1}Habitat': Chef Habitat
|
||||
|
7
docs-chef-io/tools/vale/chef/chef_infra_client.yml
Normal file
7
docs-chef-io/tools/vale/chef/chef_infra_client.yml
Normal file
|
@ -0,0 +1,7 @@
|
|||
extends: substitution
|
||||
message: "Use '%s' instead of '%s'"
|
||||
level: error
|
||||
ignorecase: true
|
||||
swap:
|
||||
'chef client': Chef Infra Client
|
||||
'chef-client': Chef Infra Client
|
7
docs-chef-io/tools/vale/chef/chef_infra_server.yml
Normal file
7
docs-chef-io/tools/vale/chef/chef_infra_server.yml
Normal file
|
@ -0,0 +1,7 @@
|
|||
extends: substitution
|
||||
message: "Use '%s' instead of '%s'"
|
||||
level: error
|
||||
ignorecase: true
|
||||
swap:
|
||||
'Chef Server': Chef Infra Server
|
||||
|
6
docs-chef-io/tools/vale/chef/chef_inspec.yml
Normal file
6
docs-chef-io/tools/vale/chef/chef_inspec.yml
Normal file
|
@ -0,0 +1,6 @@
|
|||
extends: substitution
|
||||
message: "Use '%s' instead of '%s'"
|
||||
level: error
|
||||
ignorecase: true
|
||||
swap:
|
||||
'(?:[^\s]*) ?InSpec': Chef InSpec
|
6
docs-chef-io/tools/vale/chef/habitat_builder.yml
Normal file
6
docs-chef-io/tools/vale/chef/habitat_builder.yml
Normal file
|
@ -0,0 +1,6 @@
|
|||
extends: substitution
|
||||
message: "Use Use '%s' instead of 'Builder'."
|
||||
level: error
|
||||
swap:
|
||||
'(?:[^\s]* ){0,2}Builder': Chef Habitat Builder
|
||||
|
6
docs-chef-io/tools/vale/chef/habitat_depot.yml
Normal file
6
docs-chef-io/tools/vale/chef/habitat_depot.yml
Normal file
|
@ -0,0 +1,6 @@
|
|||
extends: substitution
|
||||
message: "Use Use '%s' instead of 'Depot'."
|
||||
level: error
|
||||
swap:
|
||||
'Depot': Chef Habitat Artifact storage
|
||||
|
6
docs-chef-io/tools/vale/chef/habitat_studio.yml
Normal file
6
docs-chef-io/tools/vale/chef/habitat_studio.yml
Normal file
|
@ -0,0 +1,6 @@
|
|||
extends: substitution
|
||||
message: "Use Use '%s' instead of 'Studio'."
|
||||
level: error
|
||||
swap:
|
||||
'(?:[^\s]* ){0,2}Studio': Chef Habitat Studio
|
||||
|
6
docs-chef-io/tools/vale/chef/habitat_supervisor.yml
Normal file
6
docs-chef-io/tools/vale/chef/habitat_supervisor.yml
Normal file
|
@ -0,0 +1,6 @@
|
|||
extends: substitution
|
||||
message: "Use Use '%s' instead of 'Supervisor'."
|
||||
level: error
|
||||
swap:
|
||||
'(?:[^\s]* ){0,2}Supervisor': Chef Habitat Supervisor
|
||||
|
6
docs-chef-io/tools/vale/chef/policyfile.yml
Normal file
6
docs-chef-io/tools/vale/chef/policyfile.yml
Normal file
|
@ -0,0 +1,6 @@
|
|||
extends: substitution
|
||||
message: "Use '%s' instead of '%s'"
|
||||
level: error
|
||||
ignorecase: true
|
||||
swap:
|
||||
'policy file': Policyfile
|
33
docs-chef-io/tools/vale/chef/rule-form.txt
Normal file
33
docs-chef-io/tools/vale/chef/rule-form.txt
Normal file
|
@ -0,0 +1,33 @@
|
|||
# All rules should define the following header keys:
|
||||
#
|
||||
# `extends` indicates the extension point being used (see below for information
|
||||
# on the possible values).
|
||||
extends: existence
|
||||
# `message` is shown to the user when the rule is broken.
|
||||
#
|
||||
# Many extension points accept format specifiers (%s), which are replaced by
|
||||
# extracted values. See the exention-specific sections below for more details.
|
||||
message: "Consider removing '%s'"
|
||||
# `level` assigns the rule's severity.
|
||||
#
|
||||
# The accepted values are suggestion, warning, and error.
|
||||
level: warning
|
||||
# `scope` specifies where this rule should apply -- e.g., headings, sentences, etc.
|
||||
#
|
||||
# See the Markup section for more information on scoping.
|
||||
scope: heading
|
||||
# `code` determines whether or not the content of code spans -- e.g., `foo` for
|
||||
# Markdown -- is ignored.
|
||||
code: false
|
||||
# `link` gives the source for this rule.
|
||||
link: 'https://errata.ai/'
|
||||
|
||||
# Example Style
|
||||
extends: existence
|
||||
message: Consider removing '%s'
|
||||
level: warning
|
||||
code: false
|
||||
ignorecase: true
|
||||
tokens:
|
||||
- appears to be
|
||||
- arguably
|
51
docs-chef-io/tools/vale/vale.tmpl
Normal file
51
docs-chef-io/tools/vale/vale.tmpl
Normal file
|
@ -0,0 +1,51 @@
|
|||
{{- /* Modify Vale's output https://docs.errata.ai/vale/cli#--output */ -}}
|
||||
|
||||
{{- /* Keep track of our various counts */ -}}
|
||||
|
||||
{{- $e := 0 -}}
|
||||
{{- $w := 0 -}}
|
||||
{{- $s := 0 -}}
|
||||
{{- $f := 0 -}}
|
||||
|
||||
{{- /* Range over the linted files */ -}}
|
||||
|
||||
{{- range .Files}}
|
||||
|
||||
{{- $f = add1 $f -}}
|
||||
{{- $path := .Path | underline -}}
|
||||
|
||||
{{- /* 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}}
|
||||
|
||||
{{- /* Variables setup */ -}}
|
||||
|
||||
{{- $path = $path -}}
|
||||
{{- $loc := printf "Line %d, position %d" .Line (index .Span 0) -}}
|
||||
{{- $check := printf "%s" .Check -}}
|
||||
{{- $message := printf "%s" .Message -}}
|
||||
{{- $link := printf "%s" .Link -}}
|
||||
|
||||
{{- /* Output */ -}}
|
||||
|
||||
{{ $path }}:
|
||||
{{ $loc }} (rule {{ $check }})
|
||||
{{ $error }}: {{ $message }}
|
||||
More information: {{ $link }}
|
||||
|
||||
{{end -}}
|
||||
{{end -}}
|
||||
|
||||
{{- $e}} {{"errors" | red}}, {{$w}} {{"warnings" | yellow}}, and {{$s}} {{"suggestions" | blue}} found in {{$f}} {{$f | int | plural "file" "files"}}.
|
9
docs-chef-io/tools/vale/vale/Annotations.yml
Executable file
9
docs-chef-io/tools/vale/vale/Annotations.yml
Executable file
|
@ -0,0 +1,9 @@
|
|||
message: "'%s' left in text"
|
||||
extends: existence
|
||||
ignorecase: false
|
||||
level: suggestion
|
||||
tokens:
|
||||
- XXX
|
||||
- FIXME
|
||||
- TODO
|
||||
- NOTE
|
44
docs-chef-io/tools/vale/vale/Editorializing.yml
Executable file
44
docs-chef-io/tools/vale/vale/Editorializing.yml
Executable file
|
@ -0,0 +1,44 @@
|
|||
extends: existence
|
||||
message: "Consider removing '%s'"
|
||||
ignorecase: true
|
||||
level: warning
|
||||
tokens:
|
||||
- actually
|
||||
- aptly
|
||||
- are a number
|
||||
- basically
|
||||
- clearly
|
||||
- completely
|
||||
- essentially
|
||||
- exceedingly
|
||||
- excellent
|
||||
- extremely
|
||||
- fairly
|
||||
- fortunately
|
||||
- huge
|
||||
- interestingly
|
||||
- is a number
|
||||
- it is important to realize
|
||||
- it should be noted that
|
||||
- largely
|
||||
- mostly
|
||||
- notably
|
||||
- note that
|
||||
- obviously
|
||||
- of course
|
||||
- quite
|
||||
- relatively
|
||||
- remarkably
|
||||
- several
|
||||
- significantly
|
||||
- substantially
|
||||
- surprisingly
|
||||
- tiny
|
||||
- totally
|
||||
- tragically
|
||||
- unfortunately
|
||||
- untimely
|
||||
- various
|
||||
- vast
|
||||
- very
|
||||
- without a doubt
|
28
docs-chef-io/tools/vale/vale/Hedging.yml
Executable file
28
docs-chef-io/tools/vale/vale/Hedging.yml
Executable file
|
@ -0,0 +1,28 @@
|
|||
extends: existence
|
||||
message: "Consider removing '%s'"
|
||||
ignorecase: true
|
||||
level: warning
|
||||
tokens:
|
||||
- appear to be
|
||||
- arguably
|
||||
- as far as I know
|
||||
- could
|
||||
- from my point of view
|
||||
- hopefully
|
||||
- I believe
|
||||
- I doubt
|
||||
- I think
|
||||
- in general
|
||||
- In my opinion
|
||||
- likely
|
||||
- might
|
||||
- more or less
|
||||
- perhaps
|
||||
- possibly
|
||||
- presumably
|
||||
- probably
|
||||
- seem(s)?
|
||||
- somewhat
|
||||
- to my knowledge
|
||||
- unlikely
|
||||
- usually
|
28
docs-chef-io/tools/vale/vale/Litotes.yml
Executable file
28
docs-chef-io/tools/vale/vale/Litotes.yml
Executable file
|
@ -0,0 +1,28 @@
|
|||
extends: substitution
|
||||
message: Consider using '%s' instead of '%s'
|
||||
ignorecase: true
|
||||
level: warning
|
||||
swap:
|
||||
no minor: major
|
||||
no ordinary: extraordinary
|
||||
no(?:t)? small: large
|
||||
not (?:a)? bad: good
|
||||
not accept(?:ed)?: rejected
|
||||
not allow(?:ed)?: prevented
|
||||
not certain: uncertain
|
||||
not consider(?:ed)?: ignored
|
||||
not fail: passed
|
||||
not have: lack(s)
|
||||
not many: few
|
||||
not old enough: too young
|
||||
not remember: forgot
|
||||
not succeed: failed
|
||||
not the brightest: dumb
|
||||
not the same: different
|
||||
not unaware: aware
|
||||
not unclean: clean
|
||||
not unfamiliar: familiar
|
||||
not unlike: like
|
||||
not unpleasant: pleasant
|
||||
not useless: useful
|
||||
not wrong: right
|
67
docs-chef-io/tools/vale/vale/Redundancy.yml
Executable file
67
docs-chef-io/tools/vale/vale/Redundancy.yml
Executable file
|
@ -0,0 +1,67 @@
|
|||
extends: existence
|
||||
message: "'%s' is redundant"
|
||||
ignorecase: true
|
||||
level: error
|
||||
tokens:
|
||||
- (?:added|extra) bonus
|
||||
- (?:advance|prior) notice
|
||||
- (?:gather|assemble|attach|blend|mix|combine|collaborate|connect|cooperate) together
|
||||
- (?:terrible|horrible) tragedy
|
||||
- \d{1,2} ?a\.?m\.? in the morning
|
||||
- \d{1,2} ?p\.?m\.? at night
|
||||
- \d{1,2} ?p\.?m\.? in the afternoon
|
||||
- \d{1,2} ?p\.?m\.? in the evening
|
||||
- ABM missile
|
||||
- ABM missiles
|
||||
- ABS braking system
|
||||
- absolutely (?:necessary|essential)
|
||||
- ACT test
|
||||
- already existing
|
||||
- armed gunman
|
||||
- artificial prosthesis
|
||||
- ATM machine
|
||||
- bald-headed
|
||||
- brief (?:moment|summary)
|
||||
- CD disc
|
||||
- cease and desist
|
||||
- circle around
|
||||
- close proximity
|
||||
- closed fist
|
||||
- completely (?:destroyed|eliminate|engulfed|filled|surround)
|
||||
- could possibly
|
||||
- CPI Index
|
||||
- current trend(s)?
|
||||
- end result
|
||||
- enter in
|
||||
- erode away
|
||||
- false pretense
|
||||
- final result
|
||||
- free gift
|
||||
- GPS system
|
||||
- GUI interface
|
||||
- HIV virus
|
||||
- inner feelings
|
||||
- ISBN number
|
||||
- join together
|
||||
- LCD display
|
||||
- local resident(s)?
|
||||
- natural instinct
|
||||
- new invention
|
||||
- null and void
|
||||
- past history
|
||||
- PDF format
|
||||
- PIN number
|
||||
- please RSVP
|
||||
- RAM memory
|
||||
- RAS syndrome
|
||||
- RIP in peace
|
||||
- safe haven
|
||||
- SALT talks
|
||||
- SAT test
|
||||
- shout loudly
|
||||
- surrounded on all sides
|
||||
- undergraduate student
|
||||
- unexpected surprise
|
||||
- unintended mistake
|
||||
- UPC code(s)?
|
||||
- violent explosion
|
44
docs-chef-io/tools/vale/vale/Uncomparables.yml
Executable file
44
docs-chef-io/tools/vale/vale/Uncomparables.yml
Executable file
|
@ -0,0 +1,44 @@
|
|||
extends: existence
|
||||
message: "'%s' is not comparable"
|
||||
ignorecase: true
|
||||
level: error
|
||||
raw:
|
||||
- \b(?:absolutely|most|more|less|least|very|quite|largely|extremely|increasingly|kind of|mildy|hardly|greatly|sort of)\b\s*
|
||||
tokens:
|
||||
- absolute
|
||||
- adequate
|
||||
- complete
|
||||
- correct
|
||||
- certain
|
||||
- devoid
|
||||
- entire
|
||||
- 'false'
|
||||
- fatal
|
||||
- favorite
|
||||
- final
|
||||
- ideal
|
||||
- impossible
|
||||
- inevitable
|
||||
- infinite
|
||||
- irrevocable
|
||||
- main
|
||||
- manifest
|
||||
- only
|
||||
- paramount
|
||||
- perfect
|
||||
- perpetual
|
||||
- possible
|
||||
- preferable
|
||||
- principal
|
||||
- singular
|
||||
- stationary
|
||||
- sufficient
|
||||
- 'true'
|
||||
- unanimous
|
||||
- unavoidable
|
||||
- unbroken
|
||||
- uniform
|
||||
- unique
|
||||
- universal
|
||||
- void
|
||||
- whole
|
702
docs-chef-io/tools/vale/write-good/Cliches.yml
Normal file
702
docs-chef-io/tools/vale/write-good/Cliches.yml
Normal 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
|
32
docs-chef-io/tools/vale/write-good/E-Prime.yml
Normal file
32
docs-chef-io/tools/vale/write-good/E-Prime.yml
Normal 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
|
11
docs-chef-io/tools/vale/write-good/Illusions.yml
Normal file
11
docs-chef-io/tools/vale/write-good/Illusions.yml
Normal file
|
@ -0,0 +1,11 @@
|
|||
extends: repetition
|
||||
message: "'%s' is repeated!"
|
||||
level: warning
|
||||
alpha: true
|
||||
action:
|
||||
name: edit
|
||||
params:
|
||||
- truncate
|
||||
- " "
|
||||
tokens:
|
||||
- '[^\s]+'
|
183
docs-chef-io/tools/vale/write-good/Passive.yml
Normal file
183
docs-chef-io/tools/vale/write-good/Passive.yml
Normal 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
|
27
docs-chef-io/tools/vale/write-good/README.md
Normal file
27
docs-chef-io/tools/vale/write-good/README.md
Normal 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
docs-chef-io/tools/vale/write-good/So.yml
Normal file
5
docs-chef-io/tools/vale/write-good/So.yml
Normal file
|
@ -0,0 +1,5 @@
|
|||
extends: existence
|
||||
message: "Don't start a sentence with '%s'."
|
||||
level: error
|
||||
raw:
|
||||
- '(?:[;-]\s)so[\s,]|\bSo[\s,]'
|
6
docs-chef-io/tools/vale/write-good/ThereIs.yml
Normal file
6
docs-chef-io/tools/vale/write-good/ThereIs.yml
Normal 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'
|
221
docs-chef-io/tools/vale/write-good/TooWordy.yml
Normal file
221
docs-chef-io/tools/vale/write-good/TooWordy.yml
Normal 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
|
207
docs-chef-io/tools/vale/write-good/Weasel.yml
Normal file
207
docs-chef-io/tools/vale/write-good/Weasel.yml
Normal 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
|
4
docs-chef-io/tools/vale/write-good/meta.json
Normal file
4
docs-chef-io/tools/vale/write-good/meta.json
Normal file
|
@ -0,0 +1,4 @@
|
|||
{
|
||||
"feed": "https://github.com/errata-ai/write-good/releases.atom",
|
||||
"vale_version": ">=1.0.0"
|
||||
}
|
Loading…
Reference in a new issue