forked from typescript-eslint/typescript-eslint
/
space-before-blocks.ts
102 lines (93 loc) · 3.18 KB
/
space-before-blocks.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
import { TSESTree } from '@typescript-eslint/experimental-utils';
import { getESLintCoreRule } from '../util/getESLintCoreRule';
import * as util from '../util';
const baseRule = getESLintCoreRule('space-before-blocks');
export type Options = util.InferOptionsTypeFromRule<typeof baseRule>;
export type MessageIds = util.InferMessageIdsTypeFromRule<typeof baseRule>;
export default util.createRule<Options, MessageIds>({
name: 'space-before-blocks',
meta: {
type: 'layout',
docs: {
description: 'enforce consistent spacing before blocks.',
recommended: false,
extendsBaseRule: true,
},
fixable: baseRule.meta.fixable,
hasSuggestions: baseRule.meta.hasSuggestions,
schema: baseRule.meta.schema,
messages: {
// @ts-expect-error -- we report on this messageId so we need to ensure it's there in case ESLint changes in future
unexpectedSpace: 'Unexpected space before opening brace.',
// @ts-expect-error -- we report on this messageId so we need to ensure it's there in case ESLint changes in future
missingSpace: 'Missing space before opening brace.',
...baseRule.meta.messages,
},
},
defaultOptions: ['always'],
create(context) {
const rules = baseRule.create(context);
const config = context.options[0];
const sourceCode = context.getSourceCode();
let alwaysClasses = true,
neverClasses = false;
if (typeof config === 'object') {
alwaysClasses = config.classes === 'always';
neverClasses = config.classes === 'never';
} else if (config === 'never') {
alwaysClasses = false;
neverClasses = true;
}
function checkPrecedingSpace(
node:
| TSESTree.Token
| TSESTree.TSInterfaceBody
| TSESTree.PunctuatorToken,
) {
const precedingToken = sourceCode.getTokenBefore(node);
if (
precedingToken &&
util.isTokenOnSameLine(precedingToken, node as TSESTree.Token)
) {
const hasSpace = sourceCode.isSpaceBetweenTokens(
precedingToken,
node as TSESTree.Token,
);
// this is a bit odd, but keeps the same code style as in the base rule in case we'd have to cover other options in the future
const requireSpace = alwaysClasses;
const requireNoSpace = neverClasses;
if (requireSpace && !hasSpace) {
context.report({
node,
messageId: 'missingSpace',
fix(fixer) {
return fixer.insertTextBefore(node, ' ');
},
});
} else if (requireNoSpace && hasSpace) {
context.report({
node,
messageId: 'unexpectedSpace',
fix(fixer) {
return fixer.removeRange([
precedingToken.range[1],
node.range[0],
]);
},
});
}
}
}
function checkSpaceAfterEnum(node: TSESTree.TSEnumDeclaration) {
const punctuator = sourceCode.getTokenAfter(node.id);
if (punctuator) {
checkPrecedingSpace(punctuator);
}
}
return {
...rules,
TSEnumDeclaration: checkSpaceAfterEnum,
TSInterfaceBody: checkPrecedingSpace,
};
},
});