Skip to content

fix(plugin-webpack): ESM-compatible imports #4206

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

Merged
erickzhao merged 2 commits into from
Apr 9, 2026
+25 −7
Merged

fix(plugin-webpack): ESM-compatible imports #4206

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1b88843
fix(plugin-webpack): ESM-compatible imports
erickzhao Apr 8, 2026
9f0e1a0
windows interop
erickzhao Apr 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions packages/plugin/webpack/src/WebpackConfig.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@ import path from 'node:path';

import debug from 'debug';
import HtmlWebpackPlugin from 'html-webpack-plugin';
import * as webpack from 'webpack';
import { DefinePlugin, ExternalsPlugin, WebpackPluginInstance } from 'webpack';
import type * as webpack from 'webpack';
Copy link
Copy Markdown
Member

@dsanders11 dsanders11 Apr 8, 2026

Choose a reason for hiding this comment

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

nit(non-blocking): since we only need WebpackPluginInstance, could this just be import type { WebpackPluginInstance } from 'webpack';?

Copy link
Copy Markdown
Member Author

@erickzhao erickzhao Apr 8, 2026

Choose a reason for hiding this comment

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

This isn't in the diff but there are a handful of other types we were using beforehand (Configuration, Entry, etc.)

import webpackPkg from 'webpack';

const { DefinePlugin, ExternalsPlugin } = webpackPkg;
import { merge as webpackMerge } from 'webpack-merge';

import {
Expand Down Expand Up @@ -366,7 +368,7 @@ export default class WebpackConfigGenerator {
template: entryPoint.html,
filename: `${entryPoint.name}/index.html`,
chunks: [entryPoint.name].concat(entryPoint.additionalChunks || []),
}) as WebpackPluginInstance,
}) as webpack.WebpackPluginInstance,
);
}
}
Expand Down
8 changes: 4 additions & 4 deletions packages/plugin/webpack/src/WebpackPlugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import debug from 'debug';
import glob from 'fast-glob';
import fs from 'fs-extra';
import { PRESET_TIMER } from 'listr2';
import * as webpack from 'webpack';
import webpack from 'webpack';
import WebpackDevServer from 'webpack-dev-server';
import { merge } from 'webpack-merge';

Expand Down Expand Up @@ -145,7 +145,7 @@ export default class WebpackPlugin extends PluginBase<WebpackPluginConfig> {
rendererOptions: WebpackPluginRendererConfig | null,
): Promise<webpack.MultiStats | undefined> =>
new Promise((resolve, reject) => {
webpack.webpack(options).run(async (err, stats) => {
webpack(options).run(async (err, stats) => {
if (rendererOptions && rendererOptions.jsonStats) {
for (const [index, entryStats] of (stats?.stats ?? []).entries()) {
const name = rendererOptions.entryPoints[index].name;
Expand Down Expand Up @@ -639,7 +639,7 @@ the generated files). Instead, it is ${JSON.stringify(pj.main)}`);

const mainConfig = await this.configGenerator.getMainConfig();
await new Promise((resolve, reject) => {
const compiler = webpack.webpack(mainConfig);
const compiler = webpack(mainConfig);
const [onceResolve, onceReject] = once(resolve, reject);
const cb: WebpackWatchHandler = async (err, stats) => {
if (tab && stats) {
Expand Down Expand Up @@ -741,7 +741,7 @@ the generated files). Instead, it is ${JSON.stringify(pj.main)}`);
entryConfig.stats = 'none';
}

const compiler = webpack.webpack(configs);
const compiler = webpack(configs);

const promises = preloadPlugins.map((preloadPlugin) => {
return new Promise((resolve, reject) => {
Expand Down
16 changes: 16 additions & 0 deletions tools/test-dist.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
import * as path from 'node:path';
import { pathToFileURL } from 'node:url';

import chalk from 'chalk';
import fs from 'fs-extra';

const BASE_DIR = path.resolve(import.meta.dirname, '..');
const PACKAGES_DIR = path.resolve(BASE_DIR, 'packages');

// Packages whose entry points have top-level side effects (CLI scripts)
// that cannot be safely imported in a test context.
const SKIP_IMPORT = new Set(['create-electron-app']);

(async () => {
const dirsToCheck: string[] = [];

Expand Down Expand Up @@ -46,6 +51,17 @@ const PACKAGES_DIR = path.resolve(BASE_DIR, 'packages');
chalk.red(`Main entry not found (${main})`),
);
bad = true;
} else if (!SKIP_IMPORT.has(pj.name)) {
try {
await import(pathToFileURL(path.resolve(dir, main)).href);
} catch (err: unknown) {
const message = err instanceof Error ? err.message : String(err);
console.error(
`${chalk.cyan(`[${pj.name}]`)}:`,
chalk.red(`Failed to import main entry (${main}): ${message}`),
);
bad = true;
}
}
if (!typings || !(await fs.pathExists(path.resolve(dir, typings)))) {
console.error(
Expand Down