/
no-extraneous-class.ts
125 lines (115 loc) · 2.95 KB
/
no-extraneous-class.ts
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
import {
TSESTree,
AST_NODE_TYPES,
} from '@typescript-eslint/experimental-utils';
import * as util from '../util';
type Options = [
{
allowConstructorOnly?: boolean;
allowEmpty?: boolean;
allowStaticOnly?: boolean;
}
];
type MessageIds = 'empty' | 'onlyStatic' | 'onlyConstructor';
export default util.createRule<Options, MessageIds>({
name: 'no-extraneous-class',
meta: {
type: 'suggestion',
docs: {
description: 'Forbids the use of classes as namespaces',
tslintRuleName: 'no-unnecessary-class',
category: 'Best Practices',
recommended: false,
},
schema: [
{
type: 'object',
additionalProperties: false,
properties: {
allowConstructorOnly: {
type: 'boolean',
},
allowEmpty: {
type: 'boolean',
},
allowStaticOnly: {
type: 'boolean',
},
},
},
],
messages: {
empty: 'Unexpected empty class.',
onlyStatic: 'Unexpected class with only static properties.',
onlyConstructor: 'Unexpected class with only a constructor.',
},
},
defaultOptions: [
{
allowConstructorOnly: false,
allowEmpty: false,
allowStaticOnly: false,
},
],
create(context, [{ allowConstructorOnly, allowEmpty, allowStaticOnly }]) {
return {
ClassBody(node) {
const parent = node.parent as
| TSESTree.ClassDeclaration
| TSESTree.ClassExpression
| undefined;
if (!parent || parent.superClass) {
return;
}
const reportNode = 'id' in parent && parent.id ? parent.id : parent;
if (node.body.length === 0) {
if (allowEmpty) {
return;
}
context.report({
node: reportNode,
messageId: 'empty',
});
return;
}
let onlyStatic = true;
let onlyConstructor = true;
for (const prop of node.body) {
if ('kind' in prop && prop.kind === 'constructor') {
if (
prop.value.params.some(
param => param.type === AST_NODE_TYPES.TSParameterProperty,
)
) {
onlyConstructor = false;
onlyStatic = false;
}
} else {
onlyConstructor = false;
if ('static' in prop && !prop.static) {
onlyStatic = false;
}
}
if (!(onlyStatic || onlyConstructor)) {
break;
}
}
if (onlyConstructor) {
if (!allowConstructorOnly) {
context.report({
node: reportNode,
messageId: 'onlyConstructor',
});
}
return;
}
if (onlyStatic && !allowStaticOnly) {
context.report({
node: reportNode,
messageId: 'onlyStatic',
});
}
},
};
},
});