Update Vale guidelines checker and fix issues (#570)

* updated vale
* fix Vale issues
* exclude vale style dirs from lint checks

Signed-off-by: Nicolas MASSART <nicolas.massart@consensys.net>
pull/572/head
Nicolas MASSART 4 years ago committed by GitHub
parent 6b736d56ae
commit d2383df15b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 56
      .circleci/config.yml
  2. 2
      .github/pull_request_template.md
  3. 2
      .markdownlintignore
  4. 4
      CI/scripts/README.md
  5. 25
      CI/vale/.vale.ini
  6. 7
      CI/vale/vale_styles/Besu/Acronyms.yml
  7. 45
      CI/vale/vale_styles/Besu/Headings.yml
  8. 8
      CI/vale/vale_styles/Besu/Latin.yml
  9. 0
      CI/vale/vale_styles/Microsoft/AMPM.yml
  10. 4
      CI/vale/vale_styles/Microsoft/Accessibility.yml
  11. 2
      CI/vale/vale_styles/Microsoft/Acronyms.yml
  12. 2
      CI/vale/vale_styles/Microsoft/Adverbs.yml
  13. 11
      CI/vale/vale_styles/Microsoft/Auto.yml
  14. 7
      CI/vale/vale_styles/Microsoft/Avoid.yml
  15. 12
      CI/vale/vale_styles/Microsoft/Backend.yml
  16. 120
      CI/vale/vale_styles/Microsoft/ComplexWords.yml
  17. 4
      CI/vale/vale_styles/Microsoft/Contractions.yml
  18. 5
      CI/vale/vale_styles/Microsoft/Dashes.yml
  19. 0
      CI/vale/vale_styles/Microsoft/DateFormat.yml
  20. 40
      CI/vale/vale_styles/Microsoft/DateNumbers.yml
  21. 2
      CI/vale/vale_styles/Microsoft/DateOrder.yml
  22. 4
      CI/vale/vale_styles/Microsoft/Ellipses.yml
  23. 13
      CI/vale/vale_styles/Microsoft/FirstPerson.yml
  24. 4
      CI/vale/vale_styles/Microsoft/Foreign.yml
  25. 2
      CI/vale/vale_styles/Microsoft/Gender.yml
  26. 44
      CI/vale/vale_styles/Microsoft/GenderBias.yml
  27. 11
      CI/vale/vale_styles/Microsoft/GeneralURL.yml
  28. 2
      CI/vale/vale_styles/Microsoft/HeadingAcronyms.yml
  29. 2
      CI/vale/vale_styles/Microsoft/HeadingColons.yml
  30. 7
      CI/vale/vale_styles/Microsoft/HeadingPunctuation.yml
  31. 2
      CI/vale/vale_styles/Microsoft/Headings.yml
  32. 6
      CI/vale/vale_styles/Microsoft/Hyphens.yml
  33. 0
      CI/vale/vale_styles/Microsoft/LICENSE
  34. 13
      CI/vale/vale_styles/Microsoft/Negative.yml
  35. 7
      CI/vale/vale_styles/Microsoft/Ordinal.yml
  36. 7
      CI/vale/vale_styles/Microsoft/OxfordComma.yml
  37. 0
      CI/vale/vale_styles/Microsoft/Passive.yml
  38. 2
      CI/vale/vale_styles/Microsoft/Percentages.yml
  39. 0
      CI/vale/vale_styles/Microsoft/Quotes.yml
  40. 8
      CI/vale/vale_styles/Microsoft/RangeFormat.yml
  41. 8
      CI/vale/vale_styles/Microsoft/RangeTime.yml
  42. 0
      CI/vale/vale_styles/Microsoft/Ranges.yml
  43. 0
      CI/vale/vale_styles/Microsoft/Semicolon.yml
  44. 2
      CI/vale/vale_styles/Microsoft/SentenceLength.yml
  45. 0
      CI/vale/vale_styles/Microsoft/Spacing.yml
  46. 0
      CI/vale/vale_styles/Microsoft/Suspended.yml
  47. 2
      CI/vale/vale_styles/Microsoft/Terms.yml
  48. 4
      CI/vale/vale_styles/Microsoft/URLFormat.yml
  49. 0
      CI/vale/vale_styles/Microsoft/Units.yml
  50. 2
      CI/vale/vale_styles/Microsoft/Vocab.yml
  51. 6
      CI/vale/vale_styles/Microsoft/We.yml
  52. 14
      CI/vale/vale_styles/Microsoft/Wordiness.yml
  53. 4
      CI/vale/vale_styles/Microsoft/meta.json
  54. 0
      CI/vale/vale_styles/Microsoft/vocab.txt
  55. 13
      CI/vale/vale_styles/README.md
  56. 147
      CI/vale/vale_styles/Vocab/Besu/accept.txt
  57. 1
      CI/vale/vale_styles/Vocab/Besu/reject.txt
  58. 8
      CI/vale/vale_styles/proselint/Airlinese.yml
  59. 48
      CI/vale/vale_styles/proselint/AnimalLabels.yml
  60. 9
      CI/vale/vale_styles/proselint/Annotations.yml
  61. 8
      CI/vale/vale_styles/proselint/Apologizing.yml
  62. 52
      CI/vale/vale_styles/proselint/Archaisms.yml
  63. 8
      CI/vale/vale_styles/proselint/But.yml
  64. 782
      CI/vale/vale_styles/proselint/Cliches.yml
  65. 30
      CI/vale/vale_styles/proselint/CorporateSpeak.yml
  66. 5
      CI/vale/vale_styles/proselint/Currency.yml
  67. 15
      CI/vale/vale_styles/proselint/Cursing.yml
  68. 7
      CI/vale/vale_styles/proselint/DateCase.yml
  69. 7
      CI/vale/vale_styles/proselint/DateMidnight.yml
  70. 10
      CI/vale/vale_styles/proselint/DateRedundancy.yml
  71. 7
      CI/vale/vale_styles/proselint/DateSpacing.yml
  72. 52
      CI/vale/vale_styles/proselint/DenizenLabels.yml
  73. 96
      CI/vale/vale_styles/proselint/Diacritical.yml
  74. 5
      CI/vale/vale_styles/proselint/GenderBias.yml
  75. 39
      CI/vale/vale_styles/proselint/GroupTerms.yml
  76. 8
      CI/vale/vale_styles/proselint/Hedging.yml
  77. 6
      CI/vale/vale_styles/proselint/Hyperbole.yml
  78. 11
      CI/vale/vale_styles/proselint/Jargon.yml
  79. 13
      CI/vale/vale_styles/proselint/LGBTOffensive.yml
  80. 15
      CI/vale/vale_styles/proselint/LGBTTerms.yml
  81. 8
      CI/vale/vale_styles/proselint/Malapropisms.yml
  82. 361
      CI/vale/vale_styles/proselint/Needless.yml
  83. 38
      CI/vale/vale_styles/proselint/Nonwords.yml
  84. 22
      CI/vale/vale_styles/proselint/Oxymorons.yml
  85. 6
      CI/vale/vale_styles/proselint/P-Value.yml
  86. 30
      CI/vale/vale_styles/proselint/RASSyndrome.yml
  87. 12
      CI/vale/vale_styles/proselint/README.md
  88. 13
      CI/vale/vale_styles/proselint/Skunked.yml
  89. 17
      CI/vale/vale_styles/proselint/Spelling.yml
  90. 11
      CI/vale/vale_styles/proselint/Typography.yml
  91. 50
      CI/vale/vale_styles/proselint/Uncomparables.yml
  92. 6
      CI/vale/vale_styles/proselint/Very.yml
  93. 17
      CI/vale/vale_styles/proselint/meta.json
  94. 702
      CI/vale/vale_styles/write-good/Cliches.yml
  95. 32
      CI/vale/vale_styles/write-good/E-Prime.yml
  96. 11
      CI/vale/vale_styles/write-good/Illusions.yml
  97. 183
      CI/vale/vale_styles/write-good/Passive.yml
  98. 27
      CI/vale/vale_styles/write-good/README.md
  99. 5
      CI/vale/vale_styles/write-good/So.yml
  100. 6
      CI/vale/vale_styles/write-good/ThereIs.yml
  101. Some files were not shown because too many files have changed in this diff Show More

@ -11,6 +11,29 @@ executors:
docker:
- image: circleci/buildpack-deps:buster-scm
commands:
install_node:
description: "Install Node dependencies"
steps:
- restore_cache:
keys:
- deps-{{ checksum "package-lock.json" }}
- run:
name: update-npm
command: 'sudo npm install -g npm@latest'
- run:
name: Install dependencies
command: |
npm ci
save_node_cache:
description: "Save Node dependencies"
steps:
- save_cache:
paths:
- ./node_modules
key: deps-{{ checksum "package-lock.json" }}
jobs:
dco:
executor: shell_executor
@ -65,11 +88,11 @@ jobs:
- run:
name: Install dependencies
command: |
curl -sfL https://install.goreleaser.com/github.com/ValeLint/vale.sh | sh -s v1.7.1
curl -sfL https://install.goreleaser.com/github.com/ValeLint/vale.sh | sh -s v2.6.6
- run:
name: Run Vale
command: |
./bin/vale --config ./CI/vale_styles/.vale.ini --glob='*.{md}' . | tee ./vale.out
./bin/vale --config ./CI/vale/.vale.ini --glob='*.{md}' . | tee ./vale.out
- store_artifacts:
path: ./vale.out
destination: ./vale.out
@ -78,24 +101,12 @@ jobs:
executor: node_executor
steps:
- checkout
- run:
name: update-npm
command: 'sudo npm install -g npm@latest'
- restore_cache:
keys:
- deps-{{ checksum "package-lock.json" }}
- run:
name: Install dependencies
command: |
npm ci
- install_node
- run:
name: Run markdown link checker
command: |
npm run test:links
- save_cache:
paths:
- ./node_modules
key: deps-{{ checksum "package-lock.json" }}
- save_node_cache
- store_artifacts:
path: ./linkchecker.out
destination: linkchecker.out
@ -104,13 +115,7 @@ jobs:
executor: node_executor
steps:
- checkout
- restore_cache:
keys:
- deps-{{ checksum "package-lock.json" }}
- run:
name: Install dependencies
command: |
npm ci
- install_node
- run:
shell: /bin/bash #this is a non breaking command so it will always return success
name: Run Markdownlint info checks
@ -120,10 +125,7 @@ jobs:
name: Run Markdownlint
command: |
npm run test:markdown
- save_cache:
paths:
- ./node_modules
key: deps-{{ checksum "package-lock.json" }}
- save_node_cache
- store_artifacts:
path: ./markdownlint.out
destination: ./markdownlint.out

@ -37,7 +37,7 @@ see #{your issue number} -->
- [ ] Python dependencies
- [ ] Node dependencies and JavaScript
- [ ] ReadTheDocs configuration
- [ ] Github integration
- [ ] GitHub integration
## Testing

@ -0,0 +1,2 @@
# these files are copied from the Vale style repositories
CI/vale/vale_styles/*/*.md

@ -10,12 +10,12 @@ work to the GitHub repositories.
## Running the scripts
Go to the besu-doc project root directory and run one of the following scripts:
Go to the `besu-doc` project root directory and run one of the following scripts:
* `CI/scripts/test_build.sh` runs the doc build with MkDocs.
* `CI/scripts/test_guidelines.sh` tests the doc with Vale and our custom rules.
* `CI/scripts/test_links.sh` tests the internal and external links in the doc. If a link is
incorrect or the targeted web page is unavailable (for external sites), the test will fail and
incorrect or the targeted Web page is unavailable (for external sites), the test will fail and
display the faulty link.
* `CI/scripts/test_markdown_syntax.sh` tests the Markdown syntax for issues. Sometimes they are not visible
but making sure the markdown is correct helps to make it readable and bug free.

@ -1,12 +1,16 @@
# Example Vale config file (`.vale.ini` or `_vale.ini`)
# Vale configuration
# Core settings
# Styles directory
# See vale_styles/README.md file for details and licencing information
StylesPath = vale_styles
# Here's were we define the exceptions to use in *all*
# `BasedOnStyles`.
Vocab = Besu
# The minimum alert level to display (suggestion, warning, or error).
#
# CI builds will only fail on error-level alerts.
MinAlertLevel = warning
MinAlertLevel = error
# The "formats" section allows you to associate an "unknown" format
# with one of Vale's supported formats.
@ -16,15 +20,12 @@ mdx = md
# Global settings (applied to every syntax)
[*]
# List of styles to load
BasedOnStyles = proselint, write-good, Joblint, Microsoft, Besu
BasedOnStyles = Vale, proselint, write-good, Microsoft, Besu
# Style.Rule = {YES, NO} to enable or disable a specific rule
vale.Editorializing = YES
vale.Redundancy = YES
vale.Repetition = YES
vale.GenderBias = YES
Microsoft.Contractions = NO
Microsoft.GeneralURL = NO
# Microsoft.Acronyms is replaced by Besu list
Microsoft.Acronyms = NO
Microsoft.Quotes = suggestion
Microsoft.We = suggestion
@ -35,6 +36,10 @@ write-good.Weasel = NO
proselint.Hyperbole = warning
[common/CLA.md]
# Disable guidelines check for this file as it's legal jargon
[CODE_OF_CONDUCT.md]
BasedOnStyles =
[CI/vale/vale_styles/*.md]
# Disable guidelines check for this dir as it contains imported styles
BasedOnStyles =

@ -8,6 +8,7 @@ second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)'
# ... with the exception of these:
exceptions:
- API
- AWS
- CLA
- CLI
- CPU
@ -25,12 +26,16 @@ exceptions:
- IBFT
- IBFT2
- IDE
- IPC
- JAR
- JDK
- JRE
- JSON
- JVM
- P2P
- PATH
- PIP
- PBFT
- POA
- POS
- POST
@ -49,6 +54,8 @@ exceptions:
- TOML
- URI
- URL
- VM
- WAR
- WEI
- XML
- YAML

@ -0,0 +1,45 @@
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:
- Besu
- EthSigner
- GoQuorum
- Quorum
- Orion
- Hyperledger
- PegaSys
- Consensys
- Ethereum
- ETH
- TOML
- YAML
- YML
- JSON
- RPC
- Hashicorp
- Vault
- Azure
- CLI
- Code
- Cosmos
- Docker
- Emmet
- I
- Kubernetes
- Linux
- macOS
- Marketplace
- MongoDB
- REPL
- Studio
- TypeScript
- URLs
- Visual
- VS
- Windows

@ -0,0 +1,8 @@
extends: substitution
message: "Prefer English '%s' over Latin '%s' term."
level: error
ignorecase: true
action:
name: replace
swap:
de facto: default

@ -1,6 +1,6 @@
extends: existence
message: "Don’t use language ('%s') that defines people by their disability."
link: 'https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/bits-bytes-terms'
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:

@ -1,6 +1,6 @@
extends: conditional
message: "'%s' has no definition."
link: 'https://docs.microsoft.com/en-us/style-guide/acronyms'
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'.

@ -3,6 +3,8 @@ 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

@ -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+'

@ -1,17 +1,18 @@
extends: existence
message: Don't use '%s'.
message: "Don't use '%s'."
link: https://docs.microsoft.com/en-us/style-guide
ignorecase: true
level: error
tokens:
- abortion
- and so on
- and/or
- app developer
- app(?:lication)? file
- application developer
- application program
- applications developer
- app(?:lication)? file
- as well as
- ask
- backbone
- abortion
- backend

@ -0,0 +1,12 @@
extends: substitution
message: "Use '%s' instead of '%s'."
level: warning
link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/b/back-end
# Use 'back end' (noun) or 'back-end' (adj).
pos: 'back-end/NN|backend/(?:JJ|NN)|back/\w+ end/JJ|back/(?:JJ|RB) end/\w+'
ignorecase: true
action:
name: replace
swap:
back-end: back end
back end: back-end

@ -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

@ -1,8 +1,10 @@
extends: substitution
message: 'Use "%s" instead of "%s".'
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

@ -4,5 +4,10 @@ link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/em
ignorecase: true
nonword: true
level: error
action:
name: edit
params:
- remove
- ' '
tokens:
- '\s[—–]\s'

@ -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

@ -1,5 +1,5 @@
extends: existence
message: Always spell out the name of the month.
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

@ -1,7 +1,9 @@
extends: existence
message: "In general, dont use an ellipsis."
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:
- '\.\.\.'

@ -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

@ -1,9 +1,11 @@
extends: substitution
message: 'Use "%s" instead of "%s".'
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

@ -1,5 +1,5 @@
extends: existence
message: Don’t use '%s'.
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

@ -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)

@ -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

@ -1,5 +1,5 @@
extends: existence
message: Avoid using acronyms in a title or heading.
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

@ -1,5 +1,5 @@
extends: existence
message: Capitalize '%s'."
message: "Capitalize '%s'."
link: https://docs.microsoft.com/en-us/style-guide/punctuation/colons
nonword: true
level: error

@ -1,8 +1,13 @@
extends: existence
message: "Dont use end punctuation in headings."
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-z0-9][.?!](?:\s|$)'

@ -1,6 +1,6 @@
extends: capitalization
message: "'%s' should use sentence-style capitalization."
link: 'https://docs.microsoft.com/en-us/style-guide/capitalization'
link: https://docs.microsoft.com/en-us/style-guide/capitalization
level: suggestion
scope: heading
match: $sentence

@ -4,5 +4,11 @@ link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/hy
level: warning
ignorecase: false
nonword: true
action:
name: edit
params:
- replace
- '-'
- ' '
tokens:
- '\s[^\s-]+ly-'

@ -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'

@ -1,7 +1,12 @@
extends: existence
message: Don’t add -ly to an ordinal number.
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

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

@ -1,5 +1,5 @@
extends: existence
message: Use a numeral plus the units.
message: "Use a numeral plus the units."
link: https://docs.microsoft.com/en-us/style-guide/numbers
nonword: true
level: error

@ -1,7 +1,13 @@
extends: existence
message: Use an en dash in a range of numbers.
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'

@ -1,7 +1,13 @@
extends: existence
message: Use 'to' instead of a dash in '%s'.
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'

@ -1,5 +1,5 @@
message: Try to keep sentences short (< 30 words).
extends: occurrence
message: "Try to keep sentences short (< 30 words)."
scope: sentence
level: suggestion
max: 30

@ -2,6 +2,8 @@ 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

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

@ -1,7 +1,11 @@
extends: existence
message: Try to avoid using first-person plural like '%s'.
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

@ -1,15 +1,16 @@
extends: substitution
message: 'Consider using "%s" instead of "%s".'
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
adequate number: enough
adversely impact: hurt
all across: across
all of a sudden: suddenly
@ -19,6 +20,7 @@ swap:
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
@ -37,7 +39,7 @@ swap:
basic necessity: necessity
because of the fact that: because
came to a realization: realized
came to an abrupt end: end[ed] abruptly
came to an abrupt end: ended abruptly
carry out an evaluation of: evaluate
close down: close
closed down: closed
@ -50,6 +52,8 @@ swap:
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
@ -62,7 +66,7 @@ swap:
fell down: fell
for the duration of: during
gather together: gather
has the ability: can
has the ability to: can
has the capacity to: can
has the opportunity to: could
hold a meeting: meet
@ -114,7 +118,5 @@ swap:
until such time as: until
used for fuel purposes: used for fuel
whether or not: whether
with reference to: about
with regard to: regarding
with respect to: about or on
with the exception of: except for

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

@ -0,0 +1,13 @@
# Vale Styles
Styles in this directory are all from external sources except the Besu one.
Each external style folder are licensed under the terms specified in the directory LICENCE or README.md file.
## Versions
External style are imported form the following releases:
- Write-Good style: <https://github.com/errata-ai/write-good/releases/tag/v0.4.0>
- Proseling style: <https://github.com/errata-ai/proselint/releases/tag/v0.3.1>
- Microsoft style: <https://github.com/errata-ai/Microsoft/releases/tag/v0.7.1>

@ -0,0 +1,147 @@
[aA]busable
Alethio
[aA]llowlist(s)?
Ansible
[aA]utogenerated
[aA]ttester(s)?
Azure
[bB]ackend
[bB]ackoff
BerkeleyDB
Besu
Bintray
[bB]lockchain(s)?
[bB]oolean(s)?
[bB]ootnode(s)?
[bB]roadcast(ing|ed)
Cakeshop
[cC]lasspath(s)?
Codefi
[cC]oinbase
[cC]onfigurability
ConsenSys
[cC]ounterpart(y|ies)
[cC]rafter
[cC]ryptocurrenc(y|ies)
ctrl
Dapp(s)?
Dev
[dD]atatype(s)?
[dD]eauthoriz(e|ing)
[eE]ncryptor(s)?
[eE]node(s)?
etcd
Ethash
Ethereum
Etherscan
Ethminer
EthSigner
Filebeat
Filecoin
Filestore(s)?
[fF]rontend
[gG]eth
GitHub
Gitter
Goerli
GoQuorum
[gG]olang
Gradle
Grafana
gRPC
[gG]?[wW]ei
HashiCorp
[hH]ashrate(s)?
Helmfile(s)?
Homebrew
[hH]ostname(s)?
Hyperledger
InfluxDB
Infura
Jasypt
Javadoc
JMeter
jnacl
Kafka
kalium
[kK]eystore(s)?
[kK]eytool(s)?
Kibana
Kotti
kubectl
libsodium
[lL]iveness
Logback
Logstash
Logrus
[mM]ainnet(s)?
(([uU]nm)|[mM])arshal(ling)?
Medalla
Merkle
MetaMask
Metricbeat
MkDocs
[mM]ultiaddresse(s)?
[mM]ultikey(s)?
[nN]amespace(s)?
Nginx
Nodejs
[nN]once(s)?
[oO]nboard(ing)?
[oO]nchain
Orion
[pP]arallelization
PegaSys
[pP]ermission(ing|ed)?
[pP]luggable
P[oO]A
Postgres
P[oO]W
[pP]recompile(d)?
[pP]reidentif(y|ied)
Prometheus
Protobuf
Prysmatic
Pushgateway
Pyrmont
[qQ]uorum
Raft
ReadTheDocs
Redis
[rR]edistributable(s)?
[rR]eentrancy
[rR]epurposing
Retesteth
Rinkeby
Ropsten
Mordor
[sS]andbox(ed|ing)
Slack
[sS]lashable
Splunk
[sS]ubcommand(s)?
[sS]ubnet(s)?
[sS]uborganization(s)?
Teku
Telegraf
[tT]estnet(s)?
tmux
[tT]oolset(s)?
[tT]rie(s)?
[tT]ruststore(s)?
[uU]pcheck
underflow(s)?
[uU]nencode(d)?
[uU]nencrypt(ed)?
[uU]ncache(d)?
[uU]ntrust(ed)?
[uU]pstream(s)?
[vV]alidator(s)?
[vV]eto(s|es)?
Web
Web3Signer
[wW]ebservice(s)?
Websocket(s)?
withdrawable
wscat
Zinken

@ -0,0 +1,8 @@
extends: existence
message: "'%s' is airlinese."
ignorecase: true
level: error
tokens:
- enplan(?:e|ed|ing|ement)
- deplan(?:e|ed|ing|ement)
- taking off momentarily

@ -0,0 +1,48 @@
extends: substitution
message: "Consider using '%s' instead of '%s'."
level: error
action:
name: replace
swap:
(?:bull|ox)-like: taurine
(?:calf|veal)-like: vituline
(?:crow|raven)-like: corvine
(?:leopard|panther)-like: pardine
bird-like: avine
centipede-like: scolopendrine
crab-like: cancrine
crocodile-like: crocodiline
deer-like: damine
eagle-like: aquiline
earthworm-like: lumbricine
falcon-like: falconine
ferine: wild animal-like
fish-like: piscine
fox-like: vulpine
frog-like: ranine
goat-like: hircine
goose-like: anserine
gull-like: laridine
hare-like: leporine
hawk-like: accipitrine
hippopotamus-like: hippopotamine
lizard-like: lacertine
mongoose-like: viverrine
mouse-like: murine
ostrich-like: struthionine
peacock-like: pavonine
porcupine-like: hystricine
rattlesnake-like: crotaline
sable-like: zibeline
sheep-like: ovine
shrew-like: soricine
sparrow-like: passerine
swallow-like: hirundine
swine-like: suilline
tiger-like: tigrine
viper-like: viperine
vulture-like: vulturine
wasp-like: vespine
wolf-like: lupine
woodpecker-like: picine
zebra-like: zebrine

@ -0,0 +1,9 @@
extends: existence
message: "'%s' left in text."
ignorecase: false
level: error
tokens:
- XXX
- FIXME
- TODO
- NOTE

@ -0,0 +1,8 @@
extends: existence
message: "Excessive apologizing: '%s'"
ignorecase: true
level: error
action:
name: remove
tokens:
- More research is needed

@ -0,0 +1,52 @@
extends: existence
message: "'%s' is archaic."
ignorecase: true
level: error
tokens:
- alack
- anent
- begat
- belike
- betimes
- boughten
- brocage
- brokage
- camarade
- chiefer
- chiefest
- Christiana
- completely obsolescent
- cozen
- divers
- deflexion
- fain
- forsooth
- foreclose from
- haply
- howbeit
- illumine
- in sooth
- maugre
- meseems
- methinks
- nigh
- peradventure
- perchance
- saith
- shew
- sistren
- spake
- to wit
- verily
- whilom
- withal
- wot
- enclosed please find
- please find enclosed
- enclosed herewith
- enclosed herein
- inforce
- ex postfacto
- foreclose from
- forewent
- for ever

@ -0,0 +1,8 @@
extends: existence
message: "Do not start a paragraph with a 'but'."
level: error
scope: paragraph
action:
name: remove
tokens:
- ^But

@ -0,0 +1,782 @@
extends: existence
message: "'%s' is a cliche."
level: error
ignorecase: true
tokens:
- a chip off the old block
- a clean slate
- a dark and stormy night
- a far cry
- a fate worse than death
- 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
- alas and alack
- all fun and games
- all hell broke loose
- 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
- at the end of the day
- 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
- bald-faced lie
- 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
- between a rock and a hard place
- between Scylla and Charybdis
- between the devil and the deep blue see
- betwixt and between
- 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
- blissful ignorance
- blood is thicker than water
- blood sweat and tears
- blow a fuse
- 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
- bulk large
- 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
- but that's another story
- 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
- cast aspersions
- cat got your tongue
- cat's meow
- caught in the crossfire
- caught red-handed
- chase a red herring
- 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
- comparing apples and oranges
- compleat
- conspicuous by its absence
- 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
- 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
- cutting edge
- dark before the dawn
- day in, day out
- dead as a doornail
- decision-making process
- 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
- dubious distinction
- dull as dishwater
- duly authorized
- 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
- eyes peeled
- face the music
- facts of life
- fair weather friend
- fall by the wayside
- fan the flames
- far be it from me
- fast and loose
- feast or famine
- feather your nest
- feathered friends
- few and far between
- fifteen minutes of fame
- fills the bill
- filthy vermin
- fine kettle of fish
- first and foremost
- 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 free
- 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 with the program
- get your feet wet
- gets my goat
- gilding the lily
- 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 a short fuse
- have high hopes
- have the last laugh
- haven't got a row to hoe
- he's got his hands full
- 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
- his own worst enemy
- his work cut out for him
- hit paydirt
- hither and yon
- Hobson's choice
- hold your head up high
- hold your horses
- hold your own
- hold your tongue
- honest as the day is long
- horns of a dilemma
- 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
- if you catch my drift
- in a jam
- in a jiffy
- in a nutshell
- in a pig's eye
- in a pinch
- in a word
- in hot water
- in light of
- in the final analysis
- in the gutter
- in the last analysis
- in the nick of time
- in the thick of it
- in your dreams
- innocent bystander
- 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 not what you know, it's who you know
- 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 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 a mockery of
- 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
- male chauvinism
- 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
- moment of truth
- money to burn
- more in sorrow than in anger
- more power to you
- more sinned against than sinning
- more than one way to skin a cat
- movers and shakers
- moving experience
- my better half
- 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 in the bud
- 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
- olden days
- 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 same page
- 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
- presidential timber
- pretty as a picture
- pull a fast one
- pull your punches
- pulled no 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
- quantum jump
- quantum leap
- 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
- redound to one's credit
- redound to the benefit of
- 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
- sea change
- 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
- shirked his duties
- 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
- six of one, half a dozen of the other
- 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
- stretched to the breaking point
- 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
- than you can shake a stick at
- the cream of the crop
- the cream rises to the top
- the more the merrier
- the real deal
- the real McCoy
- the red carpet treatment
- the same old story
- the straw that broke the camel's back
- there is no accounting for taste
- thick as a brick
- thick as thieves
- thick as thieves
- thin as a rail
- think outside of the box
- thinking outside the box
- third time's the charm
- this day and age
- this hurts me worse than it hurts you
- this point in time
- thought leaders?
- three sheets to the wind
- through thick and thin
- throw in the towel
- throw the baby out with the bathwater
- 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
- various and sundry
- vested interest
- viable alternative
- 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
- wax eloquent
- wax poetic
- we've got a situation here
- 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
- whet (?:the|your) appetite
- 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
- wool pulled over our eyes
- words fail me
- work like a dog
- world weary
- worst nightmare
- worth its weight in gold
- writ large
- 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

@ -0,0 +1,30 @@
extends: existence
message: "'%s' is corporate speak."
ignorecase: true
level: error
tokens:
- at the end of the day
- back to the drawing board
- hit the ground running
- get the ball rolling
- low-hanging fruit
- thrown under the bus
- think outside the box
- let's touch base
- get my manager's blessing
- it's on my radar
- ping me
- i don't have the bandwidth
- no brainer
- par for the course
- bang for your buck
- synergy
- move the goal post
- apples to apples
- win-win
- circle back around
- all hands on deck
- take this offline
- drill-down
- elephant in the room
- on my plate

@ -0,0 +1,5 @@
extends: existence
message: "Incorrect use of symbols in '%s'."
ignorecase: true
raw:
- \$[\d]* ?(?:dollars|usd|us dollars)

@ -0,0 +1,15 @@
extends: existence
message: "Consider replacing '%s'."
level: error
ignorecase: true
tokens:
- shit
- piss
- fuck
- cunt
- cocksucker
- motherfucker
- tits
- fart
- turd
- twat

@ -0,0 +1,7 @@
extends: existence
message: With lowercase letters, the periods are standard.
ignorecase: true
level: error
nonword: true
tokens:
- '\d{1,2} ?[ap]m'

@ -0,0 +1,7 @@
extends: existence
message: "Use 'midnight' or 'noon'."
ignorecase: true
level: error
nonword: true
tokens:
- '12 ?[ap]\.?m\.?'

@ -0,0 +1,10 @@
extends: existence
message: "'a.m.' is always morning; 'p.m.' is always night."
ignorecase: true
level: error
nonword: true
tokens:
- '\d{1,2} ?a\.?m\.? in the morning'
- '\d{1,2} ?p\.?m\.? in the evening'
- '\d{1,2} ?p\.?m\.? at night'
- '\d{1,2} ?p\.?m\.? in the afternoon'

@ -0,0 +1,7 @@
extends: existence
message: "It's standard to put a space before '%s'"
ignorecase: true
level: error
nonword: true
tokens:
- '\d{1,2}[ap]\.?m\.?'

@ -0,0 +1,52 @@
extends: substitution
message: Did you mean '%s'?
ignorecase: false
action:
name: replace
swap:
(?:Afrikaaner|Afrikander): Afrikaner
(?:Hong Kongite|Hong Kongian): Hong Konger
(?:Indianan|Indianian): Hoosier
(?:Michiganite|Michiganian): Michigander
(?:New Hampshireite|New Hampshireman): New Hampshirite
(?:Newcastlite|Newcastleite): Novocastrian
(?:Providencian|Providencer): Providentian
(?:Trentian|Trentonian): Tridentine
(?:Warsawer|Warsawian): Varsovian
(?:Wolverhamptonite|Wolverhamptonian): Wulfrunian
Alabaman: Alabamian
Albuquerquian: Albuquerquean
Anchoragite: Anchorageite
Arizonian: Arizonan
Arkansawyer: Arkansan
Belarusan: Belarusian
Cayman Islander: Caymanian
Coloradoan: Coloradan
Connecticuter: Nutmegger
Fairbanksian: Fairbanksan
Fort Worther: Fort Worthian
Grenadian: Grenadan
Halifaxer: Haligonian
Hartlepoolian: Hartlepudlian
Illinoisian: Illinoisan
Iowegian: Iowan
Leedsian: Leodenisian
Liverpoolian: Liverpudlian
Los Angelean: Angeleno
Manchesterian: Mancunian
Minneapolisian: Minneapolitan
Missouran: Missourian
Monacan: Monegasque
Neopolitan: Neapolitan
New Jerseyite: New Jerseyan
New Orleansian: New Orleanian
Oklahoma Citian: Oklahoma Cityan
Oklahomian: Oklahoman
Saudi Arabian: Saudi
Seattlite: Seattleite
Surinamer: Surinamese
Tallahassean: Tallahasseean
Tennesseean: Tennessean
Trois-Rivièrester: Trifluvian
Utahan: Utahn
Valladolidian: Vallisoletano

@ -0,0 +1,96 @@
extends: substitution
message: Consider using '%s' instead of '%s'.
ignorecase: true
level: error
action:
name: replace
swap:
beau ideal: beau idéal
boutonniere: boutonnière
bric-a-brac: bric-à-brac
cafe: café
cause celebre: cause célèbre
chevre: chèvre
cliche: cliché
consomme: consommé
coup de grace: coup de grâce
crudites: crudités
creme brulee: crème brûlée
creme de menthe: crème de menthe
creme fraice: crème fraîche
creme fresh: crème fraîche
crepe: crêpe
debutante: débutante
decor: décor
deja vu: déjà vu
denouement: dénouement
facade: façade
fiance: fiancé
fiancee: fiancée
flambe: flambé
garcon: garçon
lycee: lycée
maitre d: maître d
menage a trois: ménage à trois
negligee: négligée
protege: protégé
protegee: protégée
puree: purée
my resume: my résumé
your resume: your résumé
his resume: his résumé
her resume: her résumé
a resume: a résumé
the resume: the résumé
risque: risqué
roue: roué
soiree: soirée
souffle: soufflé
soupcon: soupçon
touche: touché
tete-a-tete: tête-à-tête
voila: voilà
a la carte: à la carte
a la mode: à la mode
emigre: émigré
# Spanish loanwords
El Nino: El Niño
jalapeno: jalapeño
La Nina: La Niña
pina colada: piña colada
senor: señor
senora: señora
senorita: señorita
# Portuguese loanwords
acai: açaí
# German loanwords
doppelganger: doppelgänger
Fuhrer: Führer
Gewurztraminer: Gewürztraminer
vis-a-vis: vis-à-vis
Ubermensch: Übermensch
# Swedish loanwords
filmjolk: filmjölk
smorgasbord: smörgåsbord
# Names, places, and companies
Beyonce: Beyoncé
Bronte: Brontë
Bronte: Brontë
Champs-Elysees: Champs-Élysées
Citroen: Citroën
Curacao: Curaçao
Lowenbrau: Löwenbräu
Monegasque: Monégasque
Motley Crue: Mötley Crüe
Nescafe: Nescafé
Queensryche: Queensrÿche
Quebec: Québec
Quebecois: Québécois
Angstrom: Ångström
angstrom: ångström
Skoda: Škoda

@ -2,9 +2,11 @@ extends: substitution
message: Consider using '%s' instead of '%s'.
ignorecase: true
level: error
action:
name: replace
swap:
(?:alumna|alumnus): graduate
(?:alumnae|alumni): graduates
(?:alumna|alumnus): graduate
air(?:m[ae]n|wom[ae]n): pilot(s)
anchor(?:m[ae]n|wom[ae]n): anchor(s)
authoress: author
@ -25,7 +27,6 @@ swap:
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)

@ -0,0 +1,39 @@
extends: substitution
message: Consider using '%s' instead of '%s'.
ignorecase: true
action:
name: replace
swap:
(?:bunch|group|pack|flock) of chickens: brood of chickens
(?:bunch|group|pack|flock) of crows: murder of crows
(?:bunch|group|pack|flock) of hawks: cast of hawks
(?:bunch|group|pack|flock) of parrots: pandemonium of parrots
(?:bunch|group|pack|flock) of peacocks: muster of peacocks
(?:bunch|group|pack|flock) of penguins: muster of penguins
(?:bunch|group|pack|flock) of sparrows: host of sparrows
(?:bunch|group|pack|flock) of turkeys: rafter of turkeys
(?:bunch|group|pack|flock) of woodpeckers: descent of woodpeckers
(?:bunch|group|pack|herd) of apes: shrewdness of apes
(?:bunch|group|pack|herd) of baboons: troop of baboons
(?:bunch|group|pack|herd) of badgers: cete of badgers
(?:bunch|group|pack|herd) of bears: sloth of bears
(?:bunch|group|pack|herd) of bullfinches: bellowing of bullfinches
(?:bunch|group|pack|herd) of bullocks: drove of bullocks
(?:bunch|group|pack|herd) of caterpillars: army of caterpillars
(?:bunch|group|pack|herd) of cats: clowder of cats
(?:bunch|group|pack|herd) of colts: rag of colts
(?:bunch|group|pack|herd) of crocodiles: bask of crocodiles
(?:bunch|group|pack|herd) of dolphins: school of dolphins
(?:bunch|group|pack|herd) of foxes: skulk of foxes
(?:bunch|group|pack|herd) of gorillas: band of gorillas
(?:bunch|group|pack|herd) of hippopotami: bloat of hippopotami
(?:bunch|group|pack|herd) of horses: drove of horses
(?:bunch|group|pack|herd) of jellyfish: fluther of jellyfish
(?:bunch|group|pack|herd) of kangeroos: mob of kangeroos
(?:bunch|group|pack|herd) of monkeys: troop of monkeys
(?:bunch|group|pack|herd) of oxen: yoke of oxen
(?:bunch|group|pack|herd) of rhinoceros: crash of rhinoceros
(?:bunch|group|pack|herd) of wild boar: sounder of wild boar
(?:bunch|group|pack|herd) of wild pigs: drift of wild pigs
(?:bunch|group|pack|herd) of zebras: zeal of wild pigs
(?:bunch|group|pack|school) of trout: hover of trout

@ -0,0 +1,8 @@
extends: existence
message: "'%s' is hedging."
ignorecase: true
level: error
tokens:
- I would argue that
- ', so to speak'
- to a certain degree

@ -0,0 +1,6 @@
extends: existence
message: "'%s' is hyperbolic."
level: error
nonword: true
tokens:
- '[a-z]+[!?]{2,}'

@ -0,0 +1,11 @@
extends: existence
message: "'%s' is jargon."
ignorecase: true
level: error
tokens:
- in the affirmative
- in the negative
- agendize
- per your order
- per your request
- disincentivize

@ -0,0 +1,13 @@
extends: existence
message: "'%s' is offensive. Remove it or consider the context."
ignorecase: true
tokens:
- fag
- faggot
- dyke
- sodomite
- homosexual agenda
- gay agenda
- transvestite
- homosexual lifestyle
- gay lifestyle

@ -0,0 +1,15 @@
extends: substitution
message: "Consider using '%s' instead of '%s'."
ignorecase: true
action:
name: replace
swap:
homosexual man: gay man
homosexual men: gay men
homosexual woman: lesbian
homosexual women: lesbians
homosexual people: gay people
homosexual couple: gay couple
sexual preference: sexual orientation
(?:admitted homosexual|avowed homosexual): openly gay
special rights: equal rights

@ -0,0 +1,8 @@
extends: existence
message: "'%s' is a malapropism."
ignorecase: true
level: error
tokens:
- the infinitesimal universe
- a serial experience
- attack my voracity

@ -0,0 +1,361 @@
extends: substitution
message: Prefer '%s' over '%s'
ignorecase: true
action:
name: replace
swap:
'(?:cell phone|cell-phone)': cellphone
'(?:cliquey|cliquy)': cliquish
'(?:pygmean|pygmaen)': pygmy
'(?:retributional|retributionary)': retributive
'(?:revokable|revokeable)': revocable
abolishment: abolition
accessary: accessory
accreditate: accredit
accruement: accrual
accusee: accused
acquaintanceship: acquaintance
acquitment: acquittal
administrate: administer
administrated: administered
administrating: administering
adulterate: adulterous
advisatory: advisory
advocator: advocate
aggrievance: grievance
allegator: alleger
allusory: allusive
amative: amorous
amortizement: amortization
amphiboly: amphibology
anecdotalist: anecdotist
anilinctus: anilingus
anticipative: anticipatory
antithetic: antithetical
applicative: applicable
applicatory: applicable
applier: applicator
approbative: approbatory
arbitrager: arbitrageur
arsenous: arsenious
ascendance: ascendancy
ascendence: ascendancy
ascendency: ascendancy
auctorial: authorial
averral: averment
barbwire: barbed wire
benefic: beneficent
benignant: benign
bestowment: bestowal
betrothment: betrothal
blamableness: blameworthiness
butt naked: buck naked
camarade: comrade
carta blanca: carte blanche
casualities: casualties
casuality: casualty
catch on fire: catch fire
catholicly: catholically
cease fire: ceasefire
channelize: channel
chaplainship: chaplaincy
chrysalid: chrysalis
chrysalids: chrysalises
cigaret: cigarette
coemployee: coworker
cognitional: cognitive
cohabitate: cohabit
cohabitor: cohabitant
collodium: collodion
collusory: collusive
commemoratory: commemorative
commonty: commonage
communicatory: communicative
compensative: compensatory
complacence: complacency
complicitous: complicit
computate: compute
conciliative: conciliatory
concomitancy: concomitance
condonance: condonation
confirmative: confirmatory
congruency: congruence
connotate: connote
consanguineal: consanguine
conspicuity: conspicuousness
conspiratorialist: conspirator
constitutionist: constitutionalist
contingence: contigency
contributary: contributory
contumacity: contumacy
conversible: convertible
conveyal: conveyance
copartner: partner
copartnership: partnership
corroboratory: corroborative
cotemporaneous: contemporaneous
cotemporary: contemporary
criminate: incriminate
culpatory: inculpatory
cumbrance: encumbrance
cumulate: accumulate
curatory: curative
daredeviltry: daredevilry
deceptious: deceptive
defamative: defamatory
defraudulent: fraudulent
degeneratory: degenerative
delimitate: delimit
delusory: delusive
denouncement: denunciation
depositee: depositary
depreciative: depreciatory
deprival: deprivation
derogative: derogatory
destroyable: destructible
detoxicate: detoxify
detractory: detractive
deviancy: deviance
deviationist: deviant
digamy: deuterogamy
digitalize: digitize
diminishment: diminution
diplomatist: diplomat
disassociate: dissociate
disciplinatory: disciplinary
discriminant: discriminating
disenthrone: dethrone
disintegratory: disintegrative
dismission: dismissal
disorientate: disorient
disorientated: disoriented
disquieten: disquiet
distraite: distrait
divergency: divergence
dividable: divisible
doctrinary: doctrinaire
documental: documentary
domesticize: domesticate
duplicatory: duplicative
duteous: dutiful
educationalist: educationist
educatory: educative
enigmatas: enigmas
enlargen: enlarge
enswathe: swathe
epical: epic
erotism: eroticism
ethician: ethicist
ex officiis: ex officio
exculpative: exculpatory
exigeant: exigent
exigence: exigency
exotism: exoticism
expedience: expediency
expediential: expedient
expediential: expedient
extensible: extendable
eying: eyeing
fiefdom: fief
flagrance: flagrancy
flatulency: flatulence
fraudful: fraudulent
funebrial: funereal
geographical: geographic
geometrical: geometric
gerry-rigged: jury-rigged
goatherder: goatherd
gustatorial: gustatory
habitude: habit
henceforward: henceforth
hesitance: hesitancy
heterogenous: heterogeneous
hierarchic: hierarchical
hindermost: hindmost
honorand: honoree
hypostasize: hypostatize
hysteric: hysterical
idolatrize: idolize
impanel: empanel
imperviable: impervious
importunacy: importunity
impotency: impotence
imprimatura: imprimatur
improprietous: improper
inalterable: unalterable
incitation: incitement
incommunicative: uncommunicative
inconsistence: inconsistency
incontrollable: uncontrollable
incurment: incurrence
indow: endow
indue: endue
inhibitive: inhibitory
innavigable: unnavigable
innovational: innovative
inquisitional: inquisitorial
insistment: insistence
insolvable: unsolvable
instillment: instillation
instinctual: instinctive
insuror: insurer
insurrectional: insurrectionary
interpretate: interpret
intervenience: intervention
ironical: ironic
jerry-rigged: jury-rigged
judgmatic: judgmental
labyrinthian: labyrinthine
laudative: laudatory
legitimatization: legitimation
legitimatize: legitimize
legitimization: legitimation
lengthways: lengthwise
life-sized: life-size
liquorice: licorice
lithesome: lithe
lollipop: lollypop
loth: loath
lubricous: lubricious
maihem: mayhem
medicinal marijuana: medical marijuana
meliorate: ameliorate
minimalize: minimize
mirk: murk
mirky: murky
misdoubt: doubt
monetarize: monetize
moveable: movable
narcism: narcissism
neglective: neglectful
negligency: negligence
neologizer: neologist
neurologic: neurological
nicknack: knickknack
nictate: nictitate
nonenforceable: unenforceable
normalcy: normality
numbedness: numbness
omittable: omissible
onomatopoetic: onomatopoeic
opinioned: opined
optimum advantage: optimal advantage
orientate: orient
outsized: outsize
oversized: oversize
overthrowal: overthrow
pacificist: pacifist
paederast: pederast
parachronism: anachronism
parti-color: parti-colored
participative: participatory
party-colored: parti-colored
pediatrist: pediatrician
penumbrous: penumbral
perjorative: pejorative
permissory: permissive
permutate: permute
personation: impersonation
pharmaceutic: pharmaceutical
pleuritis: pleurisy
policy holder: policyholder
policyowner: policyholder
politicalize: politicize
precedency: precedence
preceptoral: preceptorial
precipitance: precipitancy
precipitant: precipitate
preclusory: preclusive
precolumbian: pre-Columbian
prefectoral: prefectorial
preponderately: preponderantly
preserval: preservation
preventative: preventive
proconsulship: proconsulate
procreational: procreative
procurance: procurement
propelment: propulsion
propulsory: propulsive
prosecutive: prosecutory
protectory: protective
provocatory: provocative
pruriency: prurience
psychal: psychical
punitory: punitive
quantitate: quantify
questionary: questionnaire
quiescency: quiescence
rabbin: rabbi
reasonability: reasonableness
recidivistic: recidivous
recriminative: recriminatory
recruital: recruitment
recurrency: recurrence
recusance: recusancy
recusation: recusal
recusement: recusal
redemptory: redemptive
referrable: referable
referrible: referable
refutatory: refutative
remitment: remittance
remittal: remission
renouncement: renunciation
renunciable: renounceable
reparatory: reparative
repudiative: repudiatory
requitement: requital
rescindment: rescission
restoral: restoration
reticency: reticence
reviewal: review
revisal: revision
revisional: revisionary
revolute: revolt
saliency: salience
salutiferous: salutary
sensatory: sensory
sessionary: sessional
shareowner: shareholder
sicklily: sickly
signator: signatory
slanderize: slander
societary: societal
sodomist: sodomite
solicitate: solicit
speculatory: speculative
spiritous: spirituous
statutorial: statutory
submergeable: submersible
submittal: submission
subtile: subtle
succuba: succubus
sufficience: sufficiency
suppliant: supplicant
surmisal: surmise
suspendible: suspendable
synthetize: synthesize
systemize: systematize
tactual: tactile
tangental: tangential
tautologous: tautological
tee-shirt: T-shirt
thenceforward: thenceforth
transiency: transience
transposal: transposition
transposal: transposition
unfrequent: infrequent
unreasonability: unreasonableness
unrevokable: irrevocable
unsubstantial: insubstantial
usurpature: usurpation
variative: variational
vegetive: vegetative
vindicative: vindictive
vituperous: vituperative
vociferant: vociferous
volitive: volitional
wolverene: wolverine
wolvish: wolfish
Zoroastrism: Zoroastrianism

@ -0,0 +1,38 @@
extends: substitution
message: "Consider using '%s' instead of '%s'."
ignorecase: true
level: error
action:
name: replace
swap:
affrontery: effrontery
analyzation: analysis
annoyment: annoyance
confirmant: confirmand
confirmants: confirmands
conversate: converse
crained: cranded
discomforture: discomfort|discomfiture
dispersement: disbursement|dispersal
doubtlessly: doubtless|undoubtedly
forebearance: forbearance
improprietous: improper
inclimate: inclement
inimicable: inimical
irregardless: regardless
minimalize: minimize
minimalized: minimized
minimalizes: minimizes
minimalizing: minimizing
optimalize: optimize
paralyzation: paralysis
pettifogger: pettifog
proprietous: proper
relative inexpense: relatively low price|affordability
seldomly: seldom
thusly: thus
uncategorically: categorically
undoubtably: undoubtedly|indubitably
unequivocable: unequivocal
unmercilessly: mercilessly
unrelentlessly: unrelentingly|relentlessly

@ -0,0 +1,22 @@
extends: existence
message: "'%s' is an oxymoron."
ignorecase: true
level: error
tokens:
- amateur expert
- increasingly less
- advancing backwards
- alludes explicitly to
- explicitly alludes to
- totally obsolescent
- completely obsolescent
- generally always
- usually always
- increasingly less
- build down
- conspicuous absence
- exact estimate
- found missing
- intense apathy
- mandatory choice
- organized mess

@ -0,0 +1,6 @@
extends: existence
message: "You should use more decimal places, unless '%s' is really true."
ignorecase: true
level: suggestion
tokens:
- 'p = 0\.0{2,4}'

@ -0,0 +1,30 @@
extends: existence
message: "'%s' is redundant."
level: error
action:
name: edit
params:
- split
- ' '
- '0'
tokens:
- ABM missile
- ACT test
- ABM missiles
- ABS braking system
- ATM machine
- CD disc
- CPI Index
- GPS system
- GUI interface
- HIV virus
- ISBN number
- LCD display
- PDF format
- PIN number
- RAS syndrome
- RIP in peace
- please RSVP
- SALT talks
- SAT test
- UPC codes

@ -0,0 +1,12 @@
Copyright © 2014–2015, Jordan Suchow, Michael Pacer, and Lara A. Ross
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

@ -0,0 +1,13 @@
extends: existence
message: "'%s' is a bit of a skunked term — impossible to use without issue."
ignorecase: true
level: error
tokens:
- bona fides
- deceptively
- decimate
- effete
- fulsome
- hopefully
- impassionate
- Thankfully

@ -0,0 +1,17 @@
extends: consistency
message: "Inconsistent spelling of '%s'."
level: error
ignorecase: true
either:
advisor: adviser
centre: center
colour: color
emphasise: emphasize
finalise: finalize
focussed: focused
labour: labor
learnt: learned
organise: organize
organised: organized
organising: organizing
recognise: recognize

@ -0,0 +1,11 @@
extends: substitution
message: Consider using the '%s' symbol instead of '%s'.
level: error
nonword: true
swap:
'\.\.\.':
'\([cC]\)': ©
'\(TM\)':
'\(tm\)':
'\([rR]\)': ®
'[0-9]+ ?x ?[0-9]+': ×

@ -0,0 +1,50 @@
extends: existence
message: "'%s' is not comparable"
ignorecase: true
level: error
action:
name: edit
params:
- split
- ' '
- '1'
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

@ -0,0 +1,6 @@
extends: existence
message: "Remove '%s'."
ignorecase: true
level: error
tokens:
- very

@ -0,0 +1,17 @@
{
"author": "jdkato",
"description": "A Vale-compatible implementation of the proselint linter.",
"email": "support@errata.ai",
"lang": "en",
"url": "https://github.com/errata-ai/proselint/releases/latest/download/proselint.zip",
"feed": "https://github.com/errata-ai/proselint/releases.atom",
"issues": "https://github.com/errata-ai/proselint/issues/new",
"license": "BSD-3-Clause",
"name": "proselint",
"sources": [
"https://github.com/amperser/proselint"
],
"vale_version": ">=1.0.0",
"coverage": 0.0,
"version": "0.1.0"
}

@ -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

@ -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

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

@ -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

@ -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.
```

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

@ -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'

Some files were not shown because too many files have changed in this diff Show More

Loading…
Cancel
Save