Extends Wordpress Dependency Extraction Webpack Plugin to automatically include WooCommerce dependencies in addition to WordPress dependencies.
Installation
Install the module
pnpm install @woocommerce/dependency-extraction-webpack-plugin --save-dev
Usage
Use this as you would Dependency Extraction Webpack Plugin. The API is exactly the same, except that WooCommerce packages are also handled automatically.
const WooCommerceDependencyExtractionWebpackPlugin = require( '@woocommerce/dependency-extraction-webpack-plugin' );
module.exports = {
plugins: [ new WooCommerceDependencyExtractionWebpackPlugin() ],
};
Note: If you plan to extend the webpack configuration from @wordpress/scripts
with WooCommerceDependencyExtractionWebpackPlugin
, be sure to remove the default instance of the plugin:
const defaultConfig = require( '@wordpress/scripts/config/webpack.config' );
const webpackConfig = {
...defaultConfig,
plugins: [
...defaultConfig.plugins.filter(
( plugin ) =>
plugin.constructor.name !== 'DependencyExtractionWebpackPlugin'
),
new WooCommerceDependencyExtractionWebpackPlugin(),
],
};
Additional module requests on top of Wordpress Dependency Extraction Webpack Plugin are:
@woocommerce/data | wc['data'] | wc-store-data | |
@woocommerce/csv-export | wc['csvExport'] | wc-csv | |
@woocommerce/blocks-registry | wc['wcBlocksRegistry'] | wc-blocks-registry | |
@woocommerce/block-data | wc['wcBlocksData'] | wc-blocks-data-store | This dependency does not have an associated npm package |
@woocommerce/settings | wc['wcSettings'] | wc-settings | |
@woocommerce/* | wc['*'] | wc-* | |
Options
An object can be passed to the constructor to customize the behavior, for example:
module.exports = {
plugins: [
new WooCommerceDependencyExtractionWebpackPlugin( {
bundledPackages: [ '@woocommerce/components' ],
} ),
],
};
bundledPackages
A list of potential WooCommerce excluded packages, this will include the excluded package within the bundle (example above).
For more supported options see the original dependency extraction plugin.