Skip to content

Commit 3b2f878

Browse files
committed
Initial release
1 parent 01bf942 commit 3b2f878

File tree

10 files changed

+1404
-0
lines changed

10 files changed

+1404
-0
lines changed

write-good/Cliches.yml

Lines changed: 702 additions & 0 deletions
Large diffs are not rendered by default.

write-good/E-Prime.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
extends: existence
2+
message: 'Avoid using "%s"'
3+
ignorecase: true
4+
level: suggestion
5+
tokens:
6+
- am
7+
- are
8+
- aren't
9+
- be
10+
- been
11+
- being
12+
- he's
13+
- here's
14+
- here's
15+
- how's
16+
- i'm
17+
- is
18+
- isn't
19+
- she's
20+
- that's
21+
- there's
22+
- they're
23+
- was
24+
- wasn't
25+
- we're
26+
- were
27+
- weren't
28+
- what's
29+
- where's
30+
- who's
31+
- you're

write-good/Illusions.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
extends: repetition
2+
message: "'%s' is repeated!"
3+
level: warning
4+
ignorecase: true
5+
tokens:
6+
- '[\w]+'

write-good/Passive.yml

Lines changed: 183 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,183 @@
1+
extends: existence
2+
message: "'%s' may be passive voice. Use active voice if you can."
3+
ignorecase: true
4+
level: warning
5+
raw:
6+
- \b(am|are|were|being|is|been|was|be)\b\s*
7+
tokens:
8+
- '[\w]+ed'
9+
- awoken
10+
- beat
11+
- become
12+
- been
13+
- begun
14+
- bent
15+
- beset
16+
- bet
17+
- bid
18+
- bidden
19+
- bitten
20+
- bled
21+
- blown
22+
- born
23+
- bought
24+
- bound
25+
- bred
26+
- broadcast
27+
- broken
28+
- brought
29+
- built
30+
- burnt
31+
- burst
32+
- cast
33+
- caught
34+
- chosen
35+
- clung
36+
- come
37+
- cost
38+
- crept
39+
- cut
40+
- dealt
41+
- dived
42+
- done
43+
- drawn
44+
- dreamt
45+
- driven
46+
- drunk
47+
- dug
48+
- eaten
49+
- fallen
50+
- fed
51+
- felt
52+
- fit
53+
- fled
54+
- flown
55+
- flung
56+
- forbidden
57+
- foregone
58+
- forgiven
59+
- forgotten
60+
- forsaken
61+
- fought
62+
- found
63+
- frozen
64+
- given
65+
- gone
66+
- gotten
67+
- ground
68+
- grown
69+
- heard
70+
- held
71+
- hidden
72+
- hit
73+
- hung
74+
- hurt
75+
- kept
76+
- knelt
77+
- knit
78+
- known
79+
- laid
80+
- lain
81+
- leapt
82+
- learnt
83+
- led
84+
- left
85+
- lent
86+
- let
87+
- lighted
88+
- lost
89+
- made
90+
- meant
91+
- met
92+
- misspelt
93+
- mistaken
94+
- mown
95+
- overcome
96+
- overdone
97+
- overtaken
98+
- overthrown
99+
- paid
100+
- pled
101+
- proven
102+
- put
103+
- quit
104+
- read
105+
- rid
106+
- ridden
107+
- risen
108+
- run
109+
- rung
110+
- said
111+
- sat
112+
- sawn
113+
- seen
114+
- sent
115+
- set
116+
- sewn
117+
- shaken
118+
- shaven
119+
- shed
120+
- shod
121+
- shone
122+
- shorn
123+
- shot
124+
- shown
125+
- shrunk
126+
- shut
127+
- slain
128+
- slept
129+
- slid
130+
- slit
131+
- slung
132+
- smitten
133+
- sold
134+
- sought
135+
- sown
136+
- sped
137+
- spent
138+
- spilt
139+
- spit
140+
- split
141+
- spoken
142+
- spread
143+
- sprung
144+
- spun
145+
- stolen
146+
- stood
147+
- stridden
148+
- striven
149+
- struck
150+
- strung
151+
- stuck
152+
- stung
153+
- stunk
154+
- sung
155+
- sunk
156+
- swept
157+
- swollen
158+
- sworn
159+
- swum
160+
- swung
161+
- taken
162+
- taught
163+
- thought
164+
- thrived
165+
- thrown
166+
- thrust
167+
- told
168+
- torn
169+
- trodden
170+
- understood
171+
- upheld
172+
- upset
173+
- wed
174+
- wept
175+
- withheld
176+
- withstood
177+
- woken
178+
- won
179+
- worn
180+
- wound
181+
- woven
182+
- written
183+
- wrung

write-good/README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
Based on [write-good](https://github.com/btford/write-good).
2+
3+
> Naive linter for English prose for developers who can't write good and wanna learn to do other stuff good too.
4+
5+
```
6+
The MIT License (MIT)
7+
8+
Copyright (c) 2014 Brian Ford
9+
10+
Permission is hereby granted, free of charge, to any person obtaining a copy
11+
of this software and associated documentation files (the "Software"), to deal
12+
in the Software without restriction, including without limitation the rights
13+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14+
copies of the Software, and to permit persons to whom the Software is
15+
furnished to do so, subject to the following conditions:
16+
17+
The above copyright notice and this permission notice shall be included in all
18+
copies or substantial portions of the Software.
19+
20+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26+
SOFTWARE.
27+
```

write-good/So.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
extends: existence
2+
message: "Don't start a sentence with '%s'"
3+
level: error
4+
raw:
5+
- '(?:[;-]\s)so[\s,]|So[\s,]'

write-good/ThereIs.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
extends: existence
2+
message: "Don't start a sentence with '%s'"
3+
ignorecase: true
4+
level: error
5+
raw:
6+
- '(?:^[^\w]*|[;-]\s)There\b\s(is|are)\b'

0 commit comments

Comments
 (0)