Scripts: Use fork of rtlcss-webpack-plugin to fix issues with deps (#…

…68201) * Scripts: Use fork of `rtlcss-webpack-plugin` to fix issues with dependencies * Update the changelog entry * Fix path in the moved plugin * Fix path to PhpFilePathsPlugin in webpack config Co-authored-by: gziolo <gziolo@git.wordpress.org> Co-authored-by: manzoorwanijk <manzoorwanijk@git.wordpress.org> Co-authored-by: stein2nd <stein2nd@git.wordpress.org>
WordPress · Dec 24, 2024 · af0e277 · af0e277 · github-actions · Dec 24, 2024
1 parent 500883f
commit af0e277
Show file tree

Hide file tree

Showing 9 changed files with 85 additions and 126 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -152,7 +152,7 @@
 		"redux": "5.0.1",
 		"resize-observer-polyfill": "1.5.1",
 		"rimraf": "5.0.10",
-		"rtlcss": "4.0.0",
+		"rtlcss": "4.3.0",
 		"sass": "1.50.1",
 		"sass-loader": "16.0.3",
 		"semver": "7.5.4",

diff --git a/packages/scripts/CHANGELOG.md b/packages/scripts/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Internal
+
+-   The bundled `rtlcss-webpack-plugin` dependency has been replaced with a modified fork of the plugin to fix issues with the original package ([#68201](https://github.com/WordPress/gutenberg/pull/68201)).
+
 ## 30.7.0 (2024-12-11)
 
 ### Internal

diff --git a/packages/scripts/config/webpack.config.js b/packages/scripts/config/webpack.config.js
@@ -9,7 +9,6 @@ const browserslist = require( 'browserslist' );
 const MiniCSSExtractPlugin = require( 'mini-css-extract-plugin' );
 const { basename, dirname, relative, resolve, sep } = require( 'path' );
 const ReactRefreshWebpackPlugin = require( '@pmmmwh/react-refresh-webpack-plugin' );
-const RtlCssPlugin = require( 'rtlcss-webpack-plugin' );
 const TerserPlugin = require( 'terser-webpack-plugin' );
 const { realpathSync } = require( 'fs' );
 const { sync: glob } = require( 'fast-glob' );
@@ -23,6 +22,8 @@ const postcssPlugins = require( '@wordpress/postcss-plugins-preset' );
 /**
  * Internal dependencies
  */
+const PhpFilePathsPlugin = require( '../plugins/php-file-paths-plugin' );
+const RtlCssPlugin = require( '../plugins/rtlcss-webpack-plugin' );
 const {
 	fromConfigRoot,
 	hasBabelConfig,
@@ -35,7 +36,6 @@ const {
 	getBlockJsonModuleFields,
 	getBlockJsonScriptFields,
 	fromProjectRoot,
-	PhpFilePathsPlugin,
 } = require( '../utils' );
 
 const isProduction = process.env.NODE_ENV === 'production';
@@ -396,9 +396,7 @@ const scriptConfig = {
 			filename: '[name].css',
 		} ),
 		// RtlCssPlugin to generate RTL CSS files.
-		new RtlCssPlugin( {
-			filename: `[name]-rtl.css`,
-		} ),
+		new RtlCssPlugin(),
 		// React Fast Refresh.
 		hasReactFastRefresh && new ReactRefreshWebpackPlugin(),
 		// WP_NO_EXTERNALS global variable controls whether scripts' assets get

diff --git a/packages/scripts/package.json b/packages/scripts/package.json
@@ -80,7 +80,7 @@
 		"react-refresh": "^0.14.0",
 		"read-pkg-up": "^7.0.1",
 		"resolve-bin": "^0.4.0",
-		"rtlcss-webpack-plugin": "^4.0.7",
+		"rtlcss": "^4.3.0",
 		"sass": "^1.50.1",
 		"sass-loader": "^16.0.3",
 		"schema-utils": "^4.2.0",

diff --git a/...es/scripts/utils/php-file-paths-plugin.js → ...ts/plugins/php-file-paths-plugin/index.js b/...es/scripts/utils/php-file-paths-plugin.js → ...ts/plugins/php-file-paths-plugin/index.js
@@ -6,7 +6,7 @@ const { validate } = require( 'schema-utils' );
 /**
  * Internal dependencies
  */
-const { getPhpFilePaths } = require( './config' );
+const { getPhpFilePaths } = require( '../../utils' );
 
 const phpFilePathsPluginSchema = {
 	type: 'object',
@@ -57,4 +57,4 @@ class PhpFilePathsPlugin {
 	}
 }
 
-module.exports = { PhpFilePathsPlugin };
+module.exports = PhpFilePathsPlugin;
diff --git a/packages/scripts/plugins/rtlcss-webpack-plugin/index.js b/packages/scripts/plugins/rtlcss-webpack-plugin/index.js
@@ -0,0 +1,66 @@
+/**
+ * Parts of this source were derived and modified from the package
+ * rtlcss-webpack-plugin, released under the MIT license.
+ *
+ * https://github.com/wix-incubator/rtlcss-webpack-plugin
+ *
+ * Copyright (c) 2018 Wix.com
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+/**
+ * External dependencies
+ */
+const path = require( 'node:path' );
+const rtlcss = require( 'rtlcss' );
+const webpack = require( 'webpack' );
+
+const cssOnly = ( filename ) => path.extname( filename ) === '.css';
+
+class RtlCssPlugin {
+	processAssets = ( compilation, callback ) => {
+		const chunks = Array.from( compilation.chunks );
+
+		// Explore each chunk (build output):
+		chunks.forEach( ( chunk ) => {
+			// Explore each asset filename generated by the chunk:
+			const files = Array.from( chunk.files );
+
+			files.filter( cssOnly ).forEach( ( filename ) => {
+				// Get the asset source for each file generated by the chunk:
+				const src = compilation.assets[ filename ].source();
+				const dst = rtlcss.process( src );
+				const dstFileName = compilation.getPath( '[name]-rtl.css', {
+					chunk,
+					cssFileName: filename,
+				} );
+
+				compilation.assets[ dstFileName ] =
+					new webpack.sources.RawSource( dst );
+				chunk.files.add( dstFileName );
+			} );
+		} );
+
+		callback();
+	};
+
+	apply( compiler ) {
+		compiler.hooks.compilation.tap( 'RtlCssPlugin', ( compilation ) => {
+			compilation.hooks.processAssets.tapAsync(
+				{
+					name: 'TPAStylePlugin.pluginName',
+					stage: compilation.PROCESS_ASSETS_STAGE_OPTIMIZE,
+				},
+				( chunks, callback ) =>
+					this.processAssets( compilation, callback )
+			);
+		} );
+	}
+}
+
+module.exports = RtlCssPlugin;
diff --git a/packages/scripts/utils/index.js b/packages/scripts/utils/index.js
@@ -29,7 +29,6 @@ const {
 	getBlockJsonModuleFields,
 	getBlockJsonScriptFields,
 } = require( './block-json' );
-const { PhpFilePathsPlugin } = require( './php-file-paths-plugin' );
 
 module.exports = {
 	fromProjectRoot,
@@ -56,6 +55,5 @@ module.exports = {
 	hasPostCSSConfig,
 	hasPrettierConfig,
 	hasProjectFile,
-	PhpFilePathsPlugin,
 	spawnScript,
 };
diff --git a/tools/webpack/blocks.js b/tools/webpack/blocks.js
@@ -8,7 +8,7 @@ const { realpathSync } = require( 'fs' );
 /**
  * WordPress dependencies
  */
-const { PhpFilePathsPlugin } = require( '@wordpress/scripts/utils' );
+const PhpFilePathsPlugin = require( '@wordpress/scripts/plugins/php-file-paths-plugin' );
 
 /**
  * Internal dependencies