Skip to content

Commit 0d24667

Browse files
hardfisthardfist
authored
chore: add rules page (#259)
1 parent 81cf0e3 commit 0d24667

File tree

5 files changed

+583
-53
lines changed

5 files changed

+583
-53
lines changed

‎packages/rslint-test-tools/rule-manifest.json‎

Lines changed: 51 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
{
22
"rules": [
33
{
4-
"name": "adjacent_overload_signatures",
4+
"name": "adjacent-overload-signatures",
55
"group": "typescript-eslint",
66
"status": "full",
77
"failing_case": []
88
},
99
{
10-
"name": "array_type",
10+
"name": "array-type",
1111
"group": "typescript-eslint",
1212
"status": "partial-impl",
1313
"failing_case": [
@@ -22,295 +22,295 @@
2222
]
2323
},
2424
{
25-
"name": "await_thenable",
25+
"name": "await-thenable",
2626
"group": "typescript-eslint",
2727
"status": "full",
2828
"failing_case": []
2929
},
3030
{
31-
"name": "class_literal_property_style",
31+
"name": "class-literal-property-style",
3232
"group": "typescript-eslint",
3333
"status": "full",
3434
"failing_case": []
3535
},
3636
{
37-
"name": "no_array_delete",
37+
"name": "no-array-delete",
3838
"group": "typescript-eslint",
3939
"status": "full",
4040
"failing_case": []
4141
},
4242
{
43-
"name": "no_base_to_string",
43+
"name": "no-base-to-string",
4444
"group": "typescript-eslint",
4545
"status": "partial-test",
4646
"failing_case": []
4747
},
4848
{
49-
"name": "no_confusing_void_expression",
49+
"name": "no-confusing-void-expression",
5050
"group": "typescript-eslint",
5151
"status": "full",
5252
"failing_case": []
5353
},
5454
{
55-
"name": "no_duplicate_type_constituents",
55+
"name": "no-duplicate-type-constituents",
5656
"group": "typescript-eslint",
5757
"status": "full",
5858
"failing_case": []
5959
},
6060
{
61-
"name": "no_empty_function",
61+
"name": "no-empty-function",
6262
"group": "typescript-eslint",
6363
"status": "full",
6464
"failing_case": []
6565
},
6666
{
67-
"name": "no_empty_interface",
67+
"name": "no-empty-interface",
6868
"group": "typescript-eslint",
6969
"status": "full",
7070
"failing_case": []
7171
},
7272
{
73-
"name": "no_floating_promises",
73+
"name": "no-floating-promises",
7474
"group": "typescript-eslint",
7575
"status": "partial-test",
7676
"failing_case": []
7777
},
7878
{
79-
"name": "no_for_in_array",
79+
"name": "no-for-in-array",
8080
"group": "typescript-eslint",
8181
"status": "partial-test",
8282
"failing_case": []
8383
},
8484
{
85-
"name": "no_implied_eval",
85+
"name": "no-implied-eval",
8686
"group": "typescript-eslint",
8787
"status": "full",
8888
"failing_case": []
8989
},
9090
{
91-
"name": "no_meaningless_void_operator",
91+
"name": "no-meaningless-void-operator",
9292
"group": "typescript-eslint",
9393
"status": "partial-test",
9494
"failing_case": []
9595
},
9696
{
97-
"name": "no_misused_promises",
97+
"name": "no-misused-promises",
9898
"group": "typescript-eslint",
9999
"status": "partial-test",
100100
"failing_case": []
101101
},
102102
{
103-
"name": "no_misused_spread",
103+
"name": "no-misused-spread",
104104
"group": "typescript-eslint",
105105
"status": "partial-test",
106106
"failing_case": []
107107
},
108108
{
109-
"name": "no_mixed_enums",
109+
"name": "no-mixed-enums",
110110
"group": "typescript-eslint",
111111
"status": "partial-test",
112112
"failing_case": []
113113
},
114114
{
115-
"name": "no_namespace",
115+
"name": "no-namespace",
116116
"group": "typescript-eslint",
117117
"status": "full",
118118
"failing_case": []
119119
},
120120
{
121-
"name": "no_redundant_type_constituents",
121+
"name": "no-redundant-type-constituents",
122122
"group": "typescript-eslint",
123123
"status": "partial-test",
124124
"failing_case": []
125125
},
126126
{
127-
"name": "no_require_imports",
127+
"name": "no-require-imports",
128128
"group": "typescript-eslint",
129129
"status": "full",
130130
"failing_case": []
131131
},
132132
{
133-
"name": "no_unnecessary_boolean_literal_compare",
133+
"name": "no-unnecessary-boolean-literal-compare",
134134
"group": "typescript-eslint",
135135
"status": "partial-test",
136136
"failing_case": []
137137
},
138138
{
139-
"name": "no_unnecessary_template_expression",
139+
"name": "no-unnecessary-template-expression",
140140
"group": "typescript-eslint",
141141
"status": "partial-test",
142142
"failing_case": []
143143
},
144144
{
145-
"name": "no_unnecessary_type_arguments",
145+
"name": "no-unnecessary-type-arguments",
146146
"group": "typescript-eslint",
147147
"status": "partial-test",
148148
"failing_case": []
149149
},
150150
{
151-
"name": "no_unnecessary_type_assertion",
151+
"name": "no-unnecessary-type-assertion",
152152
"group": "typescript-eslint",
153153
"status": "partial-test",
154154
"failing_case": []
155155
},
156156
{
157-
"name": "no_unsafe_argument",
157+
"name": "no-unsafe-argument",
158158
"group": "typescript-eslint",
159159
"status": "partial-test",
160160
"failing_case": []
161161
},
162162
{
163-
"name": "no_unsafe_assignment",
163+
"name": "no-unsafe-assignment",
164164
"group": "typescript-eslint",
165165
"status": "partial-test",
166166
"failing_case": []
167167
},
168168
{
169-
"name": "no_unsafe_call",
169+
"name": "no-unsafe-call",
170170
"group": "typescript-eslint",
171171
"status": "partial-test",
172172
"failing_case": []
173173
},
174174
{
175-
"name": "no_unsafe_enum_comparison",
175+
"name": "no-unsafe-enum-comparison",
176176
"group": "typescript-eslint",
177177
"status": "partial-test",
178178
"failing_case": []
179179
},
180180
{
181-
"name": "no_unsafe_member_access",
181+
"name": "no-unsafe-member-access",
182182
"group": "typescript-eslint",
183183
"status": "partial-test",
184184
"failing_case": []
185185
},
186186
{
187-
"name": "no_unsafe_return",
187+
"name": "no-unsafe-return",
188188
"group": "typescript-eslint",
189189
"status": "partial-test",
190190
"failing_case": []
191191
},
192192
{
193-
"name": "no_unsafe_type_assertion",
193+
"name": "no-unsafe-type-assertion",
194194
"group": "typescript-eslint",
195195
"status": "partial-test",
196196
"failing_case": []
197197
},
198198
{
199-
"name": "no_unsafe_unary_minus",
199+
"name": "no-unsafe-unary-minus",
200200
"group": "typescript-eslint",
201201
"status": "partial-test",
202202
"failing_case": []
203203
},
204204
{
205-
"name": "no_unused_vars",
205+
"name": "no-unused-vars",
206206
"group": "typescript-eslint",
207207
"status": "partial-test",
208208
"failing_case": []
209209
},
210210
{
211-
"name": "no_useless_empty_export",
211+
"name": "no-useless-empty-export",
212212
"group": "typescript-eslint",
213213
"status": "partial-test",
214214
"failing_case": []
215215
},
216216
{
217-
"name": "no_var_requires",
217+
"name": "no-var-requires",
218218
"group": "typescript-eslint",
219219
"status": "partial-test",
220220
"failing_case": []
221221
},
222222
{
223-
"name": "non_nullable_type_assertion_style",
223+
"name": "non-nullable-type-assertion-style",
224224
"group": "typescript-eslint",
225225
"status": "partial-test",
226226
"failing_case": []
227227
},
228228
{
229-
"name": "only_throw_error",
229+
"name": "only-throw-error",
230230
"group": "typescript-eslint",
231231
"status": "partial-test",
232232
"failing_case": []
233233
},
234234
{
235-
"name": "prefer_as_const",
235+
"name": "prefer-as-const",
236236
"group": "typescript-eslint",
237237
"status": "partial-test",
238238
"failing_case": []
239239
},
240240
{
241-
"name": "prefer_promise_reject_errors",
241+
"name": "prefer-promise-reject-errors",
242242
"group": "typescript-eslint",
243243
"status": "partial-test",
244244
"failing_case": []
245245
},
246246
{
247-
"name": "prefer_reduce_type_parameter",
247+
"name": "prefer-reduce-type-parameter",
248248
"group": "typescript-eslint",
249249
"status": "partial-test",
250250
"failing_case": []
251251
},
252252
{
253-
"name": "prefer_return_this_type",
253+
"name": "prefer-return-this-type",
254254
"group": "typescript-eslint",
255255
"status": "partial-test",
256256
"failing_case": []
257257
},
258258
{
259-
"name": "promise_function_async",
259+
"name": "promise-function-async",
260260
"group": "typescript-eslint",
261261
"status": "partial-test",
262262
"failing_case": []
263263
},
264264
{
265-
"name": "related_getter_setter_pairs",
265+
"name": "related-getter-setter-pairs",
266266
"group": "typescript-eslint",
267267
"status": "partial-test",
268268
"failing_case": []
269269
},
270270
{
271-
"name": "require_array_sort_compare",
271+
"name": "require-array-sort-compare",
272272
"group": "typescript-eslint",
273273
"status": "partial-test",
274274
"failing_case": []
275275
},
276276
{
277-
"name": "require_await",
277+
"name": "require-await",
278278
"group": "typescript-eslint",
279279
"status": "partial-test",
280280
"failing_case": []
281281
},
282282
{
283-
"name": "restrict_plus_operands",
283+
"name": "restrict-plus-operands",
284284
"group": "typescript-eslint",
285285
"status": "partial-test",
286286
"failing_case": []
287287
},
288288
{
289-
"name": "restrict_template_expressions",
289+
"name": "restrict-template-expressions",
290290
"group": "typescript-eslint",
291291
"status": "partial-test",
292292
"failing_case": []
293293
},
294294
{
295-
"name": "return_await",
295+
"name": "return-await",
296296
"group": "typescript-eslint",
297297
"status": "partial-test",
298298
"failing_case": []
299299
},
300300
{
301-
"name": "switch_exhaustiveness_check",
301+
"name": "switch-exhaustiveness-check",
302302
"group": "typescript-eslint",
303303
"status": "partial-test",
304304
"failing_case": []
305305
},
306306
{
307-
"name": "unbound_method",
307+
"name": "unbound-method",
308308
"group": "typescript-eslint",
309309
"status": "partial-test",
310310
"failing_case": []
311311
},
312312
{
313-
"name": "use_unknown_in_catch_callback_variable",
313+
"name": "use-unknown-in-catch-callback-variable",
314314
"group": "typescript-eslint",
315315
"status": "partial-test",
316316
"failing_case": []

‎scripts/gen-rule-manifest.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ function buildManifest() {
135135
failing_case = skipCases;
136136
}
137137
}
138-
return { name: rule, group, status, failing_case };
138+
return { name: rule.replace(/_/g, '-'), group, status, failing_case };
139139
});
140140
return { rules };
141141
}

‎website/docs/rules/index.mdx‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
import Manifest from './rule-manifest.tsx';
2+
3+
# Rules
4+
5+
<Manifest />

0 commit comments

Comments
 (0)