forked from jsx-eslint/eslint-plugin-react
-
Notifications
You must be signed in to change notification settings - Fork 0
/
jsx-sort-props.js
243 lines (235 loc) · 8.57 KB
/
jsx-sort-props.js
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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
/**
* @fileoverview Enforce props alphabetical sorting
* @author Yannick Croissant
*/
'use strict';
// -----------------------------------------------------------------------------
// Requirements
// -----------------------------------------------------------------------------
var rule = require('../../../lib/rules/jsx-sort-props');
var RuleTester = require('eslint').RuleTester;
var parserOptions = {
ecmaVersion: 6,
ecmaFeatures: {
jsx: true
}
};
// -----------------------------------------------------------------------------
// Tests
// -----------------------------------------------------------------------------
var ruleTester = new RuleTester();
var expectedError = {
message: 'Props should be sorted alphabetically',
type: 'JSXAttribute'
};
var expectedCallbackError = {
message: 'Callbacks must be listed after all other props',
type: 'JSXAttribute'
};
var expectedShorthandFirstError = {
message: 'Shorthand props must be listed before all other props',
type: 'JSXAttribute'
};
var expectedShorthandLastError = {
message: 'Shorthand props must be listed after all other props',
type: 'JSXAttribute'
};
var expectedReservedFirstError = {
message: 'Reserved props must be listed before all other props',
type: 'JSXAttribute'
};
var expectedEmptyReservedFirstError = {
message: 'A customized reserved first list must not be empty'
};
var expectedInvalidReservedFirstError = {
message: 'A customized reserved first list must only contain a subset of React reserved props. Remove: notReserved'
};
var callbacksLastArgs = [{
callbacksLast: true
}];
var shorthandFirstArgs = [{
shorthandFirst: true
}];
var shorthandLastArgs = [{
shorthandLast: true
}];
var shorthandAndCallbackLastArgs = [{
callbacksLast: true,
shorthandLast: true
}];
var ignoreCaseArgs = [{
ignoreCase: true
}];
var noSortAlphabeticallyArgs = [{
noSortAlphabetically: true
}];
var sortAlphabeticallyArgs = [{
noSortAlphabetically: false
}];
var reservedFirstAsBooleanArgs = [{
reservedFirst: true
}];
var reservedFirstAsArrayArgs = [{
reservedFirst: ['children', 'dangerouslySetInnerHTML', 'key']
}];
var reservedFirstWithNoSortAlphabeticallyArgs = [{
noSortAlphabetically: true,
reservedFirst: true
}];
var reservedFirstAsEmptyArrayArgs = [{
reservedFirst: []
}];
var reservedFirstAsInvalidArrayArgs = [{
reservedFirst: ['notReserved']
}];
ruleTester.run('jsx-sort-props', rule, {
valid: [
{code: '<App />;', parserOptions: parserOptions},
{code: '<App {...this.props} />;', parserOptions: parserOptions},
{code: '<App a b c />;', parserOptions: parserOptions},
{code: '<App {...this.props} a b c />;', parserOptions: parserOptions},
{code: '<App c {...this.props} a b />;', parserOptions: parserOptions},
{code: '<App a="c" b="b" c="a" />;', parserOptions: parserOptions},
{code: '<App {...this.props} a="c" b="b" c="a" />;', parserOptions: parserOptions},
{code: '<App c="a" {...this.props} a="c" b="b" />;', parserOptions: parserOptions},
{code: '<App A a />;', parserOptions: parserOptions},
// Ignoring case
{code: '<App a A />;', options: ignoreCaseArgs, parserOptions: parserOptions},
{code: '<App a B c />;', options: ignoreCaseArgs, parserOptions: parserOptions},
{code: '<App A b C />;', options: ignoreCaseArgs, parserOptions: parserOptions},
// Sorting callbacks below all other props
{code: '<App a z onBar onFoo />;', options: callbacksLastArgs, parserOptions: parserOptions},
// Sorting shorthand props before others
{code: '<App a b="b" />;', options: shorthandFirstArgs, parserOptions: parserOptions},
{code: '<App z a="a" />;', options: shorthandFirstArgs, parserOptions: parserOptions},
{code: '<App x y z a="a" b="b" />;', options: shorthandFirstArgs, parserOptions: parserOptions},
{code: '<App a="a" b="b" x y z />;', options: shorthandLastArgs, parserOptions: parserOptions},
{
code: '<App a="a" b="b" x y z onBar onFoo />;',
options: shorthandAndCallbackLastArgs,
parserOptions: parserOptions
},
// noSortAlphabetically
{code: '<App a b />;', options: noSortAlphabeticallyArgs, parserOptions: parserOptions},
{code: '<App b a />;', options: noSortAlphabeticallyArgs, parserOptions: parserOptions},
// reservedFirst
{
code: '<App children={<App />} key={0} ref="r" a b c />',
options: reservedFirstAsBooleanArgs,
parserOptions: parserOptions
},
{
code: '<App children={<App />} key={0} ref="r" a b c dangerouslySetInnerHTML={{__html: "EPR"}} />',
options: reservedFirstAsBooleanArgs,
parserOptions: parserOptions
},
{
code: '<App children={<App />} key={0} a ref="r" />',
options: reservedFirstAsArrayArgs,
parserOptions: parserOptions
},
{
code: '<App children={<App />} key={0} a dangerouslySetInnerHTML={{__html: "EPR"}} ref="r" />',
options: reservedFirstAsArrayArgs,
parserOptions: parserOptions
},
{
code: '<App ref="r" key={0} children={<App />} b a c />',
options: reservedFirstWithNoSortAlphabeticallyArgs,
parserOptions: parserOptions
},
{
code: '<div ref="r" dangerouslySetInnerHTML={{__html: "EPR"}} key={0} children={<App />} b a c />',
options: reservedFirstWithNoSortAlphabeticallyArgs,
parserOptions: parserOptions
}
],
invalid: [
{code: '<App b a />;', errors: [expectedError], parserOptions: parserOptions},
{code: '<App {...this.props} b a />;', errors: [expectedError], parserOptions: parserOptions},
{code: '<App c {...this.props} b a />;', errors: [expectedError], parserOptions: parserOptions},
{code: '<App a A />;', errors: [expectedError], parserOptions: parserOptions},
{code: '<App B a />;', options: ignoreCaseArgs, errors: [expectedError], parserOptions: parserOptions},
{code: '<App B A c />;', options: ignoreCaseArgs, errors: [expectedError], parserOptions: parserOptions},
{code: '<App c="a" a="c" b="b" />;', errors: 2, parserOptions: parserOptions},
{code: '<App {...this.props} c="a" a="c" b="b" />;', errors: 2, parserOptions: parserOptions},
{code: '<App d="d" b="b" {...this.props} c="a" a="c" />;', errors: 2, parserOptions: parserOptions},
{
code: '<App a z onFoo onBar />;',
errors: [expectedError],
options: callbacksLastArgs,
parserOptions: parserOptions
}, {
code: '<App a onBar onFoo z />;',
errors: [expectedCallbackError],
options: callbacksLastArgs,
parserOptions: parserOptions
}, {
code: '<App a="a" b />;',
errors: [expectedShorthandFirstError],
options: shorthandFirstArgs,
parserOptions: parserOptions
},
{code: '<App z x a="a" />;', errors: [expectedError], options: shorthandFirstArgs, parserOptions: parserOptions}, {
code: '<App b a="a" />;',
errors: [expectedShorthandLastError],
options: shorthandLastArgs,
parserOptions: parserOptions
}, {
code: '<App a="a" onBar onFoo z x />;',
errors: [shorthandAndCallbackLastArgs],
options: shorthandLastArgs,
parserOptions: parserOptions
},
{code: '<App b a />;', errors: [expectedError], options: sortAlphabeticallyArgs, parserOptions: parserOptions},
// reservedFirst
{
code: '<App a key={1} />',
options: reservedFirstAsBooleanArgs,
errors: [expectedReservedFirstError],
parserOptions: parserOptions
},
{
code: '<div a dangerouslySetInnerHTML={{__html: "EPR"}} />',
options: reservedFirstAsBooleanArgs,
errors: [expectedReservedFirstError],
parserOptions: parserOptions
},
{
code: '<App ref="r" key={2} b />',
options: reservedFirstAsBooleanArgs,
errors: [expectedError],
parserOptions: parserOptions
},
{
code: '<App dangerouslySetInnerHTML={{__html: "EPR"}} key={2} b />',
options: reservedFirstAsBooleanArgs,
errors: [expectedReservedFirstError],
parserOptions: parserOptions
},
{
code: '<App key={3} children={<App />} />',
options: reservedFirstAsArrayArgs,
errors: [expectedError],
parserOptions: parserOptions
},
{
code: '<App z ref="r" />',
options: reservedFirstWithNoSortAlphabeticallyArgs,
errors: [expectedReservedFirstError],
parserOptions: parserOptions
},
{
code: '<App key={4} />',
options: reservedFirstAsEmptyArrayArgs,
errors: [expectedEmptyReservedFirstError],
parserOptions: parserOptions
},
{
code: '<App key={5} />',
options: reservedFirstAsInvalidArrayArgs,
errors: [expectedInvalidReservedFirstError],
parserOptions: parserOptions
}
]
});