Registry / devops / webpack-plugin-compat

webpack-plugin-compat

library1.0.4jsnpmunverified

A compatibility layer for the webpack plugin API that simplifies supporting both v4 and pre-v4 versions (v3/v2). Current version 1.0.4 adds support for Tapable v2.0. Key differentiators: transparent event name mapping (spaces/hyphens to camelCase), HookMap support via space-delimited tokens, special-cased parser events, and a unified reg/tap API that works across webpack versions. Maintained by the Dojo toolkit team.

devops

npm install webpack-plugin-compat

github ↗package ↗

INSTALL

IMPORT

SIG · WEBPACK-PLUGIN-COM

webpack-plugin-compat

devopsjavascriptv1.0.4

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

Tapable

✓ import { Tapable } from 'webpack-plugin-compat'

✗ const Tapable = require('webpack-plugin-compat')

Named export; requires destructuring from package.

reg

✓ import { reg } from 'webpack-plugin-compat'

✗ const { reg } = require('webpack-plugin-compat').for('myPlugin')

reg is a top-level export; do not chain .for() on import.

tap

✓ import { tap } from 'webpack-plugin-compat/for'; const tapNamed = tap.for('myPlugin');

✗ import { tap } from 'webpack-plugin-compat';

tap is available only via the 'for' submodule. Import from 'webpack-plugin-compat/for' or use tap.for() after import.

Demonstrates basic usage: creating a Tapable plugin object, registering a SyncHook, tapping it with a named plugin, and calling the hook.

import { Tapable, reg } from 'webpack-plugin-compat'; import { tap } from 'webpack-plugin-compat/for'; // Create a plugin instance (Tapable is dummy in webpack v4, real in v3) const plugin = new Tapable(); // Register a hook (noop in webpack v3) reg(plugin, 'myHook', ['Sync', 'arg1', 'arg2']); // Tap into the hook (requires a plugin name via .for) const tapWithName = tap.for('myPlugin'); tapWithName(plugin, 'myHook', (arg1, arg2) => { console.log(arg1, arg2); }); // Trigger the hook plugin.hooks.myHook.call('hello', 'world');

Debug

Known issues

gotchaThe `tap` function is NOT available as a top-level export; you must import from 'webpack-plugin-compat/for' or use `.for('name')` after importing the main module.

fix

Use `import { tap } from 'webpack-plugin-compat/for'` or `const { tap } = require('webpack-plugin-compat/for');`

affects: *

gotchaEvent names are automatically camelCased for webpack v4+. For example, 'my-event' becomes 'myEvent'. This may cause unexpected collisions or mismatches if you rely on exact naming.

fix

Use camelCase event names explicitly to avoid ambiguity, or use HookMap tokens for space-delimited names.

affects: >=1.0.0

breakingIn v1.0.4, support for Tapable v2.0 was added. Plugins relying on Tapable v1 internals may break.

fix

Ensure your code is compatible with Tapable v2 (e.g., no direct access to Tapable internals).

affects: >=1.0.4

deprecatedPre-v4 webpack (v2, v3) are no longer actively maintained. Using this package for new development is discouraged; migrate to webpack 5+.

fix

Upgrade to webpack 5+ and remove this dependency.

affects: *

Errors

Common errors & fixes

TypeError: Cannot read properties of undefined (reading 'tap')

Trying to use `tap` directly from the main import without going through `.for()` or the 'for' submodule.

fix

Use `import { tap } from 'webpack-plugin-compat/for'` and then `tap.for('myPlugin')`.

Error: HookMap not found for 'evaluate typeof require'

The event name includes spaces intended for HookMap matching, but no matching HookMap exists on the plugin object.

fix

Ensure the HookMap is registered via `reg(plugin, 'evaluateTypeof', ...)` or remove spaces from the event name.

Module not found: Can't resolve 'webpack-plugin-compat/for'

The submodule path 'webpack-plugin-compat/for' is not resolved correctly, possibly due to symlinks or missing package exports.

fix

Ensure your package manager resolves the package correctly. Try using a direct import: `const { tap } = require('webpack-plugin-compat').for('name');`

Upgrade

Version history

1.0.4latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

6 hits · last 30 days

node

Resources

githubhttps://github.com/chuckdumont/webpack-plugin-compat ↗

packagehttps://www.npmjs.com/package/webpack-plugin-compat ↗