/
plugins.test.js
344 lines (278 loc) · 10.3 KB
/
plugins.test.js
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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
'use strict';
const path = require('path');
const postcss = require('postcss');
const stylelint = require('..');
const safeChdir = require('../testUtils/safeChdir');
const cssWithFoo = '.foo {}';
const cssWithoutFoo = '.bar {}';
const cssWithFooAndBar = '.foo {}\n.bar {}';
const configRelative = {
plugins: ['./fixtures/plugin-warn-about-foo'],
rules: {
'plugin/warn-about-foo': 'always',
'block-no-empty': true,
},
};
const configAbsolute = {
plugins: [path.join(__dirname, './fixtures/plugin-warn-about-foo')],
rules: {
'plugin/warn-about-foo': 'always',
'block-no-empty': true,
},
};
const configExtendRelative = {
extends: ['./fixtures/config-relative-plugin'],
};
const configRelativeAndExtendRelative = {
extends: ['./fixtures/config-relative-plugin'],
plugins: ['./fixtures/plugin-warn-about-bar'],
rules: {
'plugin/warn-about-bar': 'always',
},
};
const configPluginRequire = {
plugins: [require('./fixtures/plugin-warn-about-foo')],
rules: {
'plugin/warn-about-foo': 'always',
'block-no-empty': true,
},
};
const processorRelative = postcss().use(
stylelint({ config: configRelative, configBasedir: __dirname }),
);
const processorAbsolute = postcss().use(stylelint({ config: configAbsolute }));
const processorExtendRelative = postcss().use(
stylelint({ config: configExtendRelative, configBasedir: __dirname }),
);
const processorRelativeAndExtendRelative = postcss().use(
stylelint({
config: configRelativeAndExtendRelative,
configBasedir: __dirname,
}),
);
const processorPluginRequire = postcss().use(stylelint({ config: configPluginRequire }));
it('one plugin runs', async () => {
const result = await processorRelative.process(cssWithFoo, { from: undefined });
expect(result.warnings()).toHaveLength(2);
expect(result.warnings()[0].text).toBe('found .foo (plugin/warn-about-foo)');
expect(result.warnings()[0].node).toBeTruthy();
});
it('another plugin runs', async () => {
const result = await processorRelative.process(cssWithoutFoo, { from: undefined });
expect(result.warnings()).toHaveLength(1);
expect(result.warnings()[0].text).toBe('Unexpected empty block (block-no-empty)');
});
it('plugin with rule metadata', async () => {
const result = await processorRelative.process(cssWithFoo, { from: undefined });
expect(result.stylelint).toHaveProperty('ruleMetadata', {
'plugin/warn-about-foo': {
url: 'https://github.com/stylelint/stylelint-foo-plugin/warn-about-foo',
},
'block-no-empty': {
url: expect.stringMatching(/block-no-empty/),
},
});
});
it('plugin with absolute path and no configBasedir', async () => {
const result = await processorAbsolute.process(cssWithFoo, { from: undefined });
expect(result.warnings()).toHaveLength(2);
expect(result.warnings()[0].text).toBe('found .foo (plugin/warn-about-foo)');
expect(result.warnings()[0].node).toBeTruthy();
});
it('config extending another config that invokes a plugin with a relative path', async () => {
const result = await processorExtendRelative.process(cssWithFoo, { from: undefined });
expect(result.warnings()).toHaveLength(1);
expect(result.warnings()[0].text).toBe('found .foo (plugin/warn-about-foo)');
expect(result.warnings()[0].node).toBeTruthy();
});
it('config with its own plugins extending another config that invokes a plugin with a relative path', async () => {
const result = await processorRelativeAndExtendRelative.process(cssWithFooAndBar, {
from: undefined,
});
expect(result.warnings()).toHaveLength(2);
expect(result.warnings()[0].text).toBe('found .bar (plugin/warn-about-bar)');
expect(result.warnings()[1].text).toBe('found .foo (plugin/warn-about-foo)');
expect(result.warnings()[0].node).toBeTruthy();
});
it('plugin with CJS require()', async () => {
const result = await processorPluginRequire.process(cssWithFoo, { from: undefined });
expect(result.warnings()).toHaveLength(2);
expect(result.warnings()[0].text).toBe('found .foo (plugin/warn-about-foo)');
expect(result.warnings()[1].text).toBe('Unexpected empty block (block-no-empty)');
expect(result.warnings()[0].node).toBeTruthy();
});
it('plugin with ESM import()', async () => {
const result = await postcss()
.use(
stylelint({
config: {
// Following object mocks `await import()` style imports, since
// jest without node --experimental-vm-modules enabled fails to
// support dynamic ESM imports.
plugins: [{ default: require('./fixtures/plugin-warn-about-foo') }], // Similar to `await import()`
rules: {
'plugin/warn-about-foo': 'always',
'block-no-empty': true,
},
},
}),
)
.process(cssWithFoo, { from: undefined });
expect(result.warnings()).toHaveLength(2);
expect(result.warnings()[0].text).toBe('found .foo (plugin/warn-about-foo)');
expect(result.warnings()[1].text).toBe('Unexpected empty block (block-no-empty)');
expect(result.warnings()[0].node).toBeTruthy();
});
describe('plugin using exposed rules via stylelint.rules', () => {
const cssWithDirectiveLower = '/** @@check-color-hex-case */ a { color: #eee; }';
const cssWithDirectiveUpper = '/** @@check-color-hex-case */ a { color: #EEE; }';
const cssWithoutDirectiveLower = 'a { color: #eee; }';
const cssWithoutDirectiveUpper = 'a { color: #EEE; }';
const config = (expectation) => ({
config: {
plugins: [path.join(__dirname, 'fixtures/plugin-conditionally-check-color-hex-case')],
rules: {
'plugin/conditionally-check-color-hex-case': expectation,
},
},
});
it('with uppercase expectation and lowercase color', async () => {
const result = await postcss()
.use(stylelint(config('upper')))
.process(cssWithDirectiveLower, { from: undefined });
expect(result.warnings()).toHaveLength(1);
expect(result.warnings()[0].text).toBe('Expected "#eee" to be "#EEE" (color-hex-case)');
});
it('with uppercase expectation and uppercase color', async () => {
const result = await postcss()
.use(stylelint(config('upper')))
.process(cssWithDirectiveUpper, { from: undefined });
expect(result.warnings()).toHaveLength(0);
});
it('with lowercase expectation and uppercase color', async () => {
const result = await postcss()
.use(stylelint(config('lower')))
.process(cssWithDirectiveUpper, { from: undefined });
expect(result.warnings()).toHaveLength(1);
expect(result.warnings()[0].text).toBe('Expected "#EEE" to be "#eee" (color-hex-case)');
});
it('with lowercase expectation and lowercase color', async () => {
const result = await postcss()
.use(stylelint(config('lower')))
.process(cssWithDirectiveLower, { from: undefined });
expect(result.warnings()).toHaveLength(0);
});
it('with uppercase expectation and lowercase color without directive', async () => {
const result = await postcss()
.use(stylelint(config('upper')))
.process(cssWithoutDirectiveLower, { from: undefined });
expect(result.warnings()).toHaveLength(0);
});
it('with uppercase expectation and uppercase color without directive', async () => {
const result = await postcss()
.use(stylelint(config('lower')))
.process(cssWithoutDirectiveUpper, { from: undefined });
expect(result.warnings()).toHaveLength(0);
});
});
describe('module providing an array of plugins', () => {
const config = {
plugins: [path.join(__dirname, 'fixtures/plugin-array')],
rules: {
'plugin/conditionally-check-color-hex-case': 'upper',
'plugin/warn-about-foo': 'always',
},
};
it('first plugin works', async () => {
const result = await postcss()
.use(stylelint(config))
.process('@@check-color-hex-case a { color: #eee; }', { from: undefined });
expect(result.warnings()).toHaveLength(1);
expect(result.warnings()[0].text).toBe('Expected "#eee" to be "#EEE" (color-hex-case)');
});
it('second plugin works', async () => {
const result = await postcss().use(stylelint(config)).process('.foo {}', { from: undefined });
expect(result.warnings()).toHaveLength(1);
expect(result.warnings()[0].text).toBe('found .foo (plugin/warn-about-foo)');
});
});
it('slashless plugin causes configuration error', async () => {
const config = {
plugins: [path.join(__dirname, 'fixtures/plugin-slashless-warn-about-foo')],
rules: {
'slashless-warn-about-foo': true,
},
};
await expect(
postcss().use(stylelint(config)).process('.foo {}', { from: undefined }),
).rejects.toThrow(/^stylelint requires plugin rules to be namespaced/);
});
it('plugin with primary option array', async () => {
const config = {
plugins: [path.join(__dirname, 'fixtures/plugin-primary-array')],
rules: {
'plugin/primary-array': ['foo', 'bar'],
},
};
const result = await postcss().use(stylelint(config)).process('a {}', { from: undefined });
expect(result.warnings()).toHaveLength(0);
});
it('plugin with primary option array within options array', async () => {
const config = {
plugins: [path.join(__dirname, 'fixtures/plugin-primary-array')],
rules: {
'plugin/primary-array': [['foo', 'bar'], { something: true }],
},
};
const result = await postcss().use(stylelint(config)).process('a {}', { from: undefined });
expect(result.warnings()).toHaveLength(0);
});
it('plugin with async rule', async () => {
const config = {
plugins: [path.join(__dirname, 'fixtures/plugin-async')],
rules: {
'plugin/async': true,
},
};
const result = await postcss().use(stylelint(config)).process('a {}', { from: undefined });
expect(result.warnings()).toHaveLength(1);
});
describe('loading a plugin from process.cwd', () => {
safeChdir(__dirname);
let result;
const config = {
plugins: ['./fixtures/plugin-warn-about-foo'],
rules: {
'plugin/warn-about-foo': 'always',
},
};
beforeEach(async () => {
result = await postcss().use(stylelint(config)).process('.foo {}', { from: undefined });
});
it('error is caught', () => {
expect(result.warnings()).toHaveLength(1);
});
it('error is correct', () => {
expect(result.warnings()[0].rule).toBe('plugin/warn-about-foo');
});
});
describe('loading a plugin from options.cwd', () => {
let result;
const config = {
plugins: ['./fixtures/plugin-warn-about-foo'],
rules: {
'plugin/warn-about-foo': 'always',
},
};
beforeEach(async () => {
result = await postcss()
.use(stylelint({ cwd: __dirname, config }))
.process('.foo {}', { from: undefined });
});
it('error is caught', () => {
expect(result.warnings()).toHaveLength(1);
});
it('error is correct', () => {
expect(result.warnings()[0].rule).toBe('plugin/warn-about-foo');
});
});