/
keyword-spacing.test.ts
194 lines (184 loc) · 6.17 KB
/
keyword-spacing.test.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
/* eslint-disable eslint-comments/no-use */
// this rule tests the spacing, which prettier will want to fix and break the tests
/* eslint "@typescript-eslint/internal/plugin-test-formatting": ["error", { formatWithPrettier: false }] */
/* eslint-enable eslint-comments/no-use */
import type { TSESLint } from '@typescript-eslint/utils';
import type { MessageIds, Options } from '../../src/rules/keyword-spacing';
import rule from '../../src/rules/keyword-spacing';
import { RuleTester } from '../RuleTester';
//------------------------------------------------------------------------------
// Helpers
//------------------------------------------------------------------------------
const BOTH = { before: true, after: true };
const NEITHER = { before: false, after: false };
/**
* Creates an option object to test an 'overrides' option.
*
* e.g.
*
* override('as', BOTH)
*
* returns
*
* {
* before: false,
* after: false,
* overrides: {as: {before: true, after: true}}
* }
* @param keyword A keyword to be overridden.
* @param value A value to override.
* @returns An option object to test an 'overrides' option.
*/
function overrides(keyword: string, value: Options[0]): Options[0] {
return {
before: value.before === false,
after: value.after === false,
overrides: { [keyword]: value },
};
}
/**
* Gets an error message that expected space(s) before a specified keyword.
* @param keyword A keyword.
* @returns An error message.
*/
function expectedBefore(keyword: string): TSESLint.TestCaseError<MessageIds>[] {
return [{ messageId: 'expectedBefore', data: { value: keyword } }];
}
/**
* Gets an error message that expected space(s) after a specified keyword.
* @param keyword A keyword.
* @returns An error message.
*/
function expectedAfter(keyword: string): TSESLint.TestCaseError<MessageIds>[] {
return [{ messageId: 'expectedAfter', data: { value: keyword } }];
}
/**
* Gets an error message that unexpected space(s) before a specified keyword.
* @param keyword A keyword.
* @returns An error message.
*/
function unexpectedBefore(
keyword: string,
): TSESLint.TestCaseError<MessageIds>[] {
return [{ messageId: 'unexpectedBefore', data: { value: keyword } }];
}
/**
* Gets an error message that unexpected space(s) after a specified keyword.
* @param keyword A keyword.
* @returns An error message.
*/
function unexpectedAfter(
keyword: string,
): TSESLint.TestCaseError<MessageIds>[] {
return [{ messageId: 'unexpectedAfter', data: { value: keyword } }];
}
const ruleTester = new RuleTester({
parser: '@typescript-eslint/parser',
});
ruleTester.run('keyword-spacing', rule, {
valid: [
//----------------------------------------------------------------------
// as (typing)
//----------------------------------------------------------------------
{
code: 'const foo = {} as {};',
parserOptions: { ecmaVersion: 6, sourceType: 'module' },
},
{
code: 'const foo = {}as{};',
options: [NEITHER],
parserOptions: { ecmaVersion: 6, sourceType: 'module' },
},
{
code: 'const foo = {} as {};',
options: [overrides('as', BOTH)],
parserOptions: { ecmaVersion: 6, sourceType: 'module' },
},
{
code: 'const foo = {}as{};',
options: [overrides('as', NEITHER)],
parserOptions: { ecmaVersion: 6, sourceType: 'module' },
},
{
code: 'const foo = {} as {};',
options: [{ overrides: { as: {} } }],
parserOptions: { ecmaVersion: 6, sourceType: 'module' },
},
{
code: 'import type { foo } from "foo";',
options: [{ overrides: { as: {} } }],
parserOptions: { ecmaVersion: 6, sourceType: 'module' },
},
{
code: "import type * as Foo from 'foo'",
options: [{ overrides: { as: {} } }],
parserOptions: { ecmaVersion: 6, sourceType: 'module' },
},
],
invalid: [
//----------------------------------------------------------------------
// as (typing)
//----------------------------------------------------------------------
{
code: 'const foo = {}as {};',
output: 'const foo = {} as {};',
parserOptions: { ecmaVersion: 6, sourceType: 'module' },
errors: expectedBefore('as'),
},
{
code: 'const foo = {} as{};',
output: 'const foo = {}as{};',
options: [NEITHER],
parserOptions: { ecmaVersion: 6, sourceType: 'module' },
errors: unexpectedBefore('as'),
},
{
code: 'const foo = {} as{};',
output: 'const foo = {} as {};',
parserOptions: { ecmaVersion: 6, sourceType: 'module' },
errors: expectedAfter('as'),
},
{
code: 'const foo = {}as {};',
output: 'const foo = {}as{};',
options: [NEITHER],
parserOptions: { ecmaVersion: 6, sourceType: 'module' },
errors: unexpectedAfter('as'),
},
{
code: 'const foo = {} as{};',
output: 'const foo = {} as {};',
options: [{ overrides: { as: {} } }],
parserOptions: { ecmaVersion: 6, sourceType: 'module' },
errors: expectedAfter('as'),
},
{
code: 'import type{ foo } from "foo";',
output: 'import type { foo } from "foo";',
options: [{ after: true, before: true }],
parserOptions: { ecmaVersion: 6, sourceType: 'module' },
errors: [{ messageId: 'expectedBefore', data: { value: '{' } }],
},
{
code: 'import type { foo } from"foo";',
output: 'import type{ foo } from"foo";',
options: [{ after: false, before: true }],
parserOptions: { ecmaVersion: 6, sourceType: 'module' },
errors: [{ messageId: 'unexpectedBefore', data: { value: '{' } }],
},
{
code: 'import type* as foo from "foo";',
output: 'import type * as foo from "foo";',
options: [{ after: true, before: true }],
parserOptions: { ecmaVersion: 6, sourceType: 'module' },
errors: [{ messageId: 'expectedBefore', data: { value: '*' } }],
},
{
code: 'import type * as foo from"foo";',
output: 'import type* as foo from"foo";',
options: [{ after: false, before: true }],
parserOptions: { ecmaVersion: 6, sourceType: 'module' },
errors: [{ messageId: 'unexpectedBefore', data: { value: '*' } }],
},
],
});