Merge branch 'master' into fix/phpcs-violations-in-vipcs

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.

WordPress-VIP-Go/ruleset.xml

@@ -50,7 +50,6 @@
 	<rule ref="WordPressVIPMinimum.VIP.FetchingRemoteData.fileGetContentsUknown">
 		<type>error</type>
 		<Severity>5</Severity>
-		<message>%s() is uncached. If this is being used to query a remote file please use wpcom_vip_file_get_contents() instead. If it's used for a local file please use WP_Filesystem instead. Read more here: https://vip.wordpress.com/documentation/using-wp_filesystem-instead-of-direct-file-access-functions/</message>
 	</rule>
 	<rule ref="WordPress.WP.AlternativeFunctions.file_system_read_fopen">
 		<type>error</type>

WordPressVIPMinimum/Sniffs/VIP/FetchingRemoteDataSniff.php

@@ -47,14 +47,24 @@ public function process( File $phpcsFile, $stackPtr ) {
 
 		$fileNameStackPtr = $phpcsFile->findNext( Tokens::$stringTokens, ( $stackPtr + 1 ), null, false, null, true );
 		if ( false === $fileNameStackPtr ) {
-			$phpcsFile->addWarning( sprintf( '`%s()` is highly discouraged for remote requests, please use `wpcom_vip_file_get_contents()` or `vip_safe_wp_remote_get()` instead.', $tokens[ $stackPtr ]['content'] ), $stackPtr, 'fileGetContentsUknown' );
+			$phpcsFile->addWarning(
+				'`%s()` is highly discouraged for remote requests, please use `wpcom_vip_file_get_contents()` or `vip_safe_wp_remote_get()` instead. If it\'s for a local file please use WP_Filesystem instead.',
+				$stackPtr,
+				'fileGetContentsUknown',
+				[ $tokens[ $stackPtr ]['content'] ]
+			);
 		}
 
 		$fileName = $tokens[ $fileNameStackPtr ]['content'];
 
 		$isRemoteFile = ( false !== strpos( $fileName, '://' ) );
 		if ( true === $isRemoteFile ) {
-			$phpcsFile->addWarning( sprintf( '`%s()` is highly discouraged for remote requests, please use `wpcom_vip_file_get_contents()` or `vip_safe_wp_remote_get()` instead.', $tokens[ $stackPtr ]['content'] ), $stackPtr, 'fileGetContentsRemoteFile' );
+			$phpcsFile->addWarning(
+				'`%s()` is highly discouraged for remote requests, please use `wpcom_vip_file_get_contents()` or `vip_safe_wp_remote_get()` instead.',
+				$stackPtr,
+				'fileGetContentsRemoteFile',
+				[ $tokens[ $stackPtr ]['content'] ]
+			);
 		}
 	}