Skip to content

Commit 9f423c5

Browse files
andreyaksenovandreyaksenov
authored
Add Vale config (#3585)
1 parent 39bbf86 commit 9f423c5

32 files changed

+1250
-0
lines changed

‎.vale.ini

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
StylesPath = styles
2+
3+
Vocab = Tarantool
4+
5+
MinAlertLevel = suggestion
6+
7+
[*]
8+
BasedOnStyles = Vale, Tarantool

‎README.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,20 @@ If you need to save the linkcheck's report in a file, you can use the following
149149
Here ``2>&1`` redirects the ``stderr`` output to ``stdout``, and then ``tee`` both
150150
shows in on screen and writes to a file.
151151

152+
153+
Vale
154+
----
155+
156+
Tarantool documentation uses the Vale linter for checking grammar, style, and word usage.
157+
Its configuration is placed in the ``vale.ini`` file located in the root project directory.
158+
159+
To enable RST support in Vale, you need to install Sphinx.
160+
Then, you can enable Vale integration in your IDE, for example:
161+
162+
* `VS Code <https://marketplace.visualstudio.com/items?itemName=errata-ai.vale-server>`_
163+
* `IntelliJ-based IDEs <https://plugins.jetbrains.com/plugin/16136-grazie-professional/docs/project-style-guides.html#vanilla-vale>`_
164+
165+
152166
Localization
153167
------------
154168

‎styles/Tarantool/AMPM.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
extends: existence
2+
message: Use 'AM' or 'PM' (preceded by a space).
3+
level: error
4+
nonword: true
5+
tokens:
6+
- '\d{1,2}[AP]M'
7+
- '\d{1,2} ?[ap]m'
8+
- '\d{1,2} ?[aApP]\.[mM]\.'

‎styles/Tarantool/Accessibility.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
extends: existence
2+
message: "Don't use language (such as '%s') that defines people by their disability."
3+
level: suggestion
4+
ignorecase: true
5+
tokens:
6+
- a victim of
7+
- able-bodied
8+
- affected by
9+
- an epileptic
10+
- crippled
11+
- disabled
12+
- dumb
13+
- handicapped
14+
- handicaps
15+
- healthy
16+
- lame
17+
- maimed
18+
- missing a limb
19+
- mute
20+
- normal
21+
- sight-impaired
22+
- stricken with
23+
- suffers from
24+
- vision-impaired

‎styles/Tarantool/Adverbs.yml

Lines changed: 269 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,269 @@
1+
extends: existence
2+
message: "Consider removing '%s'."
3+
ignorecase: true
4+
level: warning
5+
action:
6+
name: remove
7+
tokens:
8+
- abnormally
9+
- absentmindedly
10+
- accidentally
11+
- adventurously
12+
- anxiously
13+
- arrogantly
14+
- awkwardly
15+
- bashfully
16+
- beautifully
17+
- bitterly
18+
- bleakly
19+
- blindly
20+
- blissfully
21+
- boastfully
22+
- boldly
23+
- bravely
24+
- briefly
25+
- brightly
26+
- briskly
27+
- broadly
28+
- busily
29+
- calmly
30+
- carefully
31+
- carelessly
32+
- cautiously
33+
- cheerfully
34+
- cleverly
35+
- closely
36+
- coaxingly
37+
- colorfully
38+
- continually
39+
- coolly
40+
- courageously
41+
- crossly
42+
- cruelly
43+
- curiously
44+
- daintily
45+
- dearly
46+
- deceivingly
47+
- deeply
48+
- defiantly
49+
- deliberately
50+
- delightfully
51+
- diligently
52+
- dimly
53+
- doubtfully
54+
- dreamily
55+
- easily
56+
- elegantly
57+
- energetically
58+
- enormously
59+
- enthusiastically
60+
- excitedly
61+
- extremely
62+
- fairly
63+
- faithfully
64+
- famously
65+
- ferociously
66+
- fervently
67+
- fiercely
68+
- fondly
69+
- foolishly
70+
- fortunately
71+
- frankly
72+
- frantically
73+
- freely
74+
- frenetically
75+
- frightfully
76+
- furiously
77+
- generally
78+
- generously
79+
- gently
80+
- gladly
81+
- gleefully
82+
- gracefully
83+
- gratefully
84+
- greatly
85+
- greedily
86+
- happily
87+
- hastily
88+
- healthily
89+
- heavily
90+
- helplessly
91+
- honestly
92+
- hopelessly
93+
- hungrily
94+
- innocently
95+
- inquisitively
96+
- intensely
97+
- intently
98+
- interestingly
99+
- inwardly
100+
- irritably
101+
- jaggedly
102+
- jealously
103+
- jovially
104+
- joyfully
105+
- joyously
106+
- jubilantly
107+
- judgmentally
108+
- justly
109+
- keenly
110+
- kiddingly
111+
- kindheartedly
112+
- knavishly
113+
- knowingly
114+
- knowledgeably
115+
- lazily
116+
- lightly
117+
- limply
118+
- lively
119+
- loftily
120+
- longingly
121+
- loosely
122+
- loudly
123+
- lovingly
124+
- loyally
125+
- madly
126+
- majestically
127+
- meaningfully
128+
- mechanically
129+
- merrily
130+
- miserably
131+
- mockingly
132+
- mortally
133+
- mysteriously
134+
- naturally
135+
- nearly
136+
- neatly
137+
- nervously
138+
- nicely
139+
- noisily
140+
- obediently
141+
- obnoxiously
142+
- oddly
143+
- offensively
144+
- optimistically
145+
- overconfidently
146+
- painfully
147+
- partially
148+
- patiently
149+
- perfectly
150+
- playfully
151+
- politely
152+
- poorly
153+
- positively
154+
- potentially
155+
- powerfully
156+
- promptly
157+
- properly
158+
- punctually
159+
- quaintly
160+
- queasily
161+
- queerly
162+
- questionably
163+
- quickly
164+
- quietly
165+
- quirkily
166+
- quizzically
167+
- randomly
168+
- rapidly
169+
- rarely
170+
- readily
171+
- really
172+
- reassuringly
173+
- recklessly
174+
- regularly
175+
- reluctantly
176+
- repeatedly
177+
- reproachfully
178+
- restfully
179+
- righteously
180+
- rightfully
181+
- rigidly
182+
- roughly
183+
- rudely
184+
- safely
185+
- scarcely
186+
- scarily
187+
- searchingly
188+
- sedately
189+
- seemingly
190+
- selfishly
191+
- separately
192+
- seriously
193+
- shakily
194+
- sharply
195+
- sheepishly
196+
- shrilly
197+
- shyly
198+
- silently
199+
- sleepily
200+
- slowly
201+
- smoothly
202+
- softly
203+
- solemnly
204+
- solidly
205+
- speedily
206+
- stealthily
207+
- sternly
208+
- strictly
209+
- suddenly
210+
- supposedly
211+
- surprisingly
212+
- suspiciously
213+
- sweetly
214+
- swiftly
215+
- sympathetically
216+
- tenderly
217+
- tensely
218+
- terribly
219+
- thankfully
220+
- thoroughly
221+
- thoughtfully
222+
- tightly
223+
- tremendously
224+
- triumphantly
225+
- truthfully
226+
- ultimately
227+
- unabashedly
228+
- unaccountably
229+
- unbearably
230+
- unethically
231+
- unexpectedly
232+
- unfortunately
233+
- unimpressively
234+
- unnaturally
235+
- unnecessarily
236+
- urgently
237+
- usefully
238+
- uselessly
239+
- utterly
240+
- vacantly
241+
- vaguely
242+
- vainly
243+
- valiantly
244+
- vastly
245+
- verbally
246+
- very
247+
- viciously
248+
- victoriously
249+
- violently
250+
- vivaciously
251+
- voluntarily
252+
- warmly
253+
- weakly
254+
- wearily
255+
- wetly
256+
- wholly
257+
- wildly
258+
- willfully
259+
- wisely
260+
- woefully
261+
- wonderfully
262+
- worriedly
263+
- yawningly
264+
- yearningly
265+
- yieldingly
266+
- youthfully
267+
- zealously
268+
- zestfully
269+
- zestily

‎styles/Tarantool/Auto.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
extends: existence
2+
message: "In general, don't hyphenate '%s'."
3+
ignorecase: true
4+
level: error
5+
action:
6+
name: convert
7+
params:
8+
- simple
9+
tokens:
10+
- 'auto-\w+'

‎styles/Tarantool/BadPlurals.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
extends: existence
2+
message: "Rewrite '%s' to be plural without parentheses."
3+
level: warning
4+
ignorecase: true
5+
raw:
6+
- '\b\w+\(s\)(?<!http\(s\))'

0 commit comments

Comments
 (0)