Skip to content

Commit

Permalink
Tweaking vale checks
Browse files Browse the repository at this point in the history
  • Loading branch information
plaindocs committed Mar 5, 2017
1 parent 03de98b commit 22541ce
Show file tree
Hide file tree
Showing 13 changed files with 254 additions and 3 deletions.
11 changes: 9 additions & 2 deletions .vale
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
StylesPath = style-guide

MinAlertLevel = error

[*.{md,rst,txt}]
BasedOnStyles = WTD
vale.Wordiness = YES
vale.ComplexWords = YES

vale.Redundancy = YES
vale.Repetition = YES
vale.GenderBias = YES

TheEconomist.UnnecessaryWords = YES
TheEconomist.Hectoring = YES
17 changes: 17 additions & 0 deletions style-guide/TheEconomist/Didactic.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
extends: existence
message: "'%s' - Do not be too didactic"
description: "If too many sentences begin with '%s,' readers will think they are reading a textbook."
link: http://www.economist.com/styleguide/introduction
scope: text
level: warning
ignorecase: false
tokens:
- Compare
- Consider
- Expect
- Imagine
- Look at
- Note
- Prepare for
- Remember
- Take
17 changes: 17 additions & 0 deletions style-guide/TheEconomist/Hectoring.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
extends: existence
message: "'%s' - Do not be hectoring or arrogant"
description: "Those who disagree with you are not necessarily '%s.'"
link: http://www.economist.com/styleguide/introduction
scope: text
level: error
ignorecase: true
tokens:
- stupid
- idiotic
- imbecile
- ignorant
- insane
- absurd
- ridiculus
- lunatic
- asinine
26 changes: 26 additions & 0 deletions style-guide/TheEconomist/HorribleWords.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
extends: existence
message: "'%s' - See section 'Horrible words'"
description: "Be aware that the use of '%s' may have an emetic effect on some of your readers."
link: http://www.economist.com/style-guide/horrible-words
level: warning
ignorecase: true
tokens:
- carer
- chattering classes
- facilitate
- famously
- Governance
- grow the business
- guesstimate
- informed
- leverage
- likely
- looking to
- materiel
- poster child
- prestigious
- proactive
- rack up
- savvy
- segue
- stakeholder
10 changes: 10 additions & 0 deletions style-guide/TheEconomist/OughtShould.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
extends: existence
message: Go easy on the oughts and shoulds
description: "The aim is not just to tell readers what you think, but to persuade them."
link: http://www.economist.com/styleguide/introduction
scope: text
level: warning
ignorecase: true
tokens:
- ought
- should
32 changes: 32 additions & 0 deletions style-guide/TheEconomist/OverusedWords.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
extends: existence
message: "'%s' is overused"
description: "Nothing betrays the lazy writer faster than fly-blown phrases used in the belief that they are snappy, trendy or cool."
link: http://www.economist.com/style-guide/overused-words
level: warning
scope: text
ignorecase: true
tokens:
- address
- brits
- care for
- challenge
- commit to
- community
- environment
- famously
- focus
- historic
- homeland
- individual
- inform
- metrosexual
- overseas
- participate in
- process
- relationship
- resources
- skills
- supportive
- target
- transparency
- wannabes
10 changes: 10 additions & 0 deletions style-guide/TheEconomist/Punctuation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
extends: substitution
message: Use '%s' instead of '%s'
level: error
scope: text
ignorecase: false
nonword: true
swap:
e\.g\.: eg
i\.e\.: ie
\b(?:eg|ie)[^,]: eg, or ie,
37 changes: 37 additions & 0 deletions style-guide/TheEconomist/Slang.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
extends: existence
message: "'%s' - See section 'Journalese and slang'"
scope: text
level: warning
description: "Slang, like metaphors, should be used only occasionally if it is to have effect."
link: http://www.economist.com/style-guide/journalese-and-slang
ignorecase: true
tokens:
- ailing
- Big Pharma
- caring
- crisis
- Ethics violations
- Governance
- gravy train
- guesstimate
- high profile
- highly visible
- hit the big time
- key
- major
- mandarins
- massive
- meaningful
- oil-rich
- perceptions
- prestigious
- salami tactics
- scantily clad
- schizophrenic
- significant
- the bottom line
- the green light
- the likes of
- the thumbs down
- the thumbs up
- too close to call
59 changes: 59 additions & 0 deletions style-guide/TheEconomist/UnexpandedAcronyms.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
extends: conditional
message: "'%s' has no definition"
level: warning
scope: text
description: "Write the words in full on first appearance, unless the abbreviation or acronym is well known."
link: http://www.economist.com/style-guide/abbreviations
first: \b([A-Z]{3,5})\b
second: (?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)
exceptions:
- ABC
- ADD
- ADHD
- AIDS
- APA
- API
- CBS
- CIA
- CSI
- CSS
- CST
- ESPN
- EST
- FAQ
- FIXME
- GNU
- HIV
- HR
- HTML
- HTTP
- HTTPS
- JSON
- LAN
- MIT
- MLA
- MLB
- MTV
- NASA
- NATO
- NBA
- NBC
- NCAA
- NCAAB
- NCAAF
- NFL
- NHL
- NOTE
- PDF
- PGA
- PPV
- PST
- SGML
- SSN
- TNT
- TODO
- URL
- USA
- USSR
- XML
- XXX
34 changes: 34 additions & 0 deletions style-guide/TheEconomist/UnnecessaryWords.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
extends: existence
message: "'%s' - See section 'Unnecessary words'"
level: warning
scope: text
description: Some words add nothing but length to your prose.
link: http://www.economist.com/style-guide/unnecessary-words
ignorecase: true
tokens:
- any time soon
- bought up
- cut back
- cutbacks
- for free
- free gift
- freed up
- hatched up
- headed up by
- large-scale
- meet with
- Most especially
- Most probably
- policymaking process
- safe haven
- sale events
- sent off to bed
- so-called
- sold off
- strike action
- The fact that
- This time around
- top priority
- track record
- weather conditions
- wilderness area
1 change: 1 addition & 0 deletions style-guide/TheEconomist/style.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Based on [The Economist](http://www.economist.com/styleguide/introduction).
2 changes: 1 addition & 1 deletion style-guide/WTD/Abbreviations.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
type: substitution
message: Use '%s'
ignorecase: false
level: error
level: warning
swap:
'(?:eg)': e.g.,
'(?:ie)': i.e.,
Expand Down
1 change: 1 addition & 0 deletions style-guide/WTD/Branding.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@ message: Use '%s' instead of '%s'
level: error
swap:
Write The Docs: Write the Docs
write the docs: Write the Docs
Read The Docs: Read the Docs

0 comments on commit 22541ce

Please sign in to comment.