/
ban-types.ts
128 lines (123 loc) · 3.08 KB
/
ban-types.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
126
127
128
import {
TSESLint,
TSESTree,
AST_NODE_TYPES,
} from '@typescript-eslint/experimental-utils';
import * as util from '../util';
type Options = [
{
types: Record<
string,
| string
| null
| {
message: string;
fixWith?: string;
}
>;
}
];
type MessageIds = 'bannedTypeMessage';
export default util.createRule<Options, MessageIds>({
name: 'ban-types',
meta: {
type: 'suggestion',
docs: {
description: 'Enforces that types will not to be used',
tslintRuleName: 'ban-types',
category: 'Best Practices',
recommended: 'error',
},
fixable: 'code',
messages: {
bannedTypeMessage: "Don't use '{{name}}' as a type.{{customMessage}}",
},
schema: [
{
type: 'object',
properties: {
types: {
type: 'object',
additionalProperties: {
oneOf: [
{ type: 'null' },
{ type: 'string' },
{
type: 'object',
properties: {
message: { type: 'string' },
fixWith: { type: 'string' },
},
additionalProperties: false,
},
],
},
},
},
additionalProperties: false,
},
],
},
defaultOptions: [
{
types: {
String: {
message: 'Use string instead',
fixWith: 'string',
},
Boolean: {
message: 'Use boolean instead',
fixWith: 'boolean',
},
Number: {
message: 'Use number instead',
fixWith: 'number',
},
Object: {
message: 'Use Record<string, any> instead',
fixWith: 'Record<string, any>',
},
Symbol: {
message: 'Use symbol instead',
fixWith: 'symbol',
},
},
},
],
create(context, [{ types: bannedTypes }]) {
return {
'TSTypeReference Identifier'(node: TSESTree.Identifier) {
if (
node.parent &&
node.parent.type !== AST_NODE_TYPES.TSQualifiedName
) {
if (node.name in bannedTypes) {
let customMessage = '';
const bannedCfgValue = bannedTypes[node.name];
let fix: TSESLint.ReportFixFunction | null = null;
if (typeof bannedCfgValue === 'string') {
customMessage += ` ${bannedCfgValue}`;
} else if (bannedCfgValue !== null) {
if (bannedCfgValue.message) {
customMessage += ` ${bannedCfgValue.message}`;
}
if (bannedCfgValue.fixWith) {
const fixWith = bannedCfgValue.fixWith;
fix = fixer => fixer.replaceText(node, fixWith);
}
}
context.report({
node,
messageId: 'bannedTypeMessage',
data: {
name: node.name,
customMessage,
},
fix,
});
}
}
},
};
},
});