felixarntz · Apr 5, 2023 · Mar 2, 2023 · Mar 2, 2023 · Mar 2, 2023 · Mar 2, 2023
@@ -38,6 +38,10 @@ const {
 	handler: translationsHandler,
 	options: translationsOptions,
 } = require( './commands/translations' );
+const {
+	handler: buildPluginsHandler,
+	options: buildPluginsOptions,
+} = require( './commands/build-plugins' );
 const {
 	handler: enabledModulesHandler,
 	options: enabledModulesOptions,
@@ -69,6 +73,13 @@ withOptions( program.command( 'module-translations' ), translationsOptions )
 	)
 	.action( catchException( translationsHandler ) );
 
+withOptions( program.command( 'build-standalone-plugins' ), buildPluginsOptions )
+	.alias( 'build-plugins' )
+	.description(
+		'Build standalone plugins'
+	)
+	.action( catchException( buildPluginsHandler ) );
+
 withOptions(
 	program.command( 'default-enabled-modules' ),
 	enabledModulesOptions

@@ -0,0 +1,214 @@
+/**
+ * External dependencies
+ */
+const fs = require( 'fs-extra' );
+const path = require( 'path' );
+const glob = require( 'fast-glob' );
+
+/**
+ * Internal dependencies
+ */
+const { log, formats } = require( '../lib/logger' );
+const { getModuleDataFromHeader, getModuleHeader } = require( './common' );
+
+exports.options = [];
+
+/**
+ * Command for copying the files required for the standalone plugin.
+ */
+exports.handler = async () => {
+	const pluginsFile = path.join( '.', 'plugins.json' );
+	fs.readFile( pluginsFile, 'utf8', ( err, jsonString ) => {
+		if ( err ) {
+			log(
+				formats.error(
+					`Error reading file from disk: "${ err }"`
+				)
+			);
+		}
+
+		try {
+			const plugins = JSON.parse( jsonString );
+			for ( const moduleDir in plugins ) {
+				const pluginVersion = plugins[ moduleDir ]?.version;
+				const pluginSlug = plugins[ moduleDir ]?.slug;
+
+				if ( ! pluginVersion || ! pluginSlug ) {
+					log(
+						formats.error(
+							'The given module configuration is invalid, the module JSON object is missing the "version" and/or "slug" properties, or they are misspelled.'
+						)
+					);
+					return;
+				}
+
+				try {
+					// Copy module files from the folder.
+					const modulePath = path.join( '.', 'modules/' + moduleDir );
+					const buildModulePath = path.join( '.', 'build/' + pluginSlug );
+					try {
+						// Clean up build module files directory.
+						fs.rmSync( buildModulePath, { force: true, recursive: true } );
+
+						fs.copySync( modulePath, buildModulePath, { overwrite: true } );
+					} catch ( copyError ) {
+						log(
+							formats.error(
+								`Error copying files for plugin "${ pluginSlug }": "${ copyError }"`
+							)
+						);
+						continue;
+					}
+
+					// Update file content.
+					updatePluginHeader( {
+						modulePath: moduleDir,
+						slug: pluginSlug,
+						version: pluginVersion,
+						pluginPath: buildModulePath,
+					} );
+
+					// Update text domain.
+					updateModuleDetails( {
+						pluginPath: buildModulePath,
+						regex: '[\']performance-lab[\']',
+						result: `'${ pluginSlug }'`,
+					} );
+
+					// Update `@package`.
+					updateModuleDetails( {
+						pluginPath: buildModulePath,
+						regex: '@package\\s{1,}performance-lab',
+						result: '@package ' + pluginSlug,
+					} );
+				} catch ( error ) {
+					log(
+						formats.error(
+							`${ error }`
+						)
+					);
+				}
+			}
+		} catch ( jsonError ) {
+			log(
+				formats.error(
+					`Error parsing JSON string: "${ jsonError }"`
+				)
+			);
+		}
+	} );
+};
+
+/**
+ * Updates the `load.php` file header information.
+ *
+ * @param {Object} settings Plugin settings.
+ */
+async function updatePluginHeader( settings ) {
+	const { modulePath, version, slug, pluginPath } = settings;
+	// Specific module `load.php` file content.
+	const buildLoadFile = path.join( pluginPath, 'load.php' );
+	let buildLoadFileContent = '';
+	try {
+		buildLoadFileContent = fs.readFileSync( buildLoadFile, 'utf-8' );
+	} catch ( err ) {
+		log(
+			formats.error(
+				`Error reading the file "${ buildLoadFile }": "${ err }"`
+			)
+		);
+	}
+
+	if ( buildLoadFileContent === '' ) {
+		log(
+			formats.error(
+				`Error reading the file "${ buildLoadFile }"`
+			)
+		);
+		return false;
+	}
+	const moduleHeader = await getModuleHeader( buildLoadFileContent );
+
+	// Get module header data.
+	const { name, description } = await getModuleDataFromHeader( moduleHeader );
+
+	const pluginHeader = `/**
+ * Plugin Name: ${ name }
+ * Plugin URI: https://github.com/WordPress/performance/tree/trunk/modules/${ modulePath }
+ * Description: ${ description }
+ * Requires at least: 6.1
+ * Requires PHP: 5.6
+ * Version: ${ version }
+ * Author: WordPress Performance Team
+ * Author URI: https://make.wordpress.org/performance/
+ * License: GPLv2 or later
+ * License URI: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
+ * Text Domain: ${ slug }
+ *
+ * @package ${ slug }
+ `;
+	try {
+		// Replace the module file header.
+		fs.writeFileSync( buildLoadFile, buildLoadFileContent.replace( moduleHeader, pluginHeader ) );
+	} catch ( error ) {
+		log(
+			formats.error(
+				`Error replacing module file header: "${ error }"`
+			)
+		);
+	}
+}
+
+/**
+ * Updates the text domain and package details in the build folder files content.
+ *
+ * @param {Object} settings Plugin settings.
+ */
+async function updateModuleDetails( settings ) {
+	const patterns = [
+		path.resolve( settings.pluginPath, './**/*.php' ),
+	];
+
+	const files = await glob( patterns, {
+		ignore: [ __filename ],
+	} );
+
+	const regexp = new RegExp( settings.regex, 'gm' );
+
+	files.forEach( ( file ) => {
+		let content = '';
+		try {
+			content = fs.readFileSync( file, 'utf-8' );
+		} catch ( err ) {
+			log(
+				formats.error(
+					`Error reading the file "${ file }": "${ err }"`
+				)
+			);
+		}
+
+		if ( content === '' ) {
+			log(
+				formats.error(
+					`Error reading the file "${ file }"`
+				)
+			);
+			return false;
+		}
+
+		if ( regexp.test( content ) ) {
+			try {
+				fs.writeFileSync(
+					file,
+					content.replace( regexp, `${ settings.result }` )
+				);
+			} catch ( error ) {
+				log(
+					formats.error(
+						`Error replacing content for regex "${ settings.regex }": "${ error }"`
+					)
+				);
+			}
+		}
+	} );
+}
@@ -32,7 +32,6 @@ const FOCUS_AREAS = {
  * Returns a promise resolving to the list of data for all modules.
  *
  * @param {string} modulesDir Modules directory.
- *
  * @return {Promise<[]WPModuleData>} Promise resolving to module data list.
  */
 exports.getModuleData = async ( modulesDir ) => {
@@ -41,44 +40,25 @@ exports.getModuleData = async ( modulesDir ) => {
 
 	return moduleFiles
 		.map( ( moduleFile ) => {
+			let moduleFileContent = '';
+			try {
+				moduleFileContent = fs.readFileSync( moduleFile, 'utf-8' );
+			} catch ( error ) {
+				log(
+					formats.error(
+						`Error reading the file "${ moduleFile }": "${ error }"`
+					)
+				);
+			}
+			const moduleHeader = exports.getModuleHeader( moduleFileContent );
+
 			// Populate slug and focus based on file path.
 			const moduleDir = path.dirname( moduleFile );
 			const moduleData = {
 				slug: path.basename( moduleDir ),
 				focus: path.basename( path.dirname( moduleDir ) ),
+				...exports.getModuleDataFromHeader( moduleHeader ),
 			};
-
-			// Map of module header => object property.
-			const headers = {
-				'Module Name': 'name',
-				Description: 'description',
-				Experimental: 'experimental',
-			};
-
-			// Populate name, description and experimental based on module file headers.
-			const fileContent = fs.readFileSync( moduleFile, 'utf8' );
-			const regex = new RegExp(
-				`^(?:[ \t]*<?php)?[ \t/*#@]*(${ Object.keys( headers ).join(
-					'|'
-				) }):(.*)$`,
-				'gmi'
-			);
-			let match = regex.exec( fileContent );
-			while ( match ) {
-				const content = match[ 2 ].trim();
-				const prop = headers[ match[ 1 ] ];
-				if ( content && prop ) {
-					moduleData[ prop ] = content;
-				}
-				match = regex.exec( fileContent );
-			}
-
-			// Parse experimental field into a boolean.
-			if ( typeof moduleData.experimental === 'string' ) {
-				moduleData.experimental =
-					moduleData.experimental.toLowerCase() === 'yes';
-			}
-
 			return moduleData;
 		} )
 		.filter( ( moduleData ) => {
@@ -133,3 +113,55 @@ exports.getModuleData = async ( modulesDir ) => {
 			return firstModule.slug.localeCompare( secondModule.slug );
 		} );
 };
+
+/**
+ * Returns the list of module data for module.
+ *
+ * @param {string} moduleHeader Modules file header contetnt.
+ * @return {WPModuleData} Module data.
+ */
+exports.getModuleDataFromHeader = ( moduleHeader ) => {
+	const moduleData = {};
+	// Map of module header => object property.
+	const headers = {
+		'Module Name': 'name',
+		Description: 'description',
+		Experimental: 'experimental',
+	};
+
+	const regex = new RegExp(
+		`^(?:[ \t]*<?php)?[ \t/*#@]*(${ Object.keys( headers ).join(
+			'|'
+		) }):(.*)$`,
+		'gmi'
+	);
+	let match = regex.exec( moduleHeader );
+	while ( match ) {
+		const content = match[ 2 ].trim();
+		const prop = headers[ match[ 1 ] ];
+		if ( content && prop ) {
+			moduleData[ prop ] = content;
+		}
+		match = regex.exec( moduleHeader );
+	}
+
+	// Parse experimental field into a boolean.
+	if ( typeof moduleData.experimental === 'string' ) {
+		moduleData.experimental =
+		moduleData.experimental.toLowerCase() === 'yes';
+	}
+
+	return moduleData;
+};
+
+/**
+ * Returns the file header.
+ *
+ * @param {string} moduleFileContent Module file content.
+ * @return {string} Module file header.
+ */
+exports.getModuleHeader = ( moduleFileContent ) => {
+	const regex = /\/\\*\\*[\s\S]+?(?=\*\/)/mi;
+	const moduleHeader = moduleFileContent.match( regex )?.[ 0 ];
+	return moduleHeader;
+};
diff --git a/modules/images/webp-uploads/load.php b/modules/images/webp-uploads/load.php
@@ -8,6 +8,37 @@
  * @package performance-lab
  */
 
+/**
+ * Determines whether the feature can be loaded, or whether is already merged into WordPress core.
+ *
+ * If it cannot be loaded, it will add an action to display a WordPress admin notice.
+ *
+ * @since n.e.x.t
+ *
+ * @return bool Whether the feature can be loaded.
+ */
+function webp_uploads_can_load() {
+	$can_load = require __DIR__ . '/can-load.php';
+	if ( $can_load() ) {
+		return true;
+	}
+	add_action(
+		'admin_notices',
+		function() {
+			printf(
+				'<div class="notice notice-error"><p>%s</p></div>',
+				esc_html__( 'The WebP Uploads feature cannot be loaded from within the plugin since it is already merged into WordPress core.', 'performance-lab' )
+			);
+		}
+	);
+	return false;
+}
+
+// Do not run the plugin if conditions are not met.
+if ( ! webp_uploads_can_load() ) {
+	return;
+}
+
 /**
  * Require helper functions and specific integrations.
  */