-
Notifications
You must be signed in to change notification settings - Fork 499
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
13 changed files
with
254 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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, |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
- PGA | ||
- PPV | ||
- PST | ||
- SGML | ||
- SSN | ||
- TNT | ||
- TODO | ||
- URL | ||
- USA | ||
- USSR | ||
- XML | ||
- XXX |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Based on [The Economist](http://www.economist.com/styleguide/introduction). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters