WordPress/gutenberg

DEWP docs and implementation mismatch/confusion in regards of assets file name

Open

#49872 opened on Apr 17, 2023

View on GitHub
 (2 comments) (0 reactions) (1 assignee)JavaScript (9,607 stars) (3,893 forks)batch import
Good First Issue[Tool] Dependency Extraction Webpack Plugin[Type] Developer Documentation

Description

Description

The Dependency Extraction Webpack Plugin docs states:

// Source file entrypoint.js // […] // Webpack will produce the output output/entrypoint.js // […] // Webpack will also produce output/entrypoint.asset.php declaring script dependencies

Therefore, when I have entry: { 'analytics': '…' }, I'd expect the assets file name to be analytics.asset.php.

However, it's effectively different, as per implmentation it takes explicitly output's file name (assetFilename = compilation.getPath( outputFilename). Which can be completely different.

Step-by-step reproduction instructions

  1. Create a bundle that uses DEWP (and default WordPress webpack config)
{
	...require( '@wordpress/scripts/config/webpack.config' ),
	entry: {
		'entrypoint': './path/to/some/index.js',
	},
	output: {
		filename: 'bunny-plugin-[name].min.js',
		path: './output/',
	},
  1. Run the build.
  2. :red_circle: Check that assets file is output/bunny-plugin-entrypoint.min.asset.php not output/entrypoint.asset.php.

So I'd rather describe it as output/filename.asset.php

Screenshots, screen recording, code snippet

No response

Environment info

n/a - I'm using only @wordpress/scripts and @wordpress/dependency-extraction-webpack-plugin

Please confirm that you have searched existing issues in the repo.

Yes

Please confirm that you have tested with all plugins deactivated except Gutenberg.

Yes

Contributor guide