/
member-delimiter-style.ts
236 lines (219 loc) · 6.22 KB
/
member-delimiter-style.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
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
import {
TSESTree,
AST_NODE_TYPES,
} from '@typescript-eslint/experimental-utils';
import * as util from '../util';
type Delimiter = 'comma' | 'none' | 'semi';
interface TypeOptions {
delimiter?: Delimiter;
requireLast?: boolean;
}
interface BaseOptions {
multiline?: TypeOptions;
singleline?: TypeOptions;
}
interface Config extends BaseOptions {
overrides?: {
typeLiteral?: BaseOptions;
interface?: BaseOptions;
};
}
type Options = [Config];
type MessageIds =
| 'unexpectedComma'
| 'unexpectedSemi'
| 'expectedComma'
| 'expectedSemi';
const definition = {
type: 'object',
properties: {
multiline: {
type: 'object',
properties: {
delimiter: { enum: ['none', 'semi', 'comma'] },
requireLast: { type: 'boolean' },
},
additionalProperties: false,
},
singleline: {
type: 'object',
properties: {
// note can't have "none" for single line delimiter as it's invlaid syntax
delimiter: { enum: ['semi', 'comma'] },
requireLast: { type: 'boolean' },
},
additionalProperties: false,
},
},
additionalProperties: false,
};
export default util.createRule<Options, MessageIds>({
name: 'member-delimiter-style',
meta: {
type: 'suggestion',
docs: {
description:
'Require a specific member delimiter style for interfaces and type literals',
category: 'Stylistic Issues',
recommended: 'error',
},
fixable: 'code',
messages: {
unexpectedComma: 'Unexpected separator (,).',
unexpectedSemi: 'Unexpected separator (;).',
expectedComma: 'Expected a comma.',
expectedSemi: 'Expected a semicolon.',
},
schema: [
{
type: 'object',
properties: Object.assign({}, definition.properties, {
overrides: {
type: 'object',
properties: {
interface: definition,
typeLiteral: definition,
},
additionalProperties: false,
},
}),
additionalProperties: false,
},
],
},
defaultOptions: [
{
multiline: {
delimiter: 'semi',
requireLast: true,
},
singleline: {
delimiter: 'semi',
requireLast: false,
},
},
],
create(context, [options]) {
const sourceCode = context.getSourceCode();
// use the base options as the defaults for the cases
const baseOptions = options;
const overrides = baseOptions.overrides || {};
const interfaceOptions: BaseOptions = util.deepMerge(
baseOptions,
overrides.interface,
);
const typeLiteralOptions: BaseOptions = util.deepMerge(
baseOptions,
overrides.typeLiteral,
);
/**
* Check the last token in the given member.
* @param member the member to be evaluated.
* @param opts the options to be validated.
* @param isLast a flag indicating `member` is the last in the interface or type literal.
*/
function checkLastToken(
member: TSESTree.TypeElement,
opts: TypeOptions,
isLast: boolean,
): void {
/**
* Resolves the boolean value for the given setting enum value
* @param type the option name
*/
function getOption(type: Delimiter): boolean {
if (isLast && !opts.requireLast) {
// only turn the option on if its expecting no delimiter for the last member
return type === 'none';
}
return opts.delimiter === type;
}
let messageId: MessageIds | null = null;
let missingDelimiter = false;
const lastToken = sourceCode.getLastToken(member, {
includeComments: false,
});
if (!lastToken) {
return;
}
const optsSemi = getOption('semi');
const optsComma = getOption('comma');
const optsNone = getOption('none');
if (lastToken.value === ';') {
if (optsComma) {
messageId = 'expectedComma';
} else if (optsNone) {
missingDelimiter = true;
messageId = 'unexpectedSemi';
}
} else if (lastToken.value === ',') {
if (optsSemi) {
messageId = 'expectedSemi';
} else if (optsNone) {
missingDelimiter = true;
messageId = 'unexpectedComma';
}
} else {
if (optsSemi) {
missingDelimiter = true;
messageId = 'expectedSemi';
} else if (optsComma) {
missingDelimiter = true;
messageId = 'expectedComma';
}
}
if (messageId) {
context.report({
node: lastToken,
loc: {
start: {
line: lastToken.loc.end.line,
column: lastToken.loc.end.column,
},
end: {
line: lastToken.loc.end.line,
column: lastToken.loc.end.column,
},
},
messageId,
fix(fixer) {
if (optsNone) {
// remove the unneeded token
return fixer.remove(lastToken);
}
const token = optsSemi ? ';' : ',';
if (missingDelimiter) {
// add the missing delimiter
return fixer.insertTextAfter(lastToken, token);
}
// correct the current delimiter
return fixer.replaceText(lastToken, token);
},
});
}
}
/**
* Check the member separator being used matches the delimiter.
* @param {ASTNode} node the node to be evaluated.
*/
function checkMemberSeparatorStyle(
node: TSESTree.TSInterfaceBody | TSESTree.TSTypeLiteral,
): void {
const isSingleLine = node.loc.start.line === node.loc.end.line;
const members =
node.type === AST_NODE_TYPES.TSInterfaceBody ? node.body : node.members;
const typeOpts =
node.type === AST_NODE_TYPES.TSInterfaceBody
? interfaceOptions
: typeLiteralOptions;
const opts = isSingleLine ? typeOpts.singleline : typeOpts.multiline;
members.forEach((member, index) => {
checkLastToken(member, opts || {}, index === members.length - 1);
});
}
return {
TSInterfaceBody: checkMemberSeparatorStyle,
TSTypeLiteral: checkMemberSeparatorStyle,
};
},
});