Dependencies webpack plugin: Let the output file be specified when ou…

…tput is combined
WordPress · Mar 12, 2020 · 8ed80ad · 8ed80ad
1 parent 7906556
commit 8ed80ad
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 2 deletions.
diff --git a/packages/dependency-extraction-webpack-plugin/CHANGELOG.md b/packages/dependency-extraction-webpack-plugin/CHANGELOG.md
@@ -1,10 +1,14 @@
 ## Master
 
+### New Features
+
+- The plugin now supports an optional `combinedOutputFile` option that is useful only when another `combineAssets` option is enabled. It allows providing a custom output file for the generated single assets file ([#20844](https://github.com/WordPress/gutenberg/pull/20844)).
+
 ## 2.3.0 (2020-02-21)
 
 ### New Features
 
-- The plugin now supports optional `combineAssets` options. When this flag is set to `true`, all information about assets is combined into a single `assets.(json|php)` file generated in the output directory ([#20330](https://github.com/WordPress/gutenberg/pull/20330)).
+- The plugin now supports optional `combineAssets` option. When this flag is set to `true`, all information about assets is combined into a single `assets.(json|php)` file generated in the output directory ([#20330](https://github.com/WordPress/gutenberg/pull/20330)).
 
 ## 2.0.0 (2019-09-16)
 

diff --git a/packages/dependency-extraction-webpack-plugin/README.md b/packages/dependency-extraction-webpack-plugin/README.md
@@ -123,6 +123,13 @@ The output format for the generated asset file. There are two options available:
 
 By default, one asset file is created for each entry point. When this flag is set to `true`, all information about assets is combined into a single `assets.(json|php)` file generated in the output directory.
 
+##### `combinedOutputFile`
+
+- Type: string
+- Default: `null`
+
+This option is useful only when the `combineAssets` option is enabled. It allows providing a custom output file for the generated single assets file. It's possible to provide a path that is relative to the output directory.
+
 ##### `useDefaults`
 
 - Type: boolean

diff --git a/packages/dependency-extraction-webpack-plugin/index.js b/packages/dependency-extraction-webpack-plugin/index.js
@@ -20,6 +20,7 @@ class DependencyExtractionWebpackPlugin {
 		this.options = Object.assign(
 			{
 				combineAssets: false,
+				combinedOutputFile: null,
 				injectPolyfill: false,
 				outputFormat: 'php',
 				useDefaults: true,
@@ -106,6 +107,7 @@ class DependencyExtractionWebpackPlugin {
 		compiler.hooks.emit.tap( this.constructor.name, ( compilation ) => {
 			const {
 				combineAssets,
+				combinedOutputFile,
 				injectPolyfill,
 				outputFormat,
 			} = this.options;
@@ -180,7 +182,8 @@ class DependencyExtractionWebpackPlugin {
 				const outputFolder = compiler.options.output.path;
 				const assetsFilePath = path.resolve(
 					outputFolder,
-					'assets.' + ( outputFormat === 'php' ? 'php' : 'json' )
+					combinedOutputFile ||
+						'assets.' + ( outputFormat === 'php' ? 'php' : 'json' )
 				);
 				const assetsFilename = path.relative(
 					outputFolder,