tradie-webpack-scripts v6.0.0

tradie-webpack-scripts

DEPRECATED

Scripts for building, serving and testing using Webpack and Jest.

API

clean(options)

Remove all temporary and generated files.

Parameters:

• options : Object
  • globs : Array<String> - The file paths to remove.

Returns:

A Promise. The promise is resolved when the temporary and generated files have been successfully removed. The promise is rejected when the deletion fails to remove files.

serve(options)

Start a dev-server, compile vendor, client, build and server bundles, whilst reporting errors and warnings to the user.

Parameters:

• options : Object
  • watch : boolean - Whether to re-compile the vendor, client and build bundles when the source files change
  • webpack : Object
    • vendor : Object - Webpack configuration for the vendor bundle
    • client : Object - Webpack configuration for the client bundle
    • build : Object - Webpack configuration for the build bundle
    • server : Object - Webpack configuration for the server bundle
  • onServerStart : Function - Can call server.use(). Returns a promise.
  • onServerStop : Function - Can call server.use(). Returns a promise.

Returns:

A Promise. The promise is resolved when the bundles have been successfully compiled. The promise is rejected when the compilation has failed with errors. In watch-mode the promise is resolved when an interrupt signal is received.

build(options)

Compile vendor, client, build and server bundles, whilst reporting errors and warnings to the user.

Parameters:

• options : Object
  • watch : boolean - Whether to re-compile the vendor, client and build bundles when the source files change
  • webpack : Object
    • vendor : Object - Webpack configuration for the vendor bundle
    • client : Object - Webpack configuration for the client bundle
    • build : Object - Webpack configuration for the build bundle
    • server : Object - Webpack configuration for the server bundle

Returns:

A Promise. The promise is resolved when the bundles have been successfully compiled. The promise is rejected when the compilation has failed with errors. In watch-mode the promise is resolved when an interrupt signal is received.

test(options)

Compile a test bundle in memory, whilst reporting errors and warnings to the user.

Parameters:

• options : Object
  • watch : boolean - Whether to re-compile the test bundle when the source files change
  • jest : Object - Jest configuration

Returns:

A Promise. The promise is resolved when the bundle has been successfully compiled and run. The promise is rejected when the compilation has failed with errors or has failed to run. In watch-mode the promise is resolved when an interrupt signal is received.