Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Instantiate presets before plugins #11689

Merged
merged 4 commits into from Oct 9, 2020
Merged

Instantiate presets before plugins #11689

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8e51eeb
Resolve all the presets before instantiating plugins
nicolo-ribaudo Apr 12, 2020
11aee48
Move try/catch to an helper
nicolo-ribaudo Apr 12, 2020
c6cf146
Fix presets ordering
nicolo-ribaudo Oct 7, 2020
eab3c06
Review
nicolo-ribaudo Oct 8, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
177 changes: 91 additions & 86 deletions packages/babel-core/src/config/full.js
View file
Open in desktop
Expand Up @@ -24,6 +24,7 @@ import {
validate,
type CallerMetadata,
checkNoUnwrappedItemOptionPairs,
type PluginItem,
} from "./validation/options";
import { validatePluginObject } from "./validation/plugins";
import makeAPI from "./helpers/config-api";
Expand Down Expand Up @@ -70,58 +71,59 @@ export default gensync<[any], ResolvedConfig | null>(function* loadFullConfig(
}

const optionDefaults = {};
const passes: Array<Array<Plugin>> = [[]];
try {
const { plugins, presets } = options;

if (!plugins || !presets) {
throw new Error("Assertion failure - plugins and presets exist");
const { plugins, presets } = options;

if (!plugins || !presets) {
throw new Error("Assertion failure - plugins and presets exist");
}

const toDescriptor = (item: PluginItem) => {
const desc = getItemDescriptor(item);
if (!desc) {
throw new Error("Assertion failure - must be config item");
}

const ignored = yield* (function* recurseDescriptors(config, pass) {
const plugins: Array<Plugin> = [];
for (let i = 0; i < config.plugins.length; i++) {
const descriptor = config.plugins[i];
if (descriptor.options !== false) {
try {
plugins.push(yield* loadPluginDescriptor(descriptor, context));
} catch (e) {
// print special message for `plugins: ["@babel/foo", { foo: "option" }]`
if (i > 0 && e.code === "BABEL_UNKNOWN_PLUGIN_PROPERTY") {
checkNoUnwrappedItemOptionPairs(
config.plugins[i - 1],
descriptor,
"plugin",
i,
e,
);
}
throw e;
}
}
}
return desc;
};

const presetsDescriptors = presets.map(toDescriptor);
const initialPluginsDescriptors = plugins.map(toDescriptor);
const pluginDescriptorsByPass: Array<Array<UnloadedDescriptor>> = [[]];
const passes: Array<Array<Plugin>> = [];

const ignored = yield* enhanceError(
context,
function* recursePresetDescriptors(
rawPresets: Array<UnloadedDescriptor>,
pluginDescriptorsPass: Array<UnloadedDescriptor>,
) {
const presets: Array<{|
preset: ConfigChain | null,
pass: Array<Plugin>,
pass: Array<UnloadedDescriptor>,
|}> = [];
for (let i = 0; i < config.presets.length; i++) {
const descriptor = config.presets[i];

for (let i = 0; i < rawPresets.length; i++) {
const descriptor = rawPresets[i];
if (descriptor.options !== false) {
try {
presets.push({
preset: yield* loadPresetDescriptor(descriptor, context),
pass: descriptor.ownPass ? [] : pass,
});
// Presets normally run in reverse order, but if they
// have their own pass they run after the presets
// in the previous pass.
if (descriptor.ownPass) {
presets.push({
preset: yield* loadPresetDescriptor(descriptor, context),
pass: [],
});
} else {
presets.unshift({
preset: yield* loadPresetDescriptor(descriptor, context),
pass: pluginDescriptorsPass,
});
}
} catch (e) {
if (i > 0 && e.code === "BABEL_UNKNOWN_OPTION") {
checkNoUnwrappedItemOptionPairs(
config.presets[i - 1],
descriptor,
"preset",
i,
e,
);
if (e.code === "BABEL_UNKNOWN_OPTION") {
checkNoUnwrappedItemOptionPairs(rawPresets, i, "preset", e);
}
throw e;
}
Expand All @@ -132,69 +134,56 @@ export default gensync<[any], ResolvedConfig | null>(function* loadFullConfig(
if (presets.length > 0) {
// The passes are created in the same order as the preset list, but are inserted before any
// existing additional passes.
passes.splice(
pluginDescriptorsByPass.splice(
1,
0,
...presets.map(o => o.pass).filter(p => p !== pass),
...presets.map(o => o.pass).filter(p => p !== pluginDescriptorsPass),
);

for (const { preset, pass } of presets) {
if (!preset) return true;

const ignored = yield* recurseDescriptors(
{
plugins: preset.plugins,
presets: preset.presets,
},
pass,
);
pass.push(...preset.plugins);

const ignored = yield* recursePresetDescriptors(preset.presets, pass);
if (ignored) return true;

preset.options.forEach(opts => {
mergeOptions(optionDefaults, opts);
});
}
}
},
)(presetsDescriptors, pluginDescriptorsByPass[0]);

// resolve plugins
if (plugins.length > 0) {
pass.unshift(...plugins);
}
})(
{
plugins: plugins.map(item => {
const desc = getItemDescriptor(item);
if (!desc) {
throw new Error("Assertion failure - must be config item");
}

return desc;
}),
presets: presets.map(item => {
const desc = getItemDescriptor(item);
if (!desc) {
throw new Error("Assertion failure - must be config item");
}
if (ignored) return null;

return desc;
}),
},
passes[0],
);
const opts: Object = optionDefaults;
mergeOptions(opts, options);

if (ignored) return null;
} catch (e) {
// There are a few case where thrown errors will try to annotate themselves multiple times, so
// to keep things simple we just bail out if re-wrapping the message.
if (!/^\[BABEL\]/.test(e.message)) {
e.message = `[BABEL] ${context.filename || "unknown"}: ${e.message}`;
}
yield* enhanceError(context, function* loadPluginDescriptors() {
pluginDescriptorsByPass[0].unshift(...initialPluginsDescriptors);

throw e;
}
for (const descs of pluginDescriptorsByPass) {
const pass = [];
passes.push(pass);

const opts: Object = optionDefaults;
mergeOptions(opts, options);
for (let i = 0; i < descs.length; i++) {
const descriptor: UnloadedDescriptor = descs[i];
if (descriptor.options !== false) {
try {
pass.push(yield* loadPluginDescriptor(descriptor, context));
} catch (e) {
if (e.code === "BABEL_UNKNOWN_PLUGIN_PROPERTY") {
// print special message for `plugins: ["@babel/foo", { foo: "option" }]`
checkNoUnwrappedItemOptionPairs(descs, i, "plugin", e);
}
throw e;
}
}
}
}
})();

opts.plugins = passes[0];
opts.presets = passes
Expand All @@ -209,6 +198,22 @@ export default gensync<[any], ResolvedConfig | null>(function* loadFullConfig(
};
});

function enhanceError<T: Function>(context, fn: T): T {
return (function* (arg1, arg2) {
try {
return yield* fn(arg1, arg2);
} catch (e) {
// There are a few case where thrown errors will try to annotate themselves multiple times, so
// to keep things simple we just bail out if re-wrapping the message.
if (!/^\[BABEL\]/.test(e.message)) {
e.message = `[BABEL] ${context.filename || "unknown"}: ${e.message}`;
}

throw e;
}
}: any);
}

/**
* Load a generic plugin/preset from the given descriptor loaded from the config object.
*/
Expand Down
10 changes: 7 additions & 3 deletions packages/babel-core/src/config/validation/options.js
View file
Open in desktop
Expand Up @@ -454,12 +454,16 @@ function assertOverridesList(loc: OptionPath, value: mixed): OverridesList {
}

export function checkNoUnwrappedItemOptionPairs(
lastItem: UnloadedDescriptor,
thisItem: UnloadedDescriptor,
type: "plugin" | "preset",
items: Array<UnloadedDescriptor>,
index: number,
type: "plugin" | "preset",
e: Error,
): void {
if (index === 0) return;

const lastItem = items[index - 1];
const thisItem = items[index];

if (
lastItem.file &&
lastItem.options === undefined &&
Expand Down
2 changes: 2 additions & 0 deletions packages/babel-core/test/api.js
View file
Open in desktop
Expand Up @@ -423,6 +423,8 @@ describe("api", function () {
"argone;",
"five;",
"six;",
"twentyone;",
"twentytwo;",
Comment on lines 424 to +427
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Before the last commit, this was

twentyone
twentytwo
five
six

And it was causing a failure in the CRA e2e test.

"three;",
"four;",
"nineteen;",
Expand Down
6 changes: 6 additions & 0 deletions packages/babel-core/test/fixtures/config/complex-plugin-config/.babelrc
View file
Open in desktop
Expand Up @@ -14,6 +14,12 @@
"./five",
"./six",
],
presets: [{
plugins: [
"./twentyone",
"./twentytwo",
]
}]
}, {
passPerPreset: true,
presets: [{
Expand Down
1 change: 1 addition & 0 deletions packages/babel-core/test/fixtures/config/complex-plugin-config/twentyone.js
View file
Open in desktop
@@ -0,0 +1 @@
module.exports = require("./plugin")("twentyone");
1 change: 1 addition & 0 deletions packages/babel-core/test/fixtures/config/complex-plugin-config/twentytwo.js
View file
Open in desktop
@@ -0,0 +1 @@
module.exports = require("./plugin")("twentytwo");