Installation

Overview

Usage

VersionDetection

import{VersionDetection}from"@rushstack/webpack-plugin-utilities"classMyExampleWebpackPlugin{constructor(){this.pluginName="MyExampleWebpackPlugin"}apply(compiler){if(VersionDetection.isWebpack3OrEarlier(compiler)){thrownewError(`This plugin does not support webpack 3 or below.`)}constisWebpack4=VersionDetection.isWebpack4(compiler);if(isWebpack4){compiler.hooks.compilation.tap(this.pluginName,(compilation)=>{// ....});}else{compiler.hooks.compilation.tap(this.pluginName,(compilation)=>{// ...});}}}

Testing

getTestingWebpackCompiler

import{getTestingWebpackCompiler}from"@rushstack/webpack-plugin-utilities"describe("MyPlugin",()=>{it("should run",async()=>{conststats=awaitgetTestingWebpackCompiler("./src/index.ts");expect(stats).toBeDefined();});});

getTestingWebpackCompiler with additional configuration

import{getTestingWebpackCompiler}from"@rushstack/webpack-plugin-utilities"describe("MyPlugin",()=>{it("should run",async()=>{conststats=awaitgetTestingWebpackCompiler("./src/index.ts",{mode:"production",});expect(stats).toBeDefined();});});

getTestingWebpackCompiler with virtual filesystem

import{getTestingWebpackCompiler}from"@rushstack/webpack-plugin-utilities"import{createFsFromVolume,Volume,IFs}from"memfs"importpathfrom"path"describe("MyPlugin",()=>{it("should run",async()=>{constvirtualFileSystem:IFs=createFsFromVolume(newVolume());conststats=awaitgetTestingWebpackCompiler(`./src/index.ts`,{},virtualFileSystem);expect(stats).toBeDefined();expect(virtualFileSystem.existsSync(path.join(__dirname,"dist","index.js"))).toBe(true);});});

Links