prefer-read-only-props.js
2.22 KB
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
/**
* @fileoverview Require component props to be typed as read-only.
* @author Luke Zapart
*/
'use strict';
const Components = require('../util/Components');
const docsUrl = require('../util/docsUrl');
const report = require('../util/report');
function isFlowPropertyType(node) {
return node.type === 'ObjectTypeProperty';
}
function isCovariant(node) {
return (node.variance && node.variance.kind === 'plus')
|| (
node.parent
&& node.parent.parent
&& node.parent.parent.parent
&& node.parent.parent.parent.id
&& node.parent.parent.parent.id.name === '$ReadOnly'
);
}
// ------------------------------------------------------------------------------
// Rule Definition
// ------------------------------------------------------------------------------
const messages = {
readOnlyProp: 'Prop \'{{name}}\' should be read-only.',
};
module.exports = {
meta: {
docs: {
description: 'Enforce that props are read-only',
category: 'Stylistic Issues',
recommended: false,
url: docsUrl('prefer-read-only-props'),
},
fixable: 'code',
messages,
schema: [],
},
create: Components.detect((context, components) => ({
'Program:exit'() {
const list = components.list();
Object.keys(list).forEach((key) => {
const component = list[key];
if (!component.declaredPropTypes) {
return;
}
Object.keys(component.declaredPropTypes).forEach((propName) => {
const prop = component.declaredPropTypes[propName];
if (!prop.node || !isFlowPropertyType(prop.node)) {
return;
}
if (!isCovariant(prop.node)) {
report(context, messages.readOnlyProp, 'readOnlyProp', {
node: prop.node,
data: {
name: propName,
},
fix: (fixer) => {
if (!prop.node.variance) {
// Insert covariance
return fixer.insertTextBefore(prop.node, '+');
}
// Replace contravariance with covariance
return fixer.replaceText(prop.node.variance, '+');
},
});
}
});
});
},
})),
};