Webpkr Plugins API

Plugins are an easy way to extend core webpkr functionality:

Provide specialized script blocks (e.g. EnvPlugin provides environment script blocks).
Tap into the build cycle.
Extend or mutate build objects.

class webpkr.PluginBase

Base class from which plugins are derived.

constructor(name)

name

{String}

The plugin’s name.

Properties

.builder

Gets the builder with which this plugin is registered.

returns

{Webpkr}

the builder.

.name

Gets the plugin’s name.

returns

{String}

the plugin’s name.

Methods

.afterEvaluate( value )

Called after all nodes are evaluated with the webpack configuration generated during the configuration phase.

value

{Object}

Webpack configuration object.

returns

{Object}

The configuration object (original or mutated).

The plugin can mutate the object and must return either the original or the mutated value. Plugins are called sequentially, the next receiving the value returned from the prior and the value returned from the final plugin is returned to the caller.

.afterNodeEvaluate( node, value )

Called after each node is evaluated with the node and the result of evaluating the node.

node

{ConfigNode}

node that was just evaluated.

value

{Object}

result of evaluating the node.

returns

{Object}

the evaluated value (original or mutated).

The plugin may mutate the object and must return either the original or the mutated value. Plugins are called sequentially, the next receiving the value returned from the prior and the value returned from the final plugin is set on the node as the result of evaluation.

.beforeNodeEvaluate( node )

Called before each node is evaluated with the node.

node

{ConfigNode}

node that is due for evaluation.

returns

{undefined}

none.

.registerObjects( )

Called during initialization to allow the plugin to register global objects such as custom script blocks.

returns

{undefined}

none

.shouldEvaluate( node )

Returns true if the specified node should be considered during evaluation.

node

{ConfigNode}

the node to be evaluated.

returns

{Boolean}

true if the node should be evaluated, else false.

.unregisterObjects( )

Called during cleanup to allow the plugin to release any global objects.

returns

{undefined}

none

Events

.added

Emitted by the plugin after it’s registered with a builder. This is a good time to listen to events on the builder.