DependencyExtractionWebpackPlugin: Add boolean shorthand for requestT…

…oExternalModule (#57593)

The most common usage of the `requestToExternalModule` option is
to return the same requested module ID that was passed in. A shorthand
boolean return value is added support this behavior without returning
the original requested module ID.

packages/dependency-extraction-webpack-plugin/README.md

@@ -267,14 +267,17 @@ module.exports = {
  *
  * @param {string} request Requested module
  *
- * @return {(string|undefined)} Script global
+ * @return {(string|boolean|undefined)} Module ID
  */
 function requestToExternalModule( request ) {
 	// Handle imports like `import myModule from 'my-module'`
 	if ( request === 'my-module' ) {
-		// Import should be ov the form `import { something } from "myModule";` in the final bundle.
+		// Import should be of the form `import { something } from "myModule";` in the final bundle.
 		return 'myModule';
 	}
+
+	// If the Module ID in source is the same as the external module, we can return `true`.
+	return request === 'external-module-id-no-change-required';
 }
 
 module.exports = {

packages/dependency-extraction-webpack-plugin/lib/index.js

@@ -82,6 +82,10 @@ class DependencyExtractionWebpackPlugin {
 				: defaultRequestToExternal( request );
 		}
 
+		if ( this.useModules && externalRequest === true ) {
+			externalRequest = request;
+		}
+
 		if ( externalRequest ) {
 			this.externalizedDeps.add( request );
 

packages/dependency-extraction-webpack-plugin/lib/types.d.ts

@@ -13,7 +13,9 @@ declare interface DependencyExtractionWebpackPluginOptions {
 	outputFormat?: 'php' | 'json';
 	outputFilename?: string | Function;
 	requestToExternal?: ( request: string ) => string | string[] | undefined;
-	requestToExternalModule?: ( request: string ) => string | undefined;
+	requestToExternalModule?: (
+		request: string
+	) => string | boolean | undefined;
 	requestToHandle?: ( request: string ) => string | undefined;
 	combinedOutputFile?: string | null;
 	combineAssets?: boolean;

packages/dependency-extraction-webpack-plugin/test/fixtures/combine-assets/webpack.config.js

@@ -12,9 +12,7 @@ module.exports = {
 		new DependencyExtractionWebpackPlugin( {
 			combineAssets: true,
 			requestToExternalModule( request ) {
-				if ( request.startsWith( '@wordpress/' ) ) {
-					return request;
-				}
+				return request.startsWith( '@wordpress/' );
 			},
 		} ),
 	],

packages/dependency-extraction-webpack-plugin/test/fixtures/dynamic-import/webpack.config.js

@@ -7,9 +7,7 @@ module.exports = {
 	plugins: [
 		new DependencyExtractionWebpackPlugin( {
 			requestToExternalModule( request ) {
-				if ( request.startsWith( '@wordpress/' ) ) {
-					return request;
-				}
+				return request.startsWith( '@wordpress/' );
 			},
 		} ),
 	],

packages/dependency-extraction-webpack-plugin/test/fixtures/function-output-filename/webpack.config.js

@@ -12,9 +12,7 @@ module.exports = {
 	plugins: [
 		new DependencyExtractionWebpackPlugin( {
 			requestToExternalModule( request ) {
-				if ( request.startsWith( '@wordpress/' ) ) {
-					return request;
-				}
+				return request.startsWith( '@wordpress/' );
 			},
 		} ),
 	],

packages/dependency-extraction-webpack-plugin/test/fixtures/has-extension-suffix/webpack.config.js

@@ -10,9 +10,7 @@ module.exports = {
 	plugins: [
 		new DependencyExtractionWebpackPlugin( {
 			requestToExternalModule( request ) {
-				if ( request.startsWith( '@wordpress/' ) ) {
-					return request;
-				}
+				return request.startsWith( '@wordpress/' );
 			},
 		} ),
 	],

packages/dependency-extraction-webpack-plugin/test/fixtures/option-function-output-filename/webpack.config.js

@@ -10,9 +10,7 @@ module.exports = {
 				return `chunk--${ chunkData.chunk.name }--[name].asset.php`;
 			},
 			requestToExternalModule( request ) {
-				if ( request.startsWith( '@wordpress/' ) ) {
-					return request;
-				}
+				return request.startsWith( '@wordpress/' );
 			},
 		} ),
 	],

packages/dependency-extraction-webpack-plugin/test/fixtures/option-output-filename/webpack.config.js

@@ -8,9 +8,7 @@ module.exports = {
 		new DependencyExtractionWebpackPlugin( {
 			outputFilename: '[name]-foo.asset.php',
 			requestToExternalModule( request ) {
-				if ( request.startsWith( '@wordpress/' ) ) {
-					return request;
-				}
+				return request.startsWith( '@wordpress/' );
 			},
 		} ),
 	],

packages/dependency-extraction-webpack-plugin/test/fixtures/overrides/webpack.config.js

@@ -23,9 +23,7 @@ module.exports = {
 				if ( request === 'rxjs/operators' ) {
 					return request;
 				}
-				if ( request.startsWith( '@wordpress/' ) ) {
-					return request;
-				}
+				return request.startsWith( '@wordpress/' );
 			},
 			requestToHandle( request ) {
 				if ( request === 'rxjs' || request === 'rxjs/operators' ) {

packages/dependency-extraction-webpack-plugin/test/fixtures/runtime-chunk-single/webpack.config.js

@@ -11,9 +11,7 @@ module.exports = {
 	plugins: [
 		new DependencyExtractionWebpackPlugin( {
 			requestToExternalModule( request ) {
-				if ( request.startsWith( '@wordpress/' ) ) {
-					return request;
-				}
+				return request.startsWith( '@wordpress/' );
 			},
 		} ),
 	],

packages/dependency-extraction-webpack-plugin/test/fixtures/style-imports/webpack.config.js

@@ -12,9 +12,7 @@ module.exports = {
 	plugins: [
 		new DependencyExtractionWebpackPlugin( {
 			requestToExternalModule( request ) {
-				if ( request.startsWith( '@wordpress/' ) ) {
-					return request;
-				}
+				return request.startsWith( '@wordpress/' );
 			},
 		} ),
 		new MiniCSSExtractPlugin(),

packages/dependency-extraction-webpack-plugin/test/fixtures/wordpress-require/webpack.config.js

@@ -7,9 +7,7 @@ module.exports = {
 	plugins: [
 		new DependencyExtractionWebpackPlugin( {
 			requestToExternalModule( request ) {
-				if ( request.startsWith( '@wordpress/' ) ) {
-					return request;
-				}
+				return request.startsWith( '@wordpress/' );
 			},
 		} ),
 	],

packages/dependency-extraction-webpack-plugin/test/fixtures/wordpress/webpack.config.js

@@ -7,9 +7,7 @@ module.exports = {
 	plugins: [
 		new DependencyExtractionWebpackPlugin( {
 			requestToExternalModule( request ) {
-				if ( request.startsWith( '@wordpress/' ) ) {
-					return request;
-				}
+				return request.startsWith( '@wordpress/' );
 			},
 		} ),
 	],