@rushstack/heft-webpack5-plugin 0.6.5 → 0.7.0-rc.5

package/README.md

@@ -1,11 +1,12 @@
 # @rushstack/heft-webpack5-plugin
 
-This is a Heft plugin for using Webpack 5 during the "bundle" stage.
+This is a Heft plugin for using Webpack 5.
 
 ## Links
 
 - [CHANGELOG.md](
   https://github.com/microsoft/rushstack/blob/main/heft-plugins/heft-webpack5-plugin/CHANGELOG.md) - Find
   out what's new in the latest version
+- [@rushstack/heft](https://www.npmjs.com/package/@rushstack/heft) - Heft is a config-driven toolchain that invokes popular tools such as TypeScript, ESLint, Jest, Webpack, and API Extractor.
 
 Heft is part of the [Rush Stack](https://rushstack.io/) family of projects.

package/dist/heft-webpack5-plugin.d.ts

@@ -1,49 +1,114 @@
+import type { AsyncParallelHook } from 'tapable';
+import type { AsyncSeriesBailHook } from 'tapable';
+import type { AsyncSeriesHook } from 'tapable';
 import type { Configuration } from 'webpack-dev-server';
-import type { IBuildStageProperties } from '@rushstack/heft';
-import type { IBundleSubstageProperties } from '@rushstack/heft';
-import type { IHeftPlugin } from '@rushstack/heft';
-import type * as webpack from 'webpack';
+import type { HeftConfiguration } from '@rushstack/heft';
+import type { IHeftTaskSession } from '@rushstack/heft';
+import type * as TWebpack from 'webpack';
 
 /**
  * @public
  */
-declare const _default: IHeftPlugin<void>;
-export default _default;
+export declare type IWebpackConfiguration = IWebpackConfigurationWithDevServer | IWebpackConfigurationWithDevServer[];
 
 /**
+ * The environment passed into the Webpack configuration function. Loosely based
+ * on the default Webpack environment options, specified here:
+ * https://webpack.js.org/api/cli/#environment-options
+ *
  * @public
  */
-export declare interface IWebpackBuildStageProperties extends IBuildStageProperties {
-    webpackStats?: webpack.Stats | webpack.MultiStats;
+export declare interface IWebpackConfigurationFnEnvironment {
+    /**
+     * Whether or not the run is in production mode. Synonym of
+     * IWebpackConfigurationFnEnvironment.production.
+     */
+    prod: boolean;
+    /**
+     * Whether or not the run is in production mode. Synonym of
+     * IWebpackConfigurationFnEnvironment.prod.
+     */
+    production: boolean;
+    /**
+     * The task session provided to the plugin.
+     */
+    taskSession: IHeftTaskSession;
+    /**
+     * The Heft configuration provided to the plugin.
+     */
+    heftConfiguration: HeftConfiguration;
+    /**
+     * The resolved Webpack package.
+     */
+    webpack: typeof TWebpack;
+}
+
+/**
+ * @public
+ */
+export declare interface IWebpackConfigurationWithDevServer extends TWebpack.Configuration {
+    devServer?: Configuration;
+}
+
+/**
+ * @public
+ */
+export declare interface IWebpackPluginAccessor {
+    /**
+     * Hooks that are called at various points in the Webpack plugin lifecycle.
+     */
+    readonly hooks: IWebpackPluginAccessorHooks;
+    /**
+     * Parameters that are provided by the Webpack plugin.
+     */
+    readonly parameters: IWebpackPluginAccessorParameters;
 }
 
 /**
  * @public
  */
-export declare interface IWebpackBundleSubstageProperties extends IBundleSubstageProperties {
+export declare interface IWebpackPluginAccessorHooks {
     /**
-     * The configuration used by the Webpack plugin. This must be populated
-     * for Webpack to run. If webpackConfigFilePath is specified,
-     * this will be populated automatically with the exports of the
-     * config file referenced in that property.
+     * A hook that allows for loading custom configurations used by the Webpack
+     * plugin. If a webpack configuration is provided, this will be populated automatically
+     * with the exports of the config file. If a webpack configuration is not provided,
+     * one will be loaded by the Webpack plugin.
      *
      * @remarks
-     * Tapable event handlers can return `null` instead of `undefined` to suppress
-     * other handlers from creating a configuration object.
+     * Tapable event handlers can return `false` instead of `undefined` to suppress
+     * other handlers from creating a configuration object, and prevent webpack from running.
+     */
+    readonly onLoadConfiguration: AsyncSeriesBailHook<never, never, never, IWebpackConfiguration | false>;
+    /**
+     * A hook that allows for modification of the loaded configuration used by the Webpack
+     * plugin. If no configuration was loaded, this hook will not be called.
      */
-    webpackConfiguration?: webpack.Configuration | webpack.Configuration[] | null;
+    readonly onConfigure: AsyncSeriesHook<IWebpackConfiguration, never, never>;
+    /**
+     * A hook that provides the finalized configuration that will be used by Webpack.
+     * If no configuration was loaded, this hook will not be called.
+     */
+    readonly onAfterConfigure: AsyncParallelHook<IWebpackConfiguration, never, never>;
+    /**
+     * A hook that provides the stats output from Webpack. If no configuration is loaded,
+     * this hook will not be called.
+     */
+    readonly onEmitStats: AsyncParallelHook<TWebpack.Stats | TWebpack.MultiStats, never, never>;
 }
 
 /**
  * @public
  */
-export declare type IWebpackConfiguration = IWebpackConfigurationWithDevServer | IWebpackConfigurationWithDevServer[] | undefined;
+export declare interface IWebpackPluginAccessorParameters {
+    /**
+     * Whether or not serve mode was enabled by passing the `--serve` flag.
+     */
+    readonly isServeMode: boolean;
+}
 
 /**
  * @public
  */
-export declare interface IWebpackConfigurationWithDevServer extends webpack.Configuration {
-    devServer?: Configuration;
-}
+export declare const PluginName: 'webpack5-plugin';
 
 export { }

package/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.34.4"
+      "packageVersion": "7.34.5"
     }
   ]
 }

package/heft-plugin.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/heft/heft-plugin.schema.json",
+
+  "taskPlugins": [
+    {
+      "pluginName": "webpack5-plugin",
+      "entryPoint": "./lib/Webpack5Plugin",
+      "optionsSchema": "./lib/schemas/heft-webpack5-plugin.schema.json",
+
+      "parameterScope": "webpack5",
+      "parameters": [
+        {
+          "longName": "--serve",
+          "parameterKind": "flag",
+          "description": "Start a local web server for testing purposes using webpack-dev-server.  This parameter is only available when running in watch mode."
+        }
+      ]
+    }
+  ]
+}

package/lib/DeferredWatchFileSystem.d.ts

@@ -0,0 +1,27 @@
+import Watchpack, { type WatchOptions } from 'watchpack';
+import type { Compiler, WebpackPluginInstance } from 'webpack';
+export declare type InputFileSystem = Compiler['inputFileSystem'];
+export declare type WatchFileSystem = Compiler['watchFileSystem'];
+export declare type WatchCallback = Parameters<WatchFileSystem['watch']>[5];
+export declare type WatchUndelayedCallback = Parameters<WatchFileSystem['watch']>[6];
+export declare type Watcher = ReturnType<WatchFileSystem['watch']>;
+export declare type WatcherInfo = ReturnType<Required<Watcher>['getInfo']>;
+export declare class DeferredWatchFileSystem implements WatchFileSystem {
+    readonly inputFileSystem: InputFileSystem;
+    readonly watcherOptions: WatchOptions;
+    watcher: Watchpack | undefined;
+    private readonly _onChange;
+    private _state;
+    constructor(inputFileSystem: InputFileSystem, onChange: () => void);
+    flush(): boolean;
+    watch(files: Iterable<string>, directories: Iterable<string>, missing: Iterable<string>, startTime: number, options: WatchOptions, callback: WatchCallback, callbackUndelayed: WatchUndelayedCallback): Watcher;
+    private _fetchTimeInfo;
+    private _purge;
+}
+export declare class OverrideNodeWatchFSPlugin implements WebpackPluginInstance {
+    readonly fileSystems: Set<DeferredWatchFileSystem>;
+    private readonly _onChange;
+    constructor(onChange: () => void);
+    apply(compiler: Compiler): void;
+}
+//# sourceMappingURL=DeferredWatchFileSystem.d.ts.map

package/lib/DeferredWatchFileSystem.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeferredWatchFileSystem.d.ts","sourceRoot":"","sources":["../src/DeferredWatchFileSystem.ts"],"names":[],"mappings":"AAGA,OAAO,SAAS,EAAE,EAAE,KAAK,YAAY,EAAE,MAAM,WAAW,CAAC;AACzD,OAAO,KAAK,EAAE,QAAQ,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AAE/D,oBAAY,eAAe,GAAG,QAAQ,CAAC,iBAAiB,CAAC,CAAC;AAC1D,oBAAY,eAAe,GAAG,QAAQ,CAAC,iBAAiB,CAAC,CAAC;AAC1D,oBAAY,aAAa,GAAG,UAAU,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACpE,oBAAY,sBAAsB,GAAG,UAAU,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC7E,oBAAY,OAAO,GAAG,UAAU,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC;AAC3D,oBAAY,WAAW,GAAG,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;AAsBnE,qBAAa,uBAAwB,YAAW,eAAe;IAC7D,SAAgB,eAAe,EAAE,eAAe,CAAC;IACjD,SAAgB,cAAc,EAAE,YAAY,CAAC;IACtC,OAAO,EAAE,SAAS,GAAG,SAAS,CAAC;IAEtC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAa;IACvC,OAAO,CAAC,MAAM,CAA0B;gBAErB,eAAe,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,IAAI;IASlE,KAAK,IAAI,OAAO;IA0ChB,KAAK,CACV,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,EACvB,WAAW,EAAE,QAAQ,CAAC,MAAM,CAAC,EAC7B,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,EACzB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,YAAY,EACrB,QAAQ,EAAE,aAAa,EACvB,iBAAiB,EAAE,sBAAsB,GACxC,OAAO;IAyEV,OAAO,CAAC,cAAc;IAOtB,OAAO,CAAC,MAAM;CAef;AAED,qBAAa,yBAA0B,YAAW,qBAAqB;IACrE,SAAgB,WAAW,EAAE,GAAG,CAAC,uBAAuB,CAAC,CAAa;IACtE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAa;gBAEpB,QAAQ,EAAE,MAAM,IAAI;IAIhC,KAAK,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI;CAQvC"}

package/lib/DeferredWatchFileSystem.js

@@ -0,0 +1,151 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OverrideNodeWatchFSPlugin = exports.DeferredWatchFileSystem = void 0;
+const watchpack_1 = __importDefault(require("watchpack"));
+class DeferredWatchFileSystem {
+    constructor(inputFileSystem, onChange) {
+        this.inputFileSystem = inputFileSystem;
+        this.watcherOptions = {
+            aggregateTimeout: 0
+        };
+        this.watcher = new watchpack_1.default(this.watcherOptions);
+        this._onChange = onChange;
+    }
+    flush() {
+        const state = this._state;
+        if (!state) {
+            return false;
+        }
+        const { changes, removals, callback } = state;
+        // Force flush the aggregation callback
+        const { changes: newChanges, removals: newRemovals } = this.watcher.getAggregated();
+        // Webpack 5 treats changes and removals as separate things
+        if (newRemovals) {
+            for (const removal of newRemovals) {
+                changes.delete(removal);
+                removals.add(removal);
+            }
+        }
+        if (newChanges) {
+            for (const change of newChanges) {
+                removals.delete(change);
+                changes.add(change);
+            }
+        }
+        if (changes.size > 0 || removals.size > 0) {
+            this._purge(removals, changes);
+            const { fileTimeInfoEntries, contextTimeInfoEntries } = this._fetchTimeInfo();
+            callback(undefined, fileTimeInfoEntries, contextTimeInfoEntries, changes, removals);
+            changes.clear();
+            removals.clear();
+            return true;
+        }
+        return false;
+    }
+    watch(files, directories, missing, startTime, options, callback, callbackUndelayed) {
+        const oldWatcher = this.watcher;
+        this.watcher = new watchpack_1.default(options);
+        const changes = new Set();
+        const removals = new Set();
+        this._state = {
+            changes,
+            removals,
+            callback
+        };
+        this.watcher.on('aggregated', (newChanges, newRemovals) => {
+            for (const change of newChanges) {
+                removals.delete(change);
+                changes.add(change);
+            }
+            for (const removal of newRemovals) {
+                changes.delete(removal);
+                removals.add(removal);
+            }
+            this._onChange();
+        });
+        this.watcher.watch({
+            files,
+            directories,
+            missing,
+            startTime
+        });
+        if (oldWatcher) {
+            oldWatcher.close();
+        }
+        return {
+            close: () => {
+                if (this.watcher) {
+                    this.watcher.close();
+                    this.watcher = undefined;
+                }
+            },
+            pause: () => {
+                if (this.watcher) {
+                    this.watcher.pause();
+                }
+            },
+            getInfo: () => {
+                var _a, _b;
+                const newRemovals = (_a = this.watcher) === null || _a === void 0 ? void 0 : _a.aggregatedRemovals;
+                const newChanges = (_b = this.watcher) === null || _b === void 0 ? void 0 : _b.aggregatedChanges;
+                this._purge(newRemovals, newChanges);
+                const { fileTimeInfoEntries, contextTimeInfoEntries } = this._fetchTimeInfo();
+                return {
+                    changes: newChanges,
+                    removals: newRemovals,
+                    fileTimeInfoEntries,
+                    contextTimeInfoEntries
+                };
+            },
+            getContextTimeInfoEntries: () => {
+                const { contextTimeInfoEntries } = this._fetchTimeInfo();
+                return contextTimeInfoEntries;
+            },
+            getFileTimeInfoEntries: () => {
+                const { fileTimeInfoEntries } = this._fetchTimeInfo();
+                return fileTimeInfoEntries;
+            }
+        };
+    }
+    _fetchTimeInfo() {
+        var _a;
+        const fileTimeInfoEntries = new Map();
+        const contextTimeInfoEntries = new Map();
+        (_a = this.watcher) === null || _a === void 0 ? void 0 : _a.collectTimeInfoEntries(fileTimeInfoEntries, contextTimeInfoEntries);
+        return { fileTimeInfoEntries, contextTimeInfoEntries };
+    }
+    _purge(removals, changes) {
+        const fs = this.inputFileSystem;
+        if (fs.purge) {
+            if (removals) {
+                for (const removal of removals) {
+                    fs.purge(removal);
+                }
+            }
+            if (changes) {
+                for (const change of changes) {
+                    fs.purge(change);
+                }
+            }
+        }
+    }
+}
+exports.DeferredWatchFileSystem = DeferredWatchFileSystem;
+class OverrideNodeWatchFSPlugin {
+    constructor(onChange) {
+        this.fileSystems = new Set();
+        this._onChange = onChange;
+    }
+    apply(compiler) {
+        const watchFileSystem = new DeferredWatchFileSystem(compiler.inputFileSystem, this._onChange);
+        this.fileSystems.add(watchFileSystem);
+        compiler.watchFileSystem = watchFileSystem;
+    }
+}
+exports.OverrideNodeWatchFSPlugin = OverrideNodeWatchFSPlugin;
+//# sourceMappingURL=DeferredWatchFileSystem.js.map

package/lib/DeferredWatchFileSystem.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeferredWatchFileSystem.js","sourceRoot":"","sources":["../src/DeferredWatchFileSystem.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;AAE3D,0DAAyD;AA8BzD,MAAa,uBAAuB;IAQlC,YAAmB,eAAgC,EAAE,QAAoB;QACvE,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,cAAc,GAAG;YACpB,gBAAgB,EAAE,CAAC;SACpB,CAAC;QACF,IAAI,CAAC,OAAO,GAAG,IAAI,mBAAS,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAClD,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC5B,CAAC;IAEM,KAAK;QACV,MAAM,KAAK,GAA4B,IAAI,CAAC,MAAM,CAAC;QAEnD,IAAI,CAAC,KAAK,EAAE;YACV,OAAO,KAAK,CAAC;SACd;QAED,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,KAAK,CAAC;QAE9C,uCAAuC;QACvC,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC,OAAQ,CAAC,aAAa,EAAE,CAAC;QAErF,2DAA2D;QAC3D,IAAI,WAAW,EAAE;YACf,KAAK,MAAM,OAAO,IAAI,WAAW,EAAE;gBACjC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;gBACxB,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;aACvB;SACF;QACD,IAAI,UAAU,EAAE;YACd,KAAK,MAAM,MAAM,IAAI,UAAU,EAAE;gBAC/B,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;gBACxB,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;aACrB;SACF;QAED,IAAI,OAAO,CAAC,IAAI,GAAG,CAAC,IAAI,QAAQ,CAAC,IAAI,GAAG,CAAC,EAAE;YACzC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YAE/B,MAAM,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;YAE9E,QAAQ,CAAC,SAAS,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;YAEpF,OAAO,CAAC,KAAK,EAAE,CAAC;YAChB,QAAQ,CAAC,KAAK,EAAE,CAAC;YAEjB,OAAO,IAAI,CAAC;SACb;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,KAAK,CACV,KAAuB,EACvB,WAA6B,EAC7B,OAAyB,EACzB,SAAiB,EACjB,OAAqB,EACrB,QAAuB,EACvB,iBAAyC;QAEzC,MAAM,UAAU,GAA0B,IAAI,CAAC,OAAO,CAAC;QACvD,IAAI,CAAC,OAAO,GAAG,IAAI,mBAAS,CAAC,OAAO,CAAC,CAAC;QAEtC,MAAM,OAAO,GAAgB,IAAI,GAAG,EAAE,CAAC;QACvC,MAAM,QAAQ,GAAgB,IAAI,GAAG,EAAE,CAAC;QAExC,IAAI,CAAC,MAAM,GAAG;YACZ,OAAO;YACP,QAAQ;YAER,QAAQ;SACT,CAAC;QAEF,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,UAAuB,EAAE,WAAwB,EAAE,EAAE;YAClF,KAAK,MAAM,MAAM,IAAI,UAAU,EAAE;gBAC/B,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;gBACxB,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;aACrB;YACD,KAAK,MAAM,OAAO,IAAI,WAAW,EAAE;gBACjC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;gBACxB,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;aACvB;YAED,IAAI,CAAC,SAAS,EAAE,CAAC;QACnB,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;YACjB,KAAK;YACL,WAAW;YACX,OAAO;YACP,SAAS;SACV,CAAC,CAAC;QAEH,IAAI,UAAU,EAAE;YACd,UAAU,CAAC,KAAK,EAAE,CAAC;SACpB;QAED,OAAO;YACL,KAAK,EAAE,GAAG,EAAE;gBACV,IAAI,IAAI,CAAC,OAAO,EAAE;oBAChB,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;oBACrB,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;iBAC1B;YACH,CAAC;YACD,KAAK,EAAE,GAAG,EAAE;gBACV,IAAI,IAAI,CAAC,OAAO,EAAE;oBAChB,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;iBACtB;YACH,CAAC;YACD,OAAO,EAAE,GAAG,EAAE;;gBACZ,MAAM,WAAW,GAA4B,MAAA,IAAI,CAAC,OAAO,0CAAE,kBAAkB,CAAC;gBAC9E,MAAM,UAAU,GAA4B,MAAA,IAAI,CAAC,OAAO,0CAAE,iBAAiB,CAAC;gBAC5E,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;gBACrC,MAAM,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;gBAC9E,OAAO;oBACL,OAAO,EAAE,UAAW;oBACpB,QAAQ,EAAE,WAAY;oBACtB,mBAAmB;oBACnB,sBAAsB;iBACvB,CAAC;YACJ,CAAC;YACD,yBAAyB,EAAE,GAAG,EAAE;gBAC9B,MAAM,EAAE,sBAAsB,EAAE,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;gBACzD,OAAO,sBAAsB,CAAC;YAChC,CAAC;YACD,sBAAsB,EAAE,GAAG,EAAE;gBAC3B,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;gBACtD,OAAO,mBAAmB,CAAC;YAC7B,CAAC;SACF,CAAC;IACJ,CAAC;IAEO,cAAc;;QACpB,MAAM,mBAAmB,GAAsB,IAAI,GAAG,EAAE,CAAC;QACzD,MAAM,sBAAsB,GAAsB,IAAI,GAAG,EAAE,CAAC;QAC5D,MAAA,IAAI,CAAC,OAAO,0CAAE,sBAAsB,CAAC,mBAAmB,EAAE,sBAAsB,CAAC,CAAC;QAClF,OAAO,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,CAAC;IACzD,CAAC;IAEO,MAAM,CAAC,QAAiC,EAAE,OAAgC;QAChF,MAAM,EAAE,GAAoB,IAAI,CAAC,eAAe,CAAC;QACjD,IAAI,EAAE,CAAC,KAAK,EAAE;YACZ,IAAI,QAAQ,EAAE;gBACZ,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;oBAC9B,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;iBACnB;aACF;YACD,IAAI,OAAO,EAAE;gBACX,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;oBAC5B,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;iBAClB;aACF;SACF;IACH,CAAC;CACF;AAlKD,0DAkKC;AAED,MAAa,yBAAyB;IAIpC,YAAmB,QAAoB;QAHvB,gBAAW,GAAiC,IAAI,GAAG,EAAE,CAAC;QAIpE,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC5B,CAAC;IAEM,KAAK,CAAC,QAAkB;QAC7B,MAAM,eAAe,GAA4B,IAAI,uBAAuB,CAC1E,QAAQ,CAAC,eAAe,EACxB,IAAI,CAAC,SAAS,CACf,CAAC;QACF,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QACtC,QAAQ,CAAC,eAAe,GAAG,eAAe,CAAC;IAC7C,CAAC;CACF;AAhBD,8DAgBC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport Watchpack, { type WatchOptions } from 'watchpack';\nimport type { Compiler, WebpackPluginInstance } from 'webpack';\n\nexport type InputFileSystem = Compiler['inputFileSystem'];\nexport type WatchFileSystem = Compiler['watchFileSystem'];\nexport type WatchCallback = Parameters<WatchFileSystem['watch']>[5];\nexport type WatchUndelayedCallback = Parameters<WatchFileSystem['watch']>[6];\nexport type Watcher = ReturnType<WatchFileSystem['watch']>;\nexport type WatcherInfo = ReturnType<Required<Watcher>['getInfo']>;\ntype FileSystemMap = ReturnType<Watcher['getFileTimeInfoEntries']>;\n\ninterface IWatchState {\n  changes: Set<string>;\n  removals: Set<string>;\n\n  callback: WatchCallback;\n}\n\ninterface ITimeEntry {\n  timestamp: number;\n  safeTime: number;\n}\n\ntype IRawFileSystemMap = Map<string, ITimeEntry>;\n\ninterface ITimeInfoEntries {\n  fileTimeInfoEntries: FileSystemMap;\n  contextTimeInfoEntries: FileSystemMap;\n}\n\nexport class DeferredWatchFileSystem implements WatchFileSystem {\n  public readonly inputFileSystem: InputFileSystem;\n  public readonly watcherOptions: WatchOptions;\n  public watcher: Watchpack | undefined;\n\n  private readonly _onChange: () => void;\n  private _state: IWatchState | undefined;\n\n  public constructor(inputFileSystem: InputFileSystem, onChange: () => void) {\n    this.inputFileSystem = inputFileSystem;\n    this.watcherOptions = {\n      aggregateTimeout: 0\n    };\n    this.watcher = new Watchpack(this.watcherOptions);\n    this._onChange = onChange;\n  }\n\n  public flush(): boolean {\n    const state: IWatchState | undefined = this._state;\n\n    if (!state) {\n      return false;\n    }\n\n    const { changes, removals, callback } = state;\n\n    // Force flush the aggregation callback\n    const { changes: newChanges, removals: newRemovals } = this.watcher!.getAggregated();\n\n    // Webpack 5 treats changes and removals as separate things\n    if (newRemovals) {\n      for (const removal of newRemovals) {\n        changes.delete(removal);\n        removals.add(removal);\n      }\n    }\n    if (newChanges) {\n      for (const change of newChanges) {\n        removals.delete(change);\n        changes.add(change);\n      }\n    }\n\n    if (changes.size > 0 || removals.size > 0) {\n      this._purge(removals, changes);\n\n      const { fileTimeInfoEntries, contextTimeInfoEntries } = this._fetchTimeInfo();\n\n      callback(undefined, fileTimeInfoEntries, contextTimeInfoEntries, changes, removals);\n\n      changes.clear();\n      removals.clear();\n\n      return true;\n    }\n\n    return false;\n  }\n\n  public watch(\n    files: Iterable<string>,\n    directories: Iterable<string>,\n    missing: Iterable<string>,\n    startTime: number,\n    options: WatchOptions,\n    callback: WatchCallback,\n    callbackUndelayed: WatchUndelayedCallback\n  ): Watcher {\n    const oldWatcher: Watchpack | undefined = this.watcher;\n    this.watcher = new Watchpack(options);\n\n    const changes: Set<string> = new Set();\n    const removals: Set<string> = new Set();\n\n    this._state = {\n      changes,\n      removals,\n\n      callback\n    };\n\n    this.watcher.on('aggregated', (newChanges: Set<string>, newRemovals: Set<string>) => {\n      for (const change of newChanges) {\n        removals.delete(change);\n        changes.add(change);\n      }\n      for (const removal of newRemovals) {\n        changes.delete(removal);\n        removals.add(removal);\n      }\n\n      this._onChange();\n    });\n\n    this.watcher.watch({\n      files,\n      directories,\n      missing,\n      startTime\n    });\n\n    if (oldWatcher) {\n      oldWatcher.close();\n    }\n\n    return {\n      close: () => {\n        if (this.watcher) {\n          this.watcher.close();\n          this.watcher = undefined;\n        }\n      },\n      pause: () => {\n        if (this.watcher) {\n          this.watcher.pause();\n        }\n      },\n      getInfo: () => {\n        const newRemovals: Set<string> | undefined = this.watcher?.aggregatedRemovals;\n        const newChanges: Set<string> | undefined = this.watcher?.aggregatedChanges;\n        this._purge(newRemovals, newChanges);\n        const { fileTimeInfoEntries, contextTimeInfoEntries } = this._fetchTimeInfo();\n        return {\n          changes: newChanges!,\n          removals: newRemovals!,\n          fileTimeInfoEntries,\n          contextTimeInfoEntries\n        };\n      },\n      getContextTimeInfoEntries: () => {\n        const { contextTimeInfoEntries } = this._fetchTimeInfo();\n        return contextTimeInfoEntries;\n      },\n      getFileTimeInfoEntries: () => {\n        const { fileTimeInfoEntries } = this._fetchTimeInfo();\n        return fileTimeInfoEntries;\n      }\n    };\n  }\n\n  private _fetchTimeInfo(): ITimeInfoEntries {\n    const fileTimeInfoEntries: IRawFileSystemMap = new Map();\n    const contextTimeInfoEntries: IRawFileSystemMap = new Map();\n    this.watcher?.collectTimeInfoEntries(fileTimeInfoEntries, contextTimeInfoEntries);\n    return { fileTimeInfoEntries, contextTimeInfoEntries };\n  }\n\n  private _purge(removals: Set<string> | undefined, changes: Set<string> | undefined): void {\n    const fs: InputFileSystem = this.inputFileSystem;\n    if (fs.purge) {\n      if (removals) {\n        for (const removal of removals) {\n          fs.purge(removal);\n        }\n      }\n      if (changes) {\n        for (const change of changes) {\n          fs.purge(change);\n        }\n      }\n    }\n  }\n}\n\nexport class OverrideNodeWatchFSPlugin implements WebpackPluginInstance {\n  public readonly fileSystems: Set<DeferredWatchFileSystem> = new Set();\n  private readonly _onChange: () => void;\n\n  public constructor(onChange: () => void) {\n    this._onChange = onChange;\n  }\n\n  public apply(compiler: Compiler): void {\n    const watchFileSystem: DeferredWatchFileSystem = new DeferredWatchFileSystem(\n      compiler.inputFileSystem,\n      this._onChange\n    );\n    this.fileSystems.add(watchFileSystem);\n    compiler.watchFileSystem = watchFileSystem;\n  }\n}\n"]}

package/lib/Webpack5Plugin.d.ts

@@ -0,0 +1,37 @@
+import type { HeftConfiguration, IHeftTaskSession, IHeftTaskPlugin } from '@rushstack/heft';
+import type { IWebpackPluginAccessor } from './shared';
+export interface IWebpackPluginOptions {
+    devConfigurationPath: string | undefined;
+    configurationPath: string | undefined;
+}
+/**
+ * @public
+ */
+export declare const PLUGIN_NAME: 'webpack5-plugin';
+/**
+ * @internal
+ */
+export default class Webpack5Plugin implements IHeftTaskPlugin<IWebpackPluginOptions> {
+    private _accessor;
+    private _isServeMode;
+    private _webpack;
+    private _webpackCompiler;
+    private _webpackConfiguration;
+    private _webpackCompilationDonePromise;
+    private _webpackCompilationDonePromiseResolveFn;
+    private _watchFileSystems;
+    private _warnings;
+    private _errors;
+    get accessor(): IWebpackPluginAccessor;
+    apply(taskSession: IHeftTaskSession, heftConfiguration: HeftConfiguration, options: IWebpackPluginOptions): void;
+    private _getWebpackConfigurationAsync;
+    private _loadWebpackAsync;
+    private _getWebpackCompilerAsync;
+    private _runWebpackAsync;
+    private _runWebpackWatchAsync;
+    private _validateEnvironmentVariable;
+    private _emitErrors;
+    private _recordErrors;
+    private _normalizeError;
+}
+//# sourceMappingURL=Webpack5Plugin.d.ts.map

package/lib/Webpack5Plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Webpack5Plugin.d.ts","sourceRoot":"","sources":["../src/Webpack5Plugin.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EACV,iBAAiB,EACjB,gBAAgB,EAChB,eAAe,EAIhB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,KAAK,EAAyB,sBAAsB,EAAE,MAAM,UAAU,CAAC;AAI9E,MAAM,WAAW,qBAAqB;IACpC,oBAAoB,EAAE,MAAM,GAAG,SAAS,CAAC;IACzC,iBAAiB,EAAE,MAAM,GAAG,SAAS,CAAC;CACvC;AAED;;GAEG;AACH,eAAO,MAAM,WAAW,EAAE,iBAAqC,CAAC;AAQhE;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,cAAe,YAAW,eAAe,CAAC,qBAAqB,CAAC;IACnF,OAAO,CAAC,SAAS,CAAqC;IACtD,OAAO,CAAC,YAAY,CAAkB;IACtC,OAAO,CAAC,QAAQ,CAA8B;IAC9C,OAAO,CAAC,gBAAgB,CAAyD;IACjF,OAAO,CAAC,qBAAqB,CAA2E;IACxG,OAAO,CAAC,8BAA8B,CAA4B;IAClE,OAAO,CAAC,uCAAuC,CAA2B;IAC1E,OAAO,CAAC,iBAAiB,CAA2C;IAEpE,OAAO,CAAC,SAAS,CAAe;IAChC,OAAO,CAAC,OAAO,CAAe;IAE9B,IAAW,QAAQ,IAAI,sBAAsB,CAe5C;IAEM,KAAK,CACV,WAAW,EAAE,gBAAgB,EAC7B,iBAAiB,EAAE,iBAAiB,EACpC,OAAO,EAAE,qBAAqB,GAC7B,IAAI;YAsBO,6BAA6B;YAmE7B,iBAAiB;YAQjB,wBAAwB;YAcxB,gBAAgB;YA+ChB,qBAAqB;IA2LnC,OAAO,CAAC,4BAA4B;IAYpC,OAAO,CAAC,WAAW;IASnB,OAAO,CAAC,aAAa;IAgCrB,OAAO,CAAC,eAAe;CAmCxB"}