Merge pull request wp-cli#161 from wp-cli/phpcs-scope-variable-whitel…

…ist-more-finely Fine-tune property and variable name whitelisting
ocean90 · Apr 24, 2019 · e7a3650 · e7a3650
2 parents e4edd2f + f63b1e7
commit e7a3650
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 14 deletions.
diff --git a/phpcs.xml.dist b/phpcs.xml.dist
@@ -60,11 +60,13 @@
 		<exclude-pattern>*/src/IterableCodeExtractor\.php$</exclude-pattern>
 	</rule>
 
-	<!-- Whitelist variable names for classes that extend a PSR-2 package. -->
+	<!-- Whitelist property name for a a JSON-decoded object. -->
 	<rule ref="WordPress.NamingConventions.ValidVariableName">
-		<exclude-pattern>*/src/JsFunctionsScanner\.php$</exclude-pattern>
-		<exclude-pattern>*/src/PhpFunctionsScanner\.php$</exclude-pattern>
-		<exclude-pattern>*/src/MapCodeExtractor\.php$</exclude-pattern>
+		<properties>
+			<property name="customPropertiesWhitelist" type="array">
+				<element value="sourcesContent"/>
+			</property>
+		</properties>
 	</rule>
 
 	<!-- Allow for JavaScript format examples to be provided in comments.

diff --git a/src/JsFunctionsScanner.php b/src/JsFunctionsScanner.php
@@ -15,22 +15,22 @@ final class JsFunctionsScanner extends GettextJsFunctionsScanner {
 	 *
 	 * @var string|false|array
 	 */
-	private $extractComments = false;
+	private $extract_comments = false;
 
 	/**
 	 * Enable extracting comments that start with a tag (if $tag is empty all the comments will be extracted).
 	 *
 	 * @param mixed $tag
 	 */
 	public function enableCommentsExtraction( $tag = '' ) {
-		$this->extractComments = $tag;
+		$this->extract_comments = $tag;
 	}
 
 	/**
 	 * Disable comments extraction.
 	 */
 	public function disableCommentsExtraction() {
-		$this->extractComments = false;
+		$this->extract_comments = false;
 	}
 
 	/**
@@ -43,7 +43,7 @@ public function saveGettextFunctions( Translations $translations, array $options
 
 		$peast_options = [
 			'sourceType' => Peast::SOURCE_TYPE_MODULE,
-			'comments'   => false !== $this->extractComments,
+			'comments'   => false !== $this->extract_comments,
 			'jsx'        => true,
 		];
 		$ast           = Peast::latest( $this->code, $peast_options )->parse();
@@ -140,7 +140,7 @@ function ( $node ) use ( &$translations, $options, &$all_comments ) {
 						}
 
 						$parsed_comment = ParsedComment::create( $comment->getRawText(), $comment->getLocation()->getStart()->getLine() );
-						$prefixes       = array_filter( (array) $this->extractComments );
+						$prefixes       = array_filter( (array) $this->extract_comments );
 
 						if ( $parsed_comment->checkPrefixes( $prefixes ) ) {
 							$translation->addExtractedComment( $parsed_comment->getComment() );

diff --git a/src/MapCodeExtractor.php b/src/MapCodeExtractor.php
@@ -33,13 +33,13 @@ public static function fromString( $string, Translations $translations, array $o
 		try {
 			$options += static::$options;
 
-			$mapObject = json_decode( $string );
+			$map_object = json_decode( $string );
 
-			if ( ! isset( $mapObject->sourcesContent ) || ! is_array( $mapObject->sourcesContent ) ) {
+			if ( ! isset( $map_object->sourcesContent ) || ! is_array( $map_object->sourcesContent ) ) {
 				return;
 			}
 
-			$string = implode( "\n", $mapObject->sourcesContent );
+			$string = implode( "\n", $map_object->sourcesContent );
 
 			$functions = new JsFunctionsScanner( $string );
 

diff --git a/src/PhpFunctionsScanner.php b/src/PhpFunctionsScanner.php
@@ -59,8 +59,8 @@ public function saveGettextFunctions( Translations $translations, array $options
 				$translation = $translation->addReference( $file, $line );
 
 				if ( isset( $function[3] ) ) {
-					foreach ( $function[3] as $extractedComment ) {
-						$translation = $translation->addExtractedComment( $extractedComment );
+					foreach ( $function[3] as $extracted_comment ) {
+						$translation = $translation->addExtractedComment( $extracted_comment );
 					}
 				}
 			}