Use template for phpcs.xml.dist with customizable prefix

Co-authored-by: swissspidy <[email protected]>

Author: Copilot

features/scaffold-package.feature

@@ -23,6 +23,10 @@ Feature: Scaffold WP-CLI commands
       """
       WP_CLI_CS
       """
+    And the {PACKAGE_PATH}/local/wp-cli/foo/phpcs.xml.dist file should contain:
+      """
+      wpcli_foo
+      """
     And the {PACKAGE_PATH}/local/wp-cli/foo/composer.json file should exist
     And the {PACKAGE_PATH}/local/wp-cli/foo/composer.json file should contain:
       """

src/ScaffoldPackageCommand.php

@@ -87,6 +87,9 @@ public function package( $args, $assoc_args ) {
 			WP_CLI::error( "'{$assoc_args['name']}' is an invalid package name. Package scaffold expects '<author>/<package>'." );
 		}
 
+		// Generate a slug from the package name for use in prefixes.
+		$assoc_args['package_name_slug'] = str_replace( '-', '_', $bits[1] );
+
 		if ( ! empty( $assoc_args['dir'] ) ) {
 			$package_dir = $assoc_args['dir'];
 		} else {
@@ -118,7 +121,7 @@ public function package( $args, $assoc_args ) {
 				"{$package_dir}/.gitignore"                => file_get_contents( "{$package_root}/.gitignore" ),
 				"{$package_dir}/.editorconfig"             => file_get_contents( "{$package_root}/.editorconfig" ),
 				"{$package_dir}/.distignore"               => file_get_contents( "{$package_root}/.distignore" ),
-				"{$package_dir}/phpcs.xml.dist"            => file_get_contents( "{$package_root}/phpcs.xml.dist" ),
+				"{$package_dir}/phpcs.xml.dist"            => Utils\mustache_render( "{$template_path}/phpcs.xml.dist.mustache", $assoc_args ),
 				"{$package_dir}/CONTRIBUTING.md"           => file_get_contents( "{$package_root}/CONTRIBUTING.md" ),
 				"{$package_dir}/wp-cli.yml"                => $wp_cli_yml,
 				"{$package_dir}/hello-world-command.php"   => Utils\mustache_render( "{$template_path}/hello-world-command.mustache", $assoc_args ),

templates/phpcs.xml.dist.mustache

@@ -0,0 +1,54 @@
+<?xml version="1.0"?>
+<ruleset name="WP-CLI-{{package_name_slug}}">
+	<description>Custom ruleset for WP-CLI {{name}}</description>
+
+	<!--
+	#############################################################################
+	COMMAND LINE ARGUMENTS
+	For help understanding this file: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml
+	For help using PHPCS: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Usage
+	#############################################################################
+	-->
+
+	<!-- What to scan. -->
+	<file>.</file>
+
+	<!-- Show progress. -->
+	<arg value="p"/>
+
+	<!-- Strip the filepaths down to the relevant bit. -->
+	<arg name="basepath" value="./"/>
+
+	<!-- Check up to 8 files simultaneously. -->
+	<arg name="parallel" value="8"/>
+
+	<!--
+	#############################################################################
+	USE THE WP_CLI_CS RULESET
+	#############################################################################
+	-->
+
+	<rule ref="WP_CLI_CS"/>
+
+	<!--
+	#############################################################################
+	PROJECT SPECIFIC CONFIGURATION FOR SNIFFS
+	#############################################################################
+	-->
+
+	<!-- For help understanding the `testVersion` configuration setting:
+		 https://github.com/PHPCompatibility/PHPCompatibility#sniffing-your-code-for-compatibility-with-specific-php-versions -->
+	<config name="testVersion" value="7.2-"/>
+
+	<!-- Verify that everything in the global namespace is either namespaced or prefixed.
+		 See: https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/wiki/Customizable-sniff-properties#naming-conventions-prefix-everything-in-the-global-namespace -->
+	<rule ref="WordPress.NamingConventions.PrefixAllGlobals">
+		<properties>
+			<property name="prefixes" type="array">
+				<element value="WP_CLI"/><!-- Namespaces. -->
+				<element value="wpcli_{{package_name_slug}}"/><!-- Global variables and such. -->
+			</property>
+		</properties>
+	</rule>
+
+</ruleset>