Fix PHPCS violations in phpcs-check-sniff-doc-code-examples

Author: rodrigoprimo

Scripts/DocCodeExamples/Functions.php

@@ -0,0 +1,27 @@
+<?php
+/**
+ * PHPCSDevTools, tools for PHP_CodeSniffer sniff developers.
+ *
+ * @package   PHPCSDevTools
+ * @copyright 2019 PHPCSDevTools Contributors
+ * @license   https://opensource.org/licenses/LGPL-3.0 LGPL3
+ * @link      https://github.com/PHPCSStandards/PHPCSDevTools
+ */
+
+/**
+ * Helper function to require the correct autoload file given a list of possible file locations.
+ *
+ * @param array<int, string> $files An array of possible file paths.
+ *
+ * @return void
+ */
+function requireCorrectAutoloadFile(array $files)
+{
+    foreach ($files as $file) {
+        $file = realpath($file);
+        if ($file !== false && is_file($file) === true) {
+            require_once $file;
+            return;
+        }
+    }
+}

bin/phpcs-check-sniff-doc-code-examples

@@ -19,27 +19,12 @@
  */
 
 if (PHP_VERSION_ID < 70000) {
-    $error = 'ERROR: This script requires PHP version 7.0.0 or greater.'.PHP_EOL;
+    $error = 'ERROR: This script requires PHP version 7.0.0 or greater.' . PHP_EOL;
     fwrite(STDERR, $error);
     exit(1);
 }
 
-/**
- * Helper function to require the correct autoload file given a list of possible file locations.
- *
- * @param array $files An array of possible file paths.
- *
- * @return void
- */
-function requireCorrectAutoloadFile(array $files) {
-	foreach ($files as $file) {
-		$file = realpath($file);
-		if ($file !== false && is_file($file) === true) {
-			require_once($file);
-			return;
-		}
-	}
-}
+require_once __DIR__ . '/../Scripts/DocCodeExamples/Functions.php';
 
 $devToolsAutoloadLocations = [
     __DIR__ . '/../devtools-autoload.php', // Git clone or direct run from within vendor package directory.
@@ -51,8 +36,8 @@ $devToolsAutoloadLocations = [
 $phpcsAutoloadLocations = [
     __DIR__ . '/../vendor/squizlabs/php_codesniffer/autoload.php', // Git clone.
     __DIR__ . '/../squizlabs/php_codesniffer/autoload.php', // Composer bin dir install.
-    __DIR__ . '/../../autoload.php', // Installed as a Composer dependency for PHPCS itself. Running from vendor/bin/.
-	__DIR__ . '/../../../../autoload.php', // Installed as a Composer dependency for PHPCS itself. Running from vendor/phpcsstandards/phpcsdevtools/bin/.
+    __DIR__ . '/../../autoload.php', // Composer dependency for PHPCS itself. Running from vendor/bin/.
+    __DIR__ . '/../../../../autoload.php', // Composer dependency running from vendor/phpcsstandards/phpcsdevtools/bin/.
 ];
 
 // Try to find a usable PHPCSDevTools autoload file.
@@ -72,13 +57,13 @@ try {
     $extractor = new PHPCSDevTools\Scripts\DocCodeExamples\CodeBlocksExtractor();
 
     // It is necessary to reset argv to avoid issues with the PHPCS Config,
-	// as it also checks for command line arguments.
+    // as it also checks for command line arguments.
     $_SERVER['argv'] = [];
-	$phpcsConfig = new PHP_CodeSniffer\Config();
+    $phpcsConfig     = new PHP_CodeSniffer\Config();
 
     $check = new PHPCSDevTools\Scripts\DocCodeExamples\Check($config, $extractor, $phpcsConfig, $writer);
-	exit($check->run());
+    exit($check->run());
 } catch (RuntimeException $e) {
-	echo $e->getMessage() . PHP_EOL;
-	exit(1);
+    echo $e->getMessage() . PHP_EOL;
+    exit(1);
 }