forked from typescript-eslint/typescript-eslint
/
ban-types.ts
163 lines (147 loc) · 3.64 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
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
import { TSESLint, TSESTree } from '@typescript-eslint/experimental-utils';
import * as util from '../util';
type Types = Record<
string,
| string
| null
| {
message: string;
fixWith?: string;
}
>;
type Options = [
{
types?: Types;
},
];
type MessageIds = 'bannedTypeMessage';
function removeSpaces(str: string): string {
return str.replace(/ /g, '');
}
function stringifyTypeName(
node: TSESTree.EntityName | TSESTree.TSTypeLiteral,
sourceCode: TSESLint.SourceCode,
): string {
return removeSpaces(sourceCode.getText(node));
}
function getCustomMessage(
bannedType: null | string | { message?: string; fixWith?: string },
): string {
if (bannedType === null) {
return '';
}
if (typeof bannedType === 'string') {
return ` ${bannedType}`;
}
if (bannedType.message) {
return ` ${bannedType.message}`;
}
return '';
}
/*
Defaults for this rule should be treated as an "all or nothing"
merge, so we need special handling here.
See: https://github.com/typescript-eslint/typescript-eslint/issues/686
*/
const defaultTypes = {
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',
},
};
export default util.createRule<Options, MessageIds>({
name: 'ban-types',
meta: {
type: 'suggestion',
docs: {
description: 'Bans specific types from being used',
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: [{}],
create(context, [{ types = defaultTypes }]) {
const bannedTypes: Types = Object.keys(types).reduce(
(res, type) => ({ ...res, [removeSpaces(type)]: types[type] }),
{},
);
function checkBannedTypes(
typeNode: TSESTree.EntityName | TSESTree.TSTypeLiteral,
): void {
const name = stringifyTypeName(typeNode, context.getSourceCode());
if (name in bannedTypes) {
const bannedType = bannedTypes[name];
const customMessage = getCustomMessage(bannedType);
const fixWith =
bannedType && typeof bannedType === 'object' && bannedType.fixWith;
context.report({
node: typeNode,
messageId: 'bannedTypeMessage',
data: {
name,
customMessage,
},
fix: fixWith
? (fixer): TSESLint.RuleFix => fixer.replaceText(typeNode, fixWith)
: null,
});
}
}
return {
TSTypeLiteral(node): void {
if (node.members.length) {
return;
}
checkBannedTypes(node);
},
TSTypeReference({ typeName }): void {
checkBannedTypes(typeName);
},
};
},
});