Merge branch 'master' into 0.4.0-changelog

Author: rebeccahum

README.md

@@ -13,26 +13,28 @@ The ruleset takes advantage of existing rules in the [WordPress-Coding-Standards
 
 Go to https://vip.wordpress.com/documentation/phpcs-review-feedback/ to learn about why various things are flagged as errors vs warnings and what the levels mean for us.
 
-# Installation
+## Installation
 
 
-First, make sure you have WPCS v1+ and PHPCS v3+ installed. If you do not, please refer to the [installation instructions for installing PHP CodeSniffer for WordPress.com VIP](https://vip.wordpress.com/documentation/how-to-install-php-code-sniffer-for-wordpress-com-vip/)
+First, make sure you have WPCS 1.* and PHPCS v3+ installed. If you do not, please refer to the [installation instructions for installing PHP CodeSniffer for WordPress.com VIP](https://vip.wordpress.com/documentation/how-to-install-php-code-sniffer-for-wordpress-com-vip/). Note that VIPCS does not currently work with the `develop` branch of WPCS.
 
 You will also find additional information at the [WordPress Coding Standards for PHP_CodeSniffer project](https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards#installation).
 
 Then, clone this repo to your local machine, and add the standard to PHPCodeSniffer by appending the folder you cloned into to the end of the installed paths. e.g.
 
 `phpcs --config-set installed_paths [/path/to/wpcsstandard],[path/to/vipcsstandard],etc`
 
-## Minimal requirements
+Alternatively, we recommend the [PHP_CodeSniffer Standards Composer Installer Plugin](https://github.com/Dealerdirect/phpcodesniffer-composer-installer), which handles the registration of all of the installed standards, so there is no need to set the `installed_paths` config value manually, for single or multiple standards.
 
-* [PHPCS v3](https://github.com/squizlabs/PHP_CodeSniffer/releases/tag/3.3.0)
-* [WPCS v1.0.0](https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/releases/tag/1.0.0)
+### Minimal requirements
 
-# Setup note
+* [PHPCS 3+](https://github.com/squizlabs/PHP_CodeSniffer/releases)
+* [WPCS 1.*](https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/releases)
+
+### Setup note
 
 Should you wish to run both standards (WordPress.com VIP minimum standard & WordPress.com VIP coding standard), you can add both to PHPCS by running the following configuration command:
 
 `phpcs --config-set installed_paths [/path/to/standard],[path/to/standard]`
 
-(note the comma separating each standard)
+Note the comma separating each standard.

WordPressVIPMinimum/Sniffs/Classes/RestrictedExtendClassesSniff.php

@@ -28,7 +28,7 @@ class RestrictedExtendClassesSniff extends AbstractClassRestrictionsSniff {
 	public function getGroups() {
 		return array(
 			'wp_cli' => array(
-				'type' => 'warning',
+				'type'    => 'warning',
 				'message' => 'We recommend extending `WPCOM_VIP_CLI_Command` instead of `WP_CLI_Command` and using the helper functions available in it (such as `stop_the_insanity()`), see https://vip.wordpress.com/documentation/writing-bin-scripts/ for more information.',
 				'classes' => array(
 					'WP_CLI_Command',

WordPressVIPMinimum/Sniffs/Filters/RestrictedHookSniff.php

@@ -54,15 +54,15 @@ class RestrictedHookSniff extends AbstractFunctionParameterSniff {
 			// WordPress.com: https://lobby.vip.wordpress.com/wordpress-com-documentation/fetching-remote-data/.
 			// VIP Go: https://vip.wordpress.com/documentation/vip-go/fetching-remote-data/.
 			'type' => 'Warning',
-			'msg'     => 'Please ensure that the timeout being filtered is not greater than 3s since remote requests require the user to wait for completion before the rest of the page will load. Manual inspection required.',
-			'code'    => 'HighTimeout',
+			'msg'  => 'Please ensure that the timeout being filtered is not greater than 3s since remote requests require the user to wait for completion before the rest of the page will load. Manual inspection required.',
+			'code' => 'HighTimeout',
 		],
 		'http_request_args' => [
 			// WordPress.com: https://lobby.vip.wordpress.com/wordpress-com-documentation/fetching-remote-data/.
 			// VIP Go: https://vip.wordpress.com/documentation/vip-go/fetching-remote-data/.
 			'type' => 'Warning',
-			'msg'     => 'Please ensure that the timeout being filtered is not greater than 3s since remote requests require the user to wait for completion before the rest of the page will load. Manual inspection required.',
-			'code'    => 'HighTimeout',
+			'msg'  => 'Please ensure that the timeout being filtered is not greater than 3s since remote requests require the user to wait for completion before the rest of the page will load. Manual inspection required.',
+			'code' => 'HighTimeout',
 		],
 	];
 

WordPressVIPMinimum/Sniffs/Functions/StripTagsSniff.php

@@ -34,7 +34,7 @@ class StripTagsSniff extends AbstractFunctionParameterSniff {
 	 *            depending on your needs.
 	 */
 	protected $target_functions = [
-		'strip_tags'    => true,
+		'strip_tags' => true,
 	];
 
 	/**

WordPressVIPMinimum/Sniffs/JS/WindowSniff.php

@@ -59,8 +59,8 @@ public function register() {
 			'port'     => true,
 			'password' => true,
 		],
-		'name'   => true,
-		'status' => true,
+		'name'     => true,
+		'status'   => true,
 	];
 
 	/**
@@ -90,7 +90,7 @@ public function process( File $phpcsFile, $stackPtr ) {
 		}
 
 		$nextTokenPtr = $phpcsFile->findNext( Tokens::$emptyTokens, ( $stackPtr + 1 ), null, true, null, true );
-		$nextToken = $tokens[ $nextTokenPtr ]['code'];
+		$nextToken    = $tokens[ $nextTokenPtr ]['code'];
 		if ( T_OBJECT_OPERATOR !== $nextToken && T_OPEN_SQUARE_BRACKET !== $nextToken ) {
 			// No . or [' next, bail.
 			return;
@@ -109,7 +109,7 @@ public function process( File $phpcsFile, $stackPtr ) {
 		}
 
 		$nextNextNextTokenPtr = $phpcsFile->findNext( array_merge( [ T_CLOSE_SQUARE_BRACKET ], Tokens::$emptyTokens ), ( $nextNextTokenPtr + 1 ), null, true, null, true );
-		$nextNextNextToken = $tokens[ $nextNextNextTokenPtr ]['code'];
+		$nextNextNextToken    = $tokens[ $nextNextNextTokenPtr ]['code'];
 
 		$nextNextNextNextToken = false;
 		if ( T_OBJECT_OPERATOR === $nextNextNextToken || T_OPEN_SQUARE_BRACKET === $nextNextNextToken ) {
@@ -126,7 +126,7 @@ public function process( File $phpcsFile, $stackPtr ) {
 			}
 		}
 
-		$windowProperty = 'window.';
+		$windowProperty  = 'window.';
 		$windowProperty .= $nextNextNextNextToken ? $nextNextToken . '.' . $nextNextNextNextToken : $nextNextToken;
 
 		$prevTokenPtr = $phpcsFile->findPrevious( Tokens::$emptyTokens, ( $stackPtr - 1 ), null, true, null, true );

WordPressVIPMinimum/Sniffs/Variables/ServerVariablesSniff.php

@@ -24,11 +24,11 @@ class ServerVariablesSniff implements Sniff {
 	 * @var array
 	 */
 	public $restrictedVariables = array(
-		'authVariables' => array(
+		'authVariables'           => array(
 			'PHP_AUTH_USER' => true,
 			'PHP_AUTH_PW'   => true,
 		),
-		'userControlledVariables'  => array(
+		'userControlledVariables' => array(
 			'HTTP_X_IP_TRAIL'      => true,
 			'HTTP_X_FORWARDED_FOR' => true,
 			'REMOTE_ADDR'          => true,

WordPressVIPMinimum/Tests/Filters/AlwaysReturnUnitTest.php

@@ -31,10 +31,10 @@ public function getErrorList() {
 	 */
 	public function getWarningList() {
 		return array(
-			15 => 1,
-			49 => 1,
-			88 => 1,
-			95 => 1,
+			15  => 1,
+			49  => 1,
+			88  => 1,
+			95  => 1,
 			105 => 1,
 		);
 	}

WordPressVIPMinimum/Tests/Filters/RestrictedHookUnitTest.php

@@ -33,9 +33,9 @@ public function getErrorList() {
 	 */
 	public function getWarningList() {
 		return array(
-			7 => 1,
-			8 => 1,
-			9 => 1,
+			7  => 1,
+			8  => 1,
+			9  => 1,
 			10 => 1,
 			11 => 1,
 			12 => 1,

WordPressVIPMinimum/Tests/Variables/VariableAnalysisUnitTest.php

@@ -32,7 +32,7 @@ public function getErrorList() {
 	 */
 	public function getWarningList() {
 		return [
-			5 => 2,
+			5  => 2,
 			18 => 2,
 		];
 	}

bin/phpcs

@@ -9,4 +9,4 @@
 #
 #   ./bin/phpcs
 
-"$(pwd)/vendor/bin/phpcs" --runtime-set ignore_warnings_on_exit 1
+"$(pwd)/vendor/bin/phpcs"