Merge pull request #837 from WordPress/add-sniff-rules

Add sniff rules related to Byte Order Mark and Call-time Pass by Reference

phpcs-rulesets/plugin-review.xml

@@ -156,6 +156,16 @@
 		<severity>7</severity>
 	</rule>
 
+	<!-- No ByteOrderMark allowed - important to prevent issues with content being sent before headers. -->
+	<rule ref="Generic.Files.ByteOrderMark">
+		<severity>7</severity>
+	</rule>
+
+	<!-- Call-time pass-by-reference has been deprecated since PHP 5.3 and should not be used. -->
+	<rule ref="Generic.Functions.CallTimePassByReference">
+		<severity>7</severity>
+	</rule>
+
 	<!-- Check for missing required function parameters. -->
 	<rule ref="PluginCheck.CodeAnalysis.RequiredFunctionParameters">
 		<severity>7</severity>

tests/phpunit/testdata/plugins/test-plugin-review-phpcs-errors/file-with-bom.php

@@ -0,0 +1,3 @@
+<?php
+echo 'foo';
+?>

tests/phpunit/testdata/plugins/test-plugin-review-phpcs-errors/load.php

@@ -35,3 +35,4 @@
 
 $encoded_value = json_encode( array( 'key' => 'value' ) );
 
+custom_function(&$myvar);

tests/phpunit/tests/Checker/Checks/Plugin_Review_PHPCS_Check_Tests.php

@@ -23,6 +23,7 @@ public function test_run_with_errors() {
 
 		$this->assertNotEmpty( $errors );
 		$this->assertArrayHasKey( 'load.php', $errors );
+		$this->assertArrayHasKey( 'file-with-bom.php', $errors );
 		$this->assertNotEmpty( $warnings );
 		$this->assertArrayHasKey( 'load.php', $warnings );
 
@@ -44,6 +45,12 @@ public function test_run_with_errors() {
 		// Check for PluginCheck.CodeAnalysis.RequiredFunctionParameters.parse_str_resultMissing error on Line no 34 and column no at 1.
 		$this->assertSame( 'PluginCheck.CodeAnalysis.RequiredFunctionParameters.parse_str_resultMissing', $errors['load.php'][34][1][0]['code'] );
 
+		// Check for Generic.Functions.CallTimePassByReference.NotAllowed error on Line no 38 and column no 16.
+		$this->assertSame( 'Generic.Functions.CallTimePassByReference.NotAllowed', $errors['load.php'][38][16][0]['code'] );
+
+		// Check for Generic.Files.ByteOrderMark.Found error on Line no 1 and column no 1.
+		$this->assertSame( 'Generic.Files.ByteOrderMark.Found', $errors['file-with-bom.php'][1][1][0]['code'] );
+
 		// There should not be WordPress.WP.AlternativeFunctions.json_encode_json_encode error on Line no 36 and column no at 18.
 		$this->assertCount( 0, wp_list_filter( $errors['load.php'][36][18], array( 'code' => 'WordPress.WP.AlternativeFunctions.json_encode_json_encode' ) ) );