Skip to content

fix(@angular-devkit/build-angular): update index html webpack plugin to use non deprecated Webpack 5 API #19487

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
clydin merged 1 commit into from
Dec 3, 2020
Merged

fix(@angular-devkit/build-angular): update index html webpack plugin to use non deprecated Webpack 5 API #19487

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 23 additions & 5 deletions packages/angular_devkit/build_angular/src/webpack/plugins/index-html-webpack-plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,15 @@ import { Compiler, compilation } from 'webpack';
import { RawSource } from 'webpack-sources';
import { FileInfo } from '../../utils/index-file/augment-index-html';
import { IndexHtmlGenerator, IndexHtmlGeneratorOptions, IndexHtmlGeneratorProcessOptions } from '../../utils/index-file/index-html-generator';
import { isWebpackFiveOrHigher } from '../../utils/webpack-version';

export interface IndexHtmlWebpackPluginOptions extends IndexHtmlGeneratorOptions,
Omit<IndexHtmlGeneratorProcessOptions, 'files' | 'noModuleFiles' | 'moduleFiles'> {
noModuleEntrypoints: string[];
moduleEntrypoints: string[];
}

const PLUGIN_NAME = 'index-html-webpack-plugin';
export class IndexHtmlWebpackPlugin extends IndexHtmlGenerator {
private _compilation: compilation.Compilation | undefined;
get compilation(): compilation.Compilation {
Expand All @@ -32,15 +34,31 @@ export class IndexHtmlWebpackPlugin extends IndexHtmlGenerator {
}

apply(compiler: Compiler) {
compiler.hooks.emit.tapPromise('index-html-webpack-plugin', async compilation => {
this._compilation = compilation;
if (isWebpackFiveOrHigher()) {
compiler.hooks.thisCompilation.tap(PLUGIN_NAME, compilation => {
this._compilation = compilation;

// webpack 5 migration "guide"
// https://github.com/webpack/webpack/blob/07fc554bef5930f8577f91c91a8b81791fc29746/lib/Compilation.js#L535-L539
// TODO_WEBPACK_5 const stage = Compilation.PROCESS_ASSETS_STAGE_OPTIMIZE + 1;
// tslint:disable-next-line: no-any
(compilation.hooks as any).processAssets.tapPromise({ name: PLUGIN_NAME, stage: 101 }, callback);
});
} else {
compiler.hooks.emit.tapPromise(PLUGIN_NAME, async compilation => {
this._compilation = compilation;

await callback(compilation.assets);
});
}

const callback = async (assets: Record<string, unknown>) => {
// Get all files for selected entrypoints
const files: FileInfo[] = [];
const noModuleFiles: FileInfo[] = [];
const moduleFiles: FileInfo[] = [];

for (const [entryName, entrypoint] of compilation.entrypoints) {
for (const [entryName, entrypoint] of this.compilation.entrypoints) {
const entryFiles: FileInfo[] = entrypoint?.getFiles()?.map(
(f: string): FileInfo => ({
name: entryName,
Expand Down Expand Up @@ -71,8 +89,8 @@ export class IndexHtmlWebpackPlugin extends IndexHtmlGenerator {
lang: this.options.lang,
});

compilation.assets[this.options.outputPath] = new RawSource(content);
});
assets[this.options.outputPath] = new RawSource(content);
};
}

async readAsset(path: string): Promise<string> {
Expand Down