Fix coding standards issues and make plugin fully translatable.

wpengine · Jan 15, 2018 · 40a4c65 · 40a4c65
1 parent eb91036
commit 40a4c65
Show file tree

Hide file tree

Showing 7 changed files with 336 additions and 229 deletions.
diff --git a/load-files.php b/load-files.php
@@ -1,6 +1,15 @@
 <?php
-// Exit if this file is directly accessed
-if ( ! defined( 'ABSPATH' ) ) { exit; }
+/**
+ * Dependency loader
+ *
+ * @package WPEngine\PHPCompat
+ * @since 1.0.0
+ */
+
+// Exit if this file is directly accessed.
+if ( ! defined( 'ABSPATH' ) ) {
+	exit;
+}
 
 /**
  * Loads the plugin files.

diff --git a/phpcs.xml b/phpcs.xml
@@ -5,14 +5,22 @@
 	<exclude-pattern>*/tests/*</exclude-pattern>
 	<exclude-pattern>*/vendor/*</exclude-pattern>
 
-	<rule ref="WordPress"/>
+	<rule ref="WordPress">
+		<exclude name="WordPress.Files.FileName"/>
+	</rule>
 
 	<rule ref="WordPress.WP.I18n">
 		<properties>
 			<property name="text_domain" type="string" value="php-compatibility-checker"/>
 		</properties>
 	</rule>
 
+	<rule ref="WordPress.NamingConventions.ValidVariableName">
+		<properties>
+			<property name="customPropertiesWhitelist" type="string" value="Name"/>
+		</properties>
+	</rule>
+
 	<config name="testVersion" value="5.2-99.0"/>
 	<rule ref="PHPCompatibility"/>
 </ruleset>
diff --git a/src/ruleset-wordpress.xml b/src/ruleset-wordpress.xml
@@ -4,6 +4,20 @@
 	<description>WordPress-Core Custom</description>
 
 	<!-- Include WordPress-Core standards. -->
-	<rule ref="WordPress-Core"/>
+	<rule ref="WordPress-Core">
+		<exclude name="WordPress.Files.FileName"/>
+	</rule>
+
+	<rule ref="WordPress.WP.I18n">
+		<properties>
+			<property name="text_domain" type="string" value="php-compatibility-checker"/>
+		</properties>
+	</rule>
+
+	<rule ref="WordPress.NamingConventions.ValidVariableName">
+		<properties>
+			<property name="customPropertiesWhitelist" type="string" value="Name"/>
+		</properties>
+	</rule>
 
 </ruleset>
diff --git a/src/wpcli.php b/src/wpcli.php
@@ -1,4 +1,11 @@
 <?php
+/**
+ * PHPCompat_Command class
+ *
+ * @package WPEngine\PHPCompat
+ * @since 1.0.0
+ */
+
 require_once dirname( dirname( __FILE__ ) ) . '/load-files.php';
 
 /**
@@ -60,7 +67,7 @@ function __invoke( $args, $assoc_args ) {
  */
 WP_CLI::add_command( 'phpcompat', 'PHPCompat_Command', array(
 	'shortdesc' => 'Test compatibility with different PHP versions.',
-	'synopsis' => array(
+	'synopsis'  => array(
 		array(
 			'type'     => 'positional',
 			'name'     => 'version',