Skip to content

Commit

Permalink
Feature: Customize Webpack HTML
Browse files Browse the repository at this point in the history
This changeset adds options to entrypoints to support customized
operation of the `HtmlWebpackPlugin`. See below for full changeset.

Changes enclosed:
- Add properties for `output`, `htmlPlugins`, and `htmlOptions` to
  `WebpackPluginEntryPoint`
- Use new options from `Config.ts`, by merging them into their
  expected places

Fixes and closes electron#2968.
  • Loading branch information
sgammon committed Oct 16, 2022
1 parent 362099a commit 85838b0
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 5 deletions.
17 changes: 16 additions & 1 deletion packages/plugin/webpack/src/Config.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { Configuration as RawWebpackConfiguration } from 'webpack';
import { Configuration as RawWebpackConfiguration, Output as WebpackOutput, Plugin as WebpackPlugin } from 'webpack';
import WebpackDevServer from 'webpack-dev-server';
import { ConfigurationFactory as WebpackConfigurationFactory } from './WebpackConfig';
import { HtmlWebpackPlugin } from 'html-webpack-plugin';

export interface WebpackPluginEntryPoint {
/**
Expand Down Expand Up @@ -48,6 +49,20 @@ export interface WebpackPluginEntryPoint {
* for all entries.
*/
nodeIntegration?: boolean;
/**
* Custom options to merge into the configuration passed to `HtmlWebpackPlugin`.
*/
htmlOptions?: Partial<HtmlWebpackPlugin.Options>;
/**
* Plugins to include before `HtmlWebpackPlugin`; typically, HTML plugin add-ons will
* need to be placed here.
*/
htmlPlugins?: WebpackPlugin[];
/**
* Additional options to merge into the Webpack `output` configuration for this entry-
* point.
*/
output?: WebpackOutput;
}

export interface WebpackPreloadEntryPoint {
Expand Down
9 changes: 5 additions & 4 deletions packages/plugin/webpack/src/WebpackConfig.ts
Original file line number Diff line number Diff line change
Expand Up @@ -194,25 +194,26 @@ export default class WebpackConfigGenerator {
target: this.rendererTarget(entryPoint),
devtool: this.rendererSourceMapOption,
mode: this.mode,
output: {
output: Object.assign(entryPoint.output || {}, {
path: path.resolve(this.webpackDir, 'renderer'),
filename: '[name]/index.js',
globalObject: 'self',
...(this.isProd ? {} : { publicPath: '/' }),
},
}),
node: {
__dirname: false,
__filename: false,
},
plugins: [
...(entryPoint.htmlPlugins || []),
...(entryPoint.html
? [
new HtmlWebpackPlugin({
new HtmlWebpackPlugin(Object.assign({}, {
title: entryPoint.name,
template: entryPoint.html,
filename: `${entryPoint.name}/index.html`,
chunks: [entryPoint.name].concat(entryPoint.additionalChunks || []),
}) as WebpackPluginInstance,
}, entryPoint.htmlOptions || {})) as WebpackPluginInstance,
]
: []),
new webpack.DefinePlugin(defines),
Expand Down

0 comments on commit 85838b0

Please sign in to comment.