Skip to content

Commit 73b90b3

Browse files
XunnamiusXunnamius
committedJan 6, 2023
feat: add support for testing presets
·
v12.0.0-canary.1babel-plugin-tester@11.0.0-canary.1
1 parent be94398 commit 73b90b3

File tree

5 files changed

+336
-161
lines changed

5 files changed

+336
-161
lines changed
 

‎src/index.ts

+32-2
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ if ('expect' in globalThis && typeof expect?.addSnapshotSerializer == 'function'
2121
* @see https://npm.im/babel-plugin-tester#custom-plugin-and-preset-run-order
2222
*/
2323
export const runPluginUnderTestHere: unique symbol = Symbol('run-plugin-under-test-here');
24+
export const runPresetUnderTestHere: unique symbol = Symbol('run-preset-under-test-here');
2425

2526
export {
2627
prettierFormatter,
@@ -146,13 +147,19 @@ export interface PluginTesterOptions {
146147
*
147148
* @see https://npm.im/babel-plugin-tester#babelOptions
148149
*/
149-
babelOptions?: Omit<Babel.TransformOptions, 'plugins'> & {
150+
babelOptions?: Omit<Babel.TransformOptions, 'plugins' | 'presets'> & {
150151
plugins?:
151152
| (
152153
| NonNullable<Babel.TransformOptions['plugins']>[number]
153154
| typeof runPluginUnderTestHere
154155
)[]
155156
| null;
157+
presets?:
158+
| (
159+
| NonNullable<Babel.TransformOptions['presets']>[number]
160+
| typeof runPresetUnderTestHere
161+
)[]
162+
| null;
156163
};
157164
/**
158165
* This is a `pluginTester` option used to specify a custom title for the
@@ -756,8 +763,31 @@ export type PluginTesterBaseConfig = (
756763
tests: NonNullable<PluginTesterOptions['tests']>;
757764
};
758765

766+
type DynamicProperties =
767+
| 'plugin'
768+
| 'pluginName'
769+
| 'basePluginOptions'
770+
| 'preset'
771+
| 'presetName'
772+
| 'basePresetOptions'
773+
| 'describeBlockTitle';
774+
775+
/**
776+
* An internal type describing a partially-resolved base configuration.
777+
*
778+
* @internal
779+
*/
780+
export type PartialPluginTesterBaseConfig = Omit<
781+
PluginTesterBaseConfig,
782+
DynamicProperties
783+
> &
784+
Partial<Pick<PluginTesterBaseConfig, DynamicProperties>>;
785+
759786
type PluginTesterSharedTestConfigProperties = {
760-
babelOptions: Babel.TransformOptions;
787+
babelOptions: Omit<Babel.TransformOptions, 'plugins' | 'presets'> & {
788+
plugins: NonNullable<Babel.TransformOptions['plugins']>;
789+
presets: NonNullable<Babel.TransformOptions['presets']>;
790+
};
761791
testBlockTitle: NonNullable<TestObject['title'] | FixtureOptions['title']>;
762792
only?: TestObject['only'] | FixtureOptions['only'];
763793
skip?: TestObject['skip'] | FixtureOptions['skip'];

‎src/plugin-tester.ts

+172-120
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,10 @@ import mergeWith from 'lodash.mergewith';
88
import stripIndent from 'strip-indent';
99

1010
import { $type } from './symbols';
11+
1112
import {
1213
runPluginUnderTestHere,
14+
runPresetUnderTestHere,
1315
type ResultFormatter,
1416
type PluginTesterOptions,
1517
type TestObject,
@@ -20,7 +22,8 @@ import {
2022
type PluginTesterTestFixtureConfig,
2123
type PluginTesterTestObjectConfig,
2224
type MaybePluginTesterTestObjectConfig,
23-
type MaybePluginTesterTestFixtureConfig
25+
type MaybePluginTesterTestFixtureConfig,
26+
type PartialPluginTesterBaseConfig
2427
} from '.';
2528

2629
import type { Class } from 'type-fest';
@@ -91,27 +94,22 @@ export function pluginTester(options: PluginTesterOptions = {}) {
9194
mergeCustomizer
9295
);
9396

94-
// TODO: implement support for preset testing configuration
95-
96-
// ? Need to do this here instead of in the validation function since plugin
97-
// name inference relies on plugin being defined
98-
if (!rawBaseConfig.plugin) {
99-
throw new TypeError('plugin is a required parameter');
97+
if (
98+
(rawBaseConfig.plugin &&
99+
(rawBaseConfig.preset ||
100+
rawBaseConfig.presetName ||
101+
rawBaseConfig.presetOptions)) ||
102+
(rawBaseConfig.preset &&
103+
(rawBaseConfig.plugin || rawBaseConfig.pluginName || rawBaseConfig.pluginOptions))
104+
) {
105+
throw new Error(
106+
'failed to validate configuration: cannot test a plugin and a preset simultaneously. Specify one set of options or the other'
107+
);
100108
}
101109

102-
const pluginName =
103-
rawBaseConfig.pluginName || tryInferPluginName() || 'unknown plugin';
104-
105-
const baseConfig = {
106-
plugin: rawBaseConfig.plugin,
107-
pluginName,
108-
basePluginOptions: rawBaseConfig.pluginOptions || {},
109-
preset: undefined,
110-
presetName: undefined,
111-
basePresetOptions: undefined,
110+
const baseConfig: PartialPluginTesterBaseConfig = {
112111
babel: rawBaseConfig.babel || require('@babel/core'),
113112
baseBabelOptions: rawBaseConfig.babelOptions,
114-
describeBlockTitle: rawBaseConfig.title ?? pluginName,
115113
// TODO: implement default filepath inference using Error stack trace
116114
filepath: rawBaseConfig.filepath ?? rawBaseConfig.filename,
117115
endOfLine: rawBaseConfig.endOfLine,
@@ -125,7 +123,25 @@ export function pluginTester(options: PluginTesterOptions = {}) {
125123
tests: rawBaseConfig.tests || []
126124
};
127125

128-
return baseConfig;
126+
if (rawBaseConfig.plugin) {
127+
baseConfig.plugin = rawBaseConfig.plugin;
128+
baseConfig.pluginName =
129+
rawBaseConfig.pluginName || tryInferPluginName() || 'unknown plugin';
130+
baseConfig.basePluginOptions = rawBaseConfig.pluginOptions || {};
131+
} else if (rawBaseConfig.preset) {
132+
baseConfig.preset = rawBaseConfig.preset;
133+
baseConfig.presetName = rawBaseConfig.presetName || 'unknown preset';
134+
baseConfig.basePresetOptions = rawBaseConfig.presetOptions;
135+
} else {
136+
throw new TypeError(
137+
'failed to validate configuration: must provide either `plugin` or `preset` option'
138+
);
139+
}
140+
141+
baseConfig.describeBlockTitle =
142+
rawBaseConfig.title ?? baseConfig.pluginName ?? baseConfig.presetName;
143+
144+
return baseConfig as PluginTesterBaseConfig;
129145

130146
function tryInferPluginName() {
131147
try {
@@ -298,7 +314,8 @@ export function pluginTester(options: PluginTesterOptions = {}) {
298314
const {
299315
plugin,
300316
basePluginOptions,
301-
// TODO: use this preset, TODO: use this basePresetOptions,
317+
preset,
318+
basePresetOptions,
302319
baseBabelOptions,
303320
endOfLine,
304321
baseFormatResult,
@@ -309,7 +326,7 @@ export function pluginTester(options: PluginTesterOptions = {}) {
309326
const {
310327
babelOptions,
311328
pluginOptions,
312-
// TODO: use this presetOptions,
329+
presetOptions,
313330
title,
314331
only,
315332
skip,
@@ -363,16 +380,6 @@ export function pluginTester(options: PluginTesterOptions = {}) {
363380
},
364381
{ babelOptions },
365382
{
366-
babelOptions: {
367-
// ? Ensure `localOptions` comes before `babelOptions.plugins` ?
368-
// to preserve default plugin run order
369-
plugins: [
370-
[
371-
plugin,
372-
mergeWith({}, basePluginOptions, pluginOptions, mergeCustomizer)
373-
]
374-
]
375-
},
376383
testBlockTitle: `${currentTestNumber++}. ${title || blockTitle}`,
377384
only,
378385
skip,
@@ -388,17 +395,28 @@ export function pluginTester(options: PluginTesterOptions = {}) {
388395
exec,
389396
execFixture: execPath
390397
},
398+
// ? This is last to ensure plugins/presets babelOptions are arrays
399+
{ babelOptions: { plugins: [], presets: [] } },
391400
mergeCustomizer
392401
);
393402

403+
if (plugin) {
404+
testConfig.babelOptions.plugins.push([
405+
plugin,
406+
mergeWith({}, basePluginOptions, pluginOptions, mergeCustomizer)
407+
]);
408+
} else {
409+
testConfig.babelOptions.presets.unshift([
410+
preset,
411+
mergeWith({}, basePresetOptions, presetOptions, mergeCustomizer)
412+
]);
413+
}
414+
394415
finalizePluginAndPresetRunOrder(testConfig.babelOptions);
395-
// ? Ensures we have an actual PluginTesterTestFixtureConfig object
396416
validateTestConfig(testConfig);
397417
hasTests = true;
398418

399-
(parentDescribeConfig?.tests || testConfigs).push(
400-
testConfig as PluginTesterTestFixtureConfig
401-
);
419+
(parentDescribeConfig?.tests || testConfigs).push(testConfig);
402420
}
403421
});
404422
}
@@ -412,8 +430,9 @@ export function pluginTester(options: PluginTesterOptions = {}) {
412430
plugin,
413431
pluginName,
414432
basePluginOptions,
415-
// TODO: use this preset, TODO: use this presetName, TODO: use this
416-
//basePresetOptions,
433+
preset,
434+
presetName,
435+
basePresetOptions,
417436
baseBabelOptions,
418437
endOfLine,
419438
baseFormatResult,
@@ -423,7 +442,7 @@ export function pluginTester(options: PluginTesterOptions = {}) {
423442
const {
424443
babelOptions,
425444
pluginOptions,
426-
// TODO: use this presetOptions,
445+
presetOptions,
427446
title,
428447
only,
429448
skip,
@@ -466,14 +485,7 @@ export function pluginTester(options: PluginTesterOptions = {}) {
466485
{ babelOptions },
467486
{
468487
snapshot: snapshot ?? baseSnapshot,
469-
// ? Ensure `rawFixtureConfig` comes before ? `babelOptions.plugins`
470-
// to preserve default plugin run order
471-
babelOptions: {
472-
plugins: [
473-
[plugin, mergeWith({}, basePluginOptions, pluginOptions, mergeCustomizer)]
474-
]
475-
},
476-
testBlockTitle: `${currentTestNumber++}. ${title || pluginName}`,
488+
testBlockTitle: `${currentTestNumber++}. ${title || pluginName || presetName}`,
477489
only,
478490
skip,
479491
expectedError: throws ?? error,
@@ -491,15 +503,28 @@ export function pluginTester(options: PluginTesterOptions = {}) {
491503
exec: exec ? trimAndFixLineEndings(exec, endOfLine) : undefined,
492504
execFixture
493505
},
506+
// ? This is last to ensure plugins/presets babelOptions are arrays
507+
{ babelOptions: { plugins: [], presets: [] } },
494508
mergeCustomizer
495509
);
496510

511+
if (plugin) {
512+
testConfig.babelOptions.plugins.push([
513+
plugin,
514+
mergeWith({}, basePluginOptions, pluginOptions, mergeCustomizer)
515+
]);
516+
} else {
517+
testConfig.babelOptions.presets.unshift([
518+
preset,
519+
mergeWith({}, basePresetOptions, presetOptions, mergeCustomizer)
520+
]);
521+
}
522+
497523
finalizePluginAndPresetRunOrder(testConfig.babelOptions);
498-
// ? Ensures we have an actual PluginTesterTestObjectConfig object
499524
validateTestConfig(testConfig);
500525
hasTests = true;
501526

502-
return testConfig as PluginTesterTestObjectConfig;
527+
return testConfig;
503528
}
504529
}
505530

@@ -725,29 +750,29 @@ export function pluginTester(options: PluginTesterOptions = {}) {
725750
expectedError
726751
} = testConfig;
727752

728-
if (testConfig[$type] == 'test-object' && testConfig.snapshot) {
753+
if (testConfig[$type] == 'test-object' && testConfig.snapshot) {
729754
if (!globalContextExpectFnHasToMatchSnapshot) {
730755
throwTypeError(
731756
'testing environment does not support `expect(...).toMatchSnapshot` method'
732757
);
733-
}
758+
}
734759

735-
if (output) {
736-
throwTypeError(
737-
'neither `output` nor `outputFixture` can be provided with `snapshot` enabled'
738-
);
739-
}
760+
if (output) {
761+
throwTypeError(
762+
'neither `output` nor `outputFixture` can be provided with `snapshot` enabled'
763+
);
764+
}
740765

741-
if (exec) {
742-
throwTypeError(
743-
'neither `exec` nor `execFixture` can be provided with `snapshot` enabled'
744-
);
766+
if (exec) {
767+
throwTypeError(
768+
'neither `exec` nor `execFixture` can be provided with `snapshot` enabled'
769+
);
770+
}
745771
}
746-
}
747772

748-
if (skip && only) {
749-
throwTypeError('cannot enable both `skip` and `only` in the same test');
750-
}
773+
if (skip && only) {
774+
throwTypeError('cannot enable both `skip` and `only` in the same test');
775+
}
751776

752777
if (skip && !globalContextTestFnHasSkip) {
753778
throwTypeError('testing environment does not support `it.skip(...)` method');
@@ -757,62 +782,62 @@ export function pluginTester(options: PluginTesterOptions = {}) {
757782
throwTypeError('testing environment does not support `it.only(...)` method');
758783
}
759784

760-
if (output && expectedError !== undefined) {
761-
throwTypeError(
762-
testConfig[$type] == 'test-object'
763-
? 'neither `output` nor `outputFixture` can be provided with `throws` or `error`'
764-
: 'a fixture cannot be provided with `throws` or `error` and also contain an output file'
765-
);
766-
}
785+
if (output && expectedError !== undefined) {
786+
throwTypeError(
787+
testConfig[$type] == 'test-object'
788+
? 'neither `output` nor `outputFixture` can be provided with `throws` or `error`'
789+
: 'a fixture cannot be provided with `throws` or `error` and also contain an output file'
790+
);
791+
}
767792

768-
if (exec && expectedError !== undefined) {
769-
``;
770-
throwTypeError(
771-
testConfig[$type] == 'test-object'
772-
? 'neither `exec` nor `execFixture` can be provided with `throws` or `error`'
773-
: 'a fixture cannot be provided with `throws` or `error` and also contain an exec file'
774-
);
775-
}
793+
if (exec && expectedError !== undefined) {
794+
``;
795+
throwTypeError(
796+
testConfig[$type] == 'test-object'
797+
? 'neither `exec` nor `execFixture` can be provided with `throws` or `error`'
798+
: 'a fixture cannot be provided with `throws` or `error` and also contain an exec file'
799+
);
800+
}
776801

777-
if (!code && !exec) {
778-
throwTypeError(
779-
testConfig[$type] == 'test-object'
780-
? 'a string or object with a `code`, `codeFixture`, `exec`, or `execFixture` must be provided'
781-
: 'a fixture must contain either a code file or an exec file'
782-
);
783-
}
802+
if (!code && !exec) {
803+
throwTypeError(
804+
testConfig[$type] == 'test-object'
805+
? 'a string or object with a `code`, `codeFixture`, `exec`, or `execFixture` must be provided'
806+
: 'a fixture must contain either a code file or an exec file'
807+
);
808+
}
784809

785-
if (!!(code || output) && !!exec) {
786-
throwTypeError(
787-
testConfig[$type] == 'test-object'
788-
? 'neither `code`, `codeFixture`, `output`, nor `outputFixture` can be provided with `exec` or `execFixture`'
789-
: 'a fixture cannot contain both an exec file and a code or output file'
790-
);
791-
}
810+
if (!!(code || output) && !!exec) {
811+
throwTypeError(
812+
testConfig[$type] == 'test-object'
813+
? 'neither `code`, `codeFixture`, `output`, nor `outputFixture` can be provided with `exec` or `execFixture`'
814+
: 'a fixture cannot contain both an exec file and a code or output file'
815+
);
816+
}
792817

793-
if (babelOptions.babelrc && !babelOptions.filename) {
794-
throwTypeError(
795-
'`babelOptions.babelrc` is enabled but `babelOptions.filename` was not provided'
796-
);
797-
}
818+
if (babelOptions.babelrc && !babelOptions.filename) {
819+
throwTypeError(
820+
'`babelOptions.babelrc` is enabled but `babelOptions.filename` was not provided'
821+
);
822+
}
798823

799-
if (
800-
expectedError &&
801-
!(
802-
['function', 'boolean', 'string'].includes(typeof expectedError) ||
803-
expectedError instanceof RegExp
804-
)
805-
) {
806-
throwTypeError(
807-
'`throws`/`error` must be a function, string, boolean, RegExp, or Error subtype'
808-
);
809-
}
824+
if (
825+
expectedError &&
826+
!(
827+
['function', 'boolean', 'string'].includes(typeof expectedError) ||
828+
expectedError instanceof RegExp
829+
)
830+
) {
831+
throwTypeError(
832+
'`throws`/`error` must be a function, string, boolean, RegExp, or Error subtype'
833+
);
834+
}
810835

811-
function throwTypeError(message: string) {
812-
throw new TypeError(
813-
`failed to validate configuration for test "${testBlockTitle}": ${message}`
814-
);
815-
}
836+
function throwTypeError(message: string) {
837+
throw new TypeError(
838+
`failed to validate configuration for test "${testBlockTitle}": ${message}`
839+
);
840+
}
816841
}
817842
}
818843

@@ -880,16 +905,43 @@ function trimAndFixLineEndings(
880905
}
881906
}
882907

908+
/**
909+
* Clears out nullish plugin/preset values and replaces symbols with their
910+
* proper values.
911+
*/
883912
function finalizePluginAndPresetRunOrder(
884913
babelOptions: PluginTesterOptions['babelOptions']
885914
) {
886-
if (babelOptions?.plugins?.includes(runPluginUnderTestHere)) {
887-
babelOptions.plugins.splice(
888-
babelOptions.plugins.indexOf(runPluginUnderTestHere),
889-
1,
890-
babelOptions.plugins.pop()!
891-
);
915+
// TODO: debug statements here about replacing symbols and clearing nullish
916+
917+
if (babelOptions?.plugins) {
918+
babelOptions.plugins = babelOptions.plugins.filter((p) => {
919+
// TODO: debug statement here
920+
return Boolean(p);
921+
});
922+
923+
if (babelOptions.plugins.includes(runPluginUnderTestHere)) {
924+
babelOptions.plugins.splice(
925+
babelOptions.plugins.indexOf(runPluginUnderTestHere),
926+
1,
927+
babelOptions.plugins.pop()!
928+
);
929+
}
892930
}
893931

894-
// TODO: also finalize preset run order
932+
if (babelOptions?.presets) {
933+
babelOptions.presets = babelOptions.presets.filter((p) => {
934+
// TODO: debug statement here
935+
return Boolean(p);
936+
});
937+
938+
if (babelOptions.presets.includes(runPresetUnderTestHere)) {
939+
babelOptions.presets.splice(
940+
// ? -1 because we're shifting an element off the beginning afterwards
941+
babelOptions.presets.indexOf(runPresetUnderTestHere) - 1,
942+
1,
943+
babelOptions.presets.shift()!
944+
);
945+
}
946+
}
895947
}

‎test/__snapshots__/plugin-tester.test.ts.snap

+37-1
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,21 @@ exports[`tests targeting the PluginTesterOptions interface throws if \`formatRes
124124
125125
exports[`tests targeting the PluginTesterOptions interface throws if \`formatResult\` throws even if \`throws\` is not \`false\` 2`] = ``;
126126
127-
exports[`tests targeting the PluginTesterOptions interface throws if neither \`plugin\` nor \`preset\` are provided 1`] = `required option is missing: must provide either \`plugin\` or \`preset\``;
127+
exports[`tests targeting the PluginTesterOptions interface throws if both plugin- and preset-specific options are provided 1`] = `failed to validate configuration: cannot test a plugin and a preset simultaneously. Specify one set of options or the other`;
128+
129+
exports[`tests targeting the PluginTesterOptions interface throws if both plugin- and preset-specific options are provided 2`] = `failed to validate configuration: cannot test a plugin and a preset simultaneously. Specify one set of options or the other`;
130+
131+
exports[`tests targeting the PluginTesterOptions interface throws if both plugin- and preset-specific options are provided 3`] = `failed to validate configuration: cannot test a plugin and a preset simultaneously. Specify one set of options or the other`;
132+
133+
exports[`tests targeting the PluginTesterOptions interface throws if both plugin- and preset-specific options are provided 4`] = `failed to validate configuration: cannot test a plugin and a preset simultaneously. Specify one set of options or the other`;
134+
135+
exports[`tests targeting the PluginTesterOptions interface throws if both plugin- and preset-specific options are provided 5`] = `failed to validate configuration: cannot test a plugin and a preset simultaneously. Specify one set of options or the other`;
136+
137+
exports[`tests targeting the PluginTesterOptions interface throws if neither \`plugin\` nor \`preset\` are provided 1`] = `failed to validate configuration: must provide either \`plugin\` or \`preset\` option`;
138+
139+
exports[`tests targeting the PluginTesterOptions interface throws if neither \`plugin\` nor \`preset\` are provided 2`] = `failed to validate configuration: must provide either \`plugin\` or \`preset\` option`;
140+
141+
exports[`tests targeting the PluginTesterOptions interface throws if neither \`plugin\` nor \`preset\` are provided 3`] = `failed to validate configuration: must provide either \`plugin\` or \`preset\` option`;
128142
129143
exports[`tests targeting the PluginTesterOptions interface throws if setup throws 1`] = `1. fixture: setup function failed: bad setup`;
130144
@@ -152,8 +166,28 @@ expected:
152166
var hi = 'hey';
153167
`;
154168
169+
exports[`tests targeting the TestObject interface accepts a string literal \`tests\` array item asserting babel output is unchanged 2`] = `
170+
1. black-box (preset): expected output to not change, but it did
171+
172+
actual:
173+
var ih = 'hey';
174+
175+
expected:
176+
var hi = 'hey';
177+
`;
178+
155179
exports[`tests targeting the TestObject interface can test that \`code\`/\`codeFixture\` and \`output\`/\`outputFixture\` babel output matches 1`] = `actual output does not match expected output`;
156180
181+
exports[`tests targeting the TestObject interface can test that \`code\`/\`codeFixture\` and \`output\`/\`outputFixture\` babel output matches 2`] = `
182+
1. black-box (preset): actual output does not match expected output
183+
184+
actual:
185+
const hello = 'hey';
186+
187+
expected:
188+
const olleh = 'hey';
189+
`;
190+
157191
exports[`tests targeting the TestObject interface can test that \`code\`/\`codeFixture\` babel output is unchanged 1`] = `expected output to not change, but it did`;
158192
159193
exports[`tests targeting the TestObject interface can test that string literal babel output is unchanged 1`] = `expected output to not change, but it did`;
@@ -220,6 +254,8 @@ exports[`tests targeting the TestObject interface throws if both \`snapshot\` an
220254
221255
exports[`tests targeting the TestObject interface throws if both \`snapshot\` and \`throws\` are provided 2`] = `plugin is a required parameter`;
222256
257+
exports[`tests targeting the TestObject interface throws if both \`snapshot\` and \`throws\` are provided: 1. undefined 1`] = ``;
258+
223259
exports[`tests targeting the TestObject interface throws if test object is missing both \`code\` and \`codeFixture\` 1`] = `failed to validate configuration for test "1. captains-log (explicit)": a string or object with a \`code\`, \`codeFixture\`, \`exec\`, or \`execFixture\` must be provided`;
224260
225261
exports[`tests targeting the TestObject interface throws if test object is non-nullish and missing both \`code\` and \`codeFixture\` 1`] = `failed to validate configuration for test "1. captains-log (explicit)": a string or object with a \`code\`, \`codeFixture\`, \`exec\`, or \`execFixture\` must be provided`;

‎test/fixtures/option-presetOptions/fixture/options.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
22
"presetOptions": {
3-
"foo": "bar"
3+
"optionA": false
44
}
55
}

‎test/plugin-tester.test.ts

+94-37
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,15 @@ import { declare } from '@babel/helper-plugin-utils';
1010
import { asMockedFunction } from '@xunnamius/jest-types';
1111

1212
import { withMockedEnv, withMockedOutput } from './setup';
13-
import { type PluginTesterOptions, runPluginUnderTestHere } from '../src/index';
1413
import { prettierFormatter } from '../src/formatters/prettier';
1514
import { unstringSnapshotSerializer } from '../src/serializers/unstring-snapshot';
1615

16+
import {
17+
type PluginTesterOptions,
18+
runPluginUnderTestHere,
19+
runPresetUnderTestHere
20+
} from '../src/index';
21+
1722
import {
1823
deleteVariablesPlugin,
1924
identifierReversePlugin,
@@ -111,15 +116,6 @@ describe('tests targeting the PluginTesterOptions interface', () => {
111116
} finally {
112117
globalThis.it = oldIt;
113118
}
114-
115-
// @ts-expect-error: I'll put it back, I pwomise!
116-
globalThis.it = () => undefined;
117-
118-
try {
119-
await runPluginTesterExpectThrownException();
120-
} finally {
121-
globalThis.it = oldIt;
122-
}
123119
});
124120

125121
it('passes `plugin` to babel', async () => {
@@ -429,27 +425,32 @@ describe('tests targeting the PluginTesterOptions interface', () => {
429425

430426
await runPluginTesterExpectThrownException({
431427
plugin: getDummyPluginOptions().plugin,
432-
preset: getDummyPresetOptions().preset
428+
preset: getDummyPresetOptions().preset,
429+
tests: [simpleTest]
433430
});
434431

435432
await runPluginTesterExpectThrownException({
436433
plugin: getDummyPluginOptions().plugin,
437-
presetName: getDummyPresetOptions().presetName
434+
presetName: getDummyPresetOptions().presetName,
435+
tests: [simpleTest]
438436
});
439437

440438
await runPluginTesterExpectThrownException({
441439
plugin: getDummyPluginOptions().plugin,
442-
presetOptions: getDummyPresetOptions().presetOptions
440+
presetOptions: {},
441+
tests: [simpleTest]
443442
});
444443

445444
await runPluginTesterExpectThrownException({
446445
preset: getDummyPresetOptions().preset,
447-
pluginName: getDummyPluginOptions().pluginName
446+
pluginName: getDummyPluginOptions().pluginName,
447+
tests: [simpleTest]
448448
});
449449

450450
await runPluginTesterExpectThrownException({
451451
preset: getDummyPresetOptions().preset,
452-
pluginOptions: getDummyPluginOptions().pluginOptions
452+
pluginOptions: {},
453+
tests: [simpleTest]
453454
});
454455
});
455456

@@ -587,8 +588,8 @@ describe('tests targeting the PluginTesterOptions interface', () => {
587588
fixtures: getFixturePath('collate-order-1'),
588589
tests: [
589590
{
590-
code: "var foo = '';",
591-
output: "var foo_plugin2_plugin3_preset2_preset3 = '';"
591+
code: "var boo = '';",
592+
output: "var boo_plugin2_plugin3_preset2_preset3 = '';"
592593
}
593594
]
594595
})
@@ -604,8 +605,8 @@ describe('tests targeting the PluginTesterOptions interface', () => {
604605
fixtures: getFixturePath('collate-order-2'),
605606
tests: [
606607
{
607-
code: "var foo = '';",
608-
output: "var foo_plugin3_plugin2_preset2_preset3 = '';"
608+
code: "var zoo = '';",
609+
output: "var zoo_plugin3_plugin2_preset2_preset3 = '';"
609610
}
610611
]
611612
})
@@ -2016,6 +2017,35 @@ describe('tests targeting the PluginTesterOptions interface', () => {
20162017
});
20172018

20182019
describe('tests targeting both FixtureOptions and TestObject interfaces', () => {
2020+
it('throws if `it.skip` or `it.only` functions are not available in the global scope when using `skip`/`only`', async () => {
2021+
expect.hasAssertions();
2022+
2023+
const oldIt = globalThis.it;
2024+
2025+
// @ts-expect-error: I'll put it back, I pwomise!
2026+
globalThis.it = () => undefined;
2027+
2028+
try {
2029+
await runPluginTesterExpectThrownException(
2030+
getDummyPluginOptions({ fixtures: getFixturePath('option-skip') })
2031+
);
2032+
2033+
await runPluginTesterExpectThrownException(
2034+
getDummyPresetOptions({ fixtures: getFixturePath('option-only') })
2035+
);
2036+
2037+
await runPluginTesterExpectThrownException(
2038+
getDummyPluginOptions({ tests: [{ code: simpleTest, skip: true }] })
2039+
);
2040+
2041+
await runPluginTesterExpectThrownException(
2042+
getDummyPresetOptions({ tests: [{ code: simpleTest, only: true }] })
2043+
);
2044+
} finally {
2045+
globalThis.it = oldIt;
2046+
}
2047+
});
2048+
20192049
it('uses `title`, if available, for the `it` block, otherwise uses `pluginName`/`presetName`, directory name, or object key', async () => {
20202050
expect.hasAssertions();
20212051

@@ -4907,24 +4937,6 @@ describe('tests targeting the TestObject interface', () => {
49074937
]);
49084938
});
49094939

4910-
it('overrides global `snapshot` with test-level `snapshot`', async () => {
4911-
expect.hasAssertions();
4912-
4913-
await runPluginTester(
4914-
getDummyPluginOptions({
4915-
snapshot: true,
4916-
tests: [{ code: simpleTest, snapshot: false }]
4917-
})
4918-
);
4919-
4920-
await runPluginTesterExpectThrownException(
4921-
getDummyPresetOptions({
4922-
snapshot: false,
4923-
tests: [{ code: simpleTest, output: shouldNotBeSeen, snapshot: true }]
4924-
})
4925-
);
4926-
});
4927-
49284940
it('runs global and test-level setup, teardown, and returned teardown functions/promises in the proper order', async () => {
49294941
expect.hasAssertions();
49304942

@@ -5024,6 +5036,51 @@ describe('tests targeting the TestObject interface', () => {
50245036
);
50255037
});
50265038

5039+
it('throws if `toMatchSnapshot` function is not available in the value returned by `expect()` when `snapshot` is enabled', async () => {
5040+
expect.hasAssertions();
5041+
5042+
// @ts-expect-error: It's probably there.
5043+
const oldExpect = globalThis.expect;
5044+
5045+
// @ts-expect-error: I'll put it back, I pwomise!
5046+
delete globalThis.expect;
5047+
5048+
try {
5049+
await runPluginTesterExpectThrownException(
5050+
getDummyPluginOptions({
5051+
tests: [{ code: simpleTest, snapshot: true }]
5052+
})
5053+
);
5054+
5055+
await runPluginTesterExpectThrownException(
5056+
getDummyPresetOptions({
5057+
tests: [{ code: simpleTest, snapshot: true }]
5058+
})
5059+
);
5060+
} finally {
5061+
// @ts-expect-error: It's probably there.
5062+
globalThis.expect = oldExpect;
5063+
}
5064+
});
5065+
5066+
it('overrides global `snapshot` with test-level `snapshot`', async () => {
5067+
expect.hasAssertions();
5068+
5069+
await runPluginTester(
5070+
getDummyPluginOptions({
5071+
snapshot: true,
5072+
tests: [{ code: simpleTest, snapshot: false }]
5073+
})
5074+
);
5075+
5076+
await runPluginTesterExpectThrownException(
5077+
getDummyPresetOptions({
5078+
snapshot: false,
5079+
tests: [{ code: simpleTest, output: shouldNotBeSeen, snapshot: true }]
5080+
})
5081+
);
5082+
});
5083+
50275084
it('throws if both `snapshot` and `output`/`outputFixture` are provided', async () => {
50285085
expect.hasAssertions();
50295086

0 commit comments

Comments
 (0)
Please sign in to comment.