/
prefer-read-only-props.js
250 lines (236 loc) · 5.75 KB
/
prefer-read-only-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
244
245
246
247
248
249
250
/**
* @fileoverview Require component props to be typed as read-only.
* @author Luke Zapart
*/
'use strict';
// -----------------------------------------------------------------------------
// Requirements
// -----------------------------------------------------------------------------
const rule = require('../../../lib/rules/prefer-read-only-props');
const RuleTester = require('eslint').RuleTester;
const parserOptions = {
ecmaVersion: 2018,
sourceType: 'module',
ecmaFeatures: {
jsx: true
}
};
// ------------------------------------------------------------------------------
// Tests
// ------------------------------------------------------------------------------
const ruleTester = new RuleTester({parserOptions});
ruleTester.run('prefer-read-only-props', rule, {
valid: [
{
// Class component with type parameter
code: `
type Props = {
+name: string,
}
class Hello extends React.Component<Props> {
render () {
return <div>Hello {this.props.name}</div>;
}
}
`,
parser: 'babel-eslint'
},
{
// Class component with typed props property
code: `
class Hello extends React.Component {
props: {
+name: string,
}
render () {
return <div>Hello {this.props.name}</div>;
}
}
`,
parser: 'babel-eslint'
},
{
// Functional component with typed props argument
code: `
function Hello(props: {+name: string}) {
return <div>Hello {props.name}</div>;
}
`,
parser: 'babel-eslint'
},
{
// Functional component with type intersection
code: `
type PropsA = {+firstName: string};
type PropsB = {+lastName: string};
type Props = PropsA & PropsB;
function Hello({firstName, lastName}: Props) {
return <div>Hello {firstName} {lastName}</div>;
}
`,
parser: 'babel-eslint'
},
{
// Arrow function
code: `
const Hello = (props: {+name: string}) => (
<div>Hello {props.name}</div>
);
`,
parser: 'babel-eslint'
},
{
// Destructured props
code: `
const Hello = ({name}: {+name: string}) => (
<div>Hello {props.name}</div>
);
`,
parser: 'babel-eslint'
},
{
// No error, because this is not a component
code: `
const notAComponent = (props: {n: number}) => {
return props.n + 1;
};
`,
parser: 'babel-eslint'
},
{
// No error, because there is no Props flow type
code: `
class Hello extends React.Component {
render () {
return <div>Hello {this.props.name}</div>;
}
}
`
},
{
// No error, because PropTypes do not support variance
code: `
class Hello extends React.Component {
render () {
return <div>Hello {this.props.name}</div>;
}
}
Hello.propTypes = {
name: PropTypes.string,
};
`
}
],
invalid: [
{
// Props.name is not read-only
code: `
type Props = {
name: string,
}
class Hello extends React.Component<Props> {
render () {
return <div>Hello {this.props.name}</div>;
}
}
`,
parser: 'babel-eslint',
errors: [{
message: 'Prop \'name\' should be read-only.'
}]
},
{
// Props.name is contravariant
code: `
type Props = {
-name: string,
}
class Hello extends React.Component<Props> {
render () {
return <div>Hello {this.props.name}</div>;
}
}
`,
parser: 'babel-eslint',
errors: [{
message: 'Prop \'name\' should be read-only.'
}]
},
{
code: `
class Hello extends React.Component {
props: {
name: string,
}
render () {
return <div>Hello {this.props.name}</div>;
}
}
`,
parser: 'babel-eslint',
errors: [{
message: 'Prop \'name\' should be read-only.'
}]
},
{
code: `
function Hello(props: {name: string}) {
return <div>Hello {props.name}</div>;
}
`,
parser: 'babel-eslint',
errors: [{
message: 'Prop \'name\' should be read-only.'
}]
},
{
code: `
function Hello(props: {|name: string|}) {
return <div>Hello {props.name}</div>;
}
`,
parser: 'babel-eslint',
errors: [{
message: 'Prop \'name\' should be read-only.'
}]
},
{
code: `
function Hello({name}: {name: string}) {
return <div>Hello {props.name}</div>;
}
`,
parser: 'babel-eslint',
errors: [{
message: 'Prop \'name\' should be read-only.'
}]
},
{
code: `
type PropsA = {firstName: string};
type PropsB = {lastName: string};
type Props = PropsA & PropsB;
function Hello({firstName, lastName}: Props) {
return <div>Hello {firstName} {lastName}</div>;
}
`,
parser: 'babel-eslint',
errors: [{
message: 'Prop \'firstName\' should be read-only.'
}, {
message: 'Prop \'lastName\' should be read-only.'
}]
},
{
code: `
const Hello = (props: {-name: string}) => (
<div>Hello {props.name}</div>
);
`,
parser: 'babel-eslint',
errors: [{
message: 'Prop \'name\' should be read-only.'
}]
}
]
});