-
-
Notifications
You must be signed in to change notification settings - Fork 2.7k
/
index.tsx
196 lines (187 loc) · 5.46 KB
/
index.tsx
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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
import React, { useState, useMemo } from 'react';
import clsx from 'clsx';
import Link from '@docusaurus/Link';
import { useRulesMeta } from '@site/src/hooks/useRulesMeta';
import type { RulesMeta } from '@site/rulesMeta';
import styles from './styles.module.css';
function interpolateCode(text: string): (JSX.Element | string)[] | string {
const fragments = text.split(/`(.*?)`/);
if (fragments.length === 1) {
return text;
}
return fragments.map((v, i) => (i % 2 === 0 ? v : <code key={i}>{v}</code>));
}
function RuleRow({ rule }: { rule: RulesMeta[number] }): JSX.Element | null {
if (!rule.docs || !rule.docs.url) {
return null;
}
return (
<tr>
<td>
<Link to={new URL(rule.docs.url).pathname}>
<code>@typescript-eslint/{rule.name}</code>
</Link>
<br />
{interpolateCode(rule.docs.description)}
</td>
<td className={styles.attrCol}>
{rule.docs.recommended === 'strict'
? '🔒'
: rule.docs.recommended
? '✅'
: ''}
</td>
<td className={styles.attrCol}>
{rule.fixable ? '🔧\n' : '\n'}
{rule.hasSuggestions ? '💡' : ''}
</td>
<td className={styles.attrCol}>
{rule.docs.requiresTypeChecking ? '💭' : ''}
</td>
</tr>
);
}
const filterModes = ['neutral', 'include', 'exclude'] as const;
type FilterMode = typeof filterModes[number];
function RuleFilterCheckBox({
label,
setMode,
mode,
}: {
label: string;
setMode: (mode: FilterMode) => void;
mode: FilterMode;
}): JSX.Element {
const toNextMode = (): void =>
setMode(filterModes[(filterModes.indexOf(mode) + 1) % filterModes.length]);
return (
<li className={styles.checkboxListItem}>
<button
type="button"
className={clsx(
styles.checkboxLabel,
mode === 'include' && styles.activated,
mode === 'exclude' && styles.deactivated,
)}
onKeyDown={(e): void => {
if (e.key === 'Enter') {
toNextMode();
}
}}
onClick={toNextMode}
aria-label={`Toggle the filter mode. Current: ${mode}`}
>
<div
aria-hidden
className={clsx(styles.visual, styles[`visual-${mode}`])}
/>
{label}
</button>
</li>
);
}
function match(mode: FilterMode, value: boolean): boolean | undefined {
if (mode === 'exclude') {
return !value;
}
if (mode === 'include') {
return value;
}
return undefined;
}
export default function RulesTable({
extensionRules,
}: {
extensionRules?: boolean;
}): JSX.Element {
const rules = useRulesMeta();
const [showRecommended, setShowRecommended] = useState<FilterMode>('neutral');
const [showStrict, setShowStrict] = useState<FilterMode>('neutral');
const [showFixable, setShowFixable] = useState<FilterMode>('neutral');
const [showHasSuggestions, setShowHasSuggestion] =
useState<FilterMode>('neutral');
const [showTypeCheck, setShowTypeCheck] = useState<FilterMode>('neutral');
const relevantRules = useMemo(
() =>
rules
.filter(r => !!extensionRules === !!r.docs?.extendsBaseRule)
.filter(r => {
const opinions = [
match(
showRecommended,
r.docs?.recommended === 'error' || r.docs?.recommended === 'warn',
),
match(showStrict, r.docs?.recommended === 'strict'),
match(showFixable, !!r.fixable),
match(showHasSuggestions, !!r.hasSuggestions),
match(showTypeCheck, !!r.docs?.requiresTypeChecking),
].filter((o): o is boolean => o !== undefined);
return opinions.every(o => o);
}),
[
rules,
extensionRules,
showRecommended,
showStrict,
showFixable,
showHasSuggestions,
showTypeCheck,
],
);
return (
<>
<ul className={clsx('clean-list', styles.checkboxList)}>
<RuleFilterCheckBox
mode={showRecommended}
setMode={(newMode): void => {
setShowRecommended(newMode);
if (newMode === 'include' && showStrict === 'include') {
setShowStrict('exclude');
}
}}
label="✅ recommended"
/>
<RuleFilterCheckBox
mode={showStrict}
setMode={(newMode): void => {
setShowStrict(newMode);
if (newMode === 'include' && showRecommended === 'include') {
setShowRecommended('exclude');
}
}}
label="🔒 strict"
/>
<RuleFilterCheckBox
mode={showFixable}
setMode={setShowFixable}
label="🔧 fixable"
/>
<RuleFilterCheckBox
mode={showHasSuggestions}
setMode={setShowHasSuggestion}
label="💡 has suggestions"
/>
<RuleFilterCheckBox
mode={showTypeCheck}
setMode={setShowTypeCheck}
label="💭 requires type information"
/>
</ul>
<table className={styles.rulesTable}>
<thead>
<tr>
<th className={styles.ruleCol}>Rule</th>
<th className={styles.attrCol}>✅{'\n'}🔒</th>
<th className={styles.attrCol}>🔧{'\n'}💡</th>
<th className={styles.attrCol}>💭</th>
</tr>
</thead>
<tbody>
{relevantRules.map(rule => (
<RuleRow rule={rule} key={rule.name} />
))}
</tbody>
</table>
</>
);
}