-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy path.textlintrc.json
84 lines (84 loc) · 2.74 KB
/
.textlintrc.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
{
"filters": {
// Disable linting in text using
// <!-- textlint-disable -->
// This is ignored.
//<!-- textlint-enable -->
"comments": true
},
"rules": {
// Alex is the most important rule set in the configuration.
// it catches insensitive and inconsiderate writing. We do
// all have biases - it's time we use computers to help that.
"alex": true,
"max-comma": {
// Limit allowed commas per sentence to two. If you've
// got more than needed for an aside, you have too many.
"max": 2
},
// If you started your sentence with "However," then it doesn't
// follow to start the next with "but".
"no-start-duplicated-conjunction": true,
// Disallow using the interrobang/interabang. (!?)
// It isn't wrong, just tacky.
"no-exclamation-question-mark": {
// Allow using ? seperately.
"allowFullWidthQuestion": true,
"allowHalfWidthQuestion": true
},
// Make sure your links work, please.
"no-dead-link": true,
// Any heading needs to have a purpose.
"no-empty-section": true,
// Let's be consistent with our words.
"terminology": true,
// Make sure you've defined any acronyms correctly.
"unexpanded-acronym": true,
"abbr-within-parentheses": true,
// If you're going on too long, you don't understand the content
// well enough yet.
"en-max-word-count": {
// For clarity, 25 is a useful limit to work in.
"max": 25
},
"write-good": {
// Disable check for passive voice.
"passive": false,
// Don't allow lexical illusion.
"illusion": true,
// Don't start a sentence with "There is" or "There are".
"thereIs": false,
// Don't check for 'politically advantageous' wording.
"weasel": false,
// If you're using an adverb, you really need to
// read more often.
"adverb": true,
// Don't get too wordy, try to explain in brief.
"tooWordy": true,
// Try not to be too cliche.
"cliches": true
},
// Check against capitalization rules.
"en-capitalization": {
// Allow for lower-case lists (please be consistent).
"allowLists": true,
// Allow for lower-case in image 'alt' tags.
"allowFigures": true
},
// Filter for words and phrases that stop critical thought.
// Obviously disable if you're writing ad copy. Realistically,
// place text between <!-- textlint-disable stop-words -->
// and <!-- textlint-enable -->.
"stop-words":{
// Default dictionary that we can whitelist from.
"defaultWords": true,
// Sometimes what you've got to quote isn't fun.
"skip": ["Blockquote"],
// These phrases from the defaults, we'll allow.
// If you need to use a blocked phrase, add in
// your own branch and comment in your commit.
"exclude": [
]
}
}
}