jenkins-bot has submitted this change and it was merged.
Change subject: Make mediawiki/tools/codesniffer pass phpcs
......................................................................
Make mediawiki/tools/codesniffer pass phpcs
Bug: T92754
Change-Id: I0612f4392ab61323c44032a0b30ca7765ed72070
---
M MediaWiki/Sniffs/AlternativeSyntax/AlternativeSyntaxSniff.php
M MediaWiki/Sniffs/ExtraCharacters/CharacterBeforePHPOpeningTagSniff.php
M MediaWiki/Sniffs/GotoUsage/GotoUsageSniff.php
M MediaWiki/Sniffs/NamingConventions/PrefixedGlobalFunctionsSniff.php
M MediaWiki/Sniffs/NamingConventions/ValidGlobalNameSniff.php
M MediaWiki/Sniffs/VariableAnalysis/UnusedGlobalVariablesSniff.php
M MediaWiki/Sniffs/WhiteSpace/SpaceAfterControlStructureSniff.php
M MediaWiki/Tests/MediaWikiStandardTest.php
M MediaWiki/Tests/files/NamingConventions/case_global_name_fail.php
M
MediaWiki/Tests/files/VariableAnalysis/used_global_variables_regression_pass.php
M TestHelper.php
M composer.json
M phpunit.bootstrap.php
13 files changed, 80 insertions(+), 58 deletions(-)
Approvals:
Addshore: Looks good to me, approved
jenkins-bot: Verified
diff --git a/MediaWiki/Sniffs/AlternativeSyntax/AlternativeSyntaxSniff.php
b/MediaWiki/Sniffs/AlternativeSyntax/AlternativeSyntaxSniff.php
index 43b6e9f..592aa1d 100644
--- a/MediaWiki/Sniffs/AlternativeSyntax/AlternativeSyntaxSniff.php
+++ b/MediaWiki/Sniffs/AlternativeSyntax/AlternativeSyntaxSniff.php
@@ -2,9 +2,13 @@
/**
* Verify alternative syntax is not being used
*/
-class MediaWiki_Sniffs_AlternativeSyntax_AlternativeSyntaxSniff implements
PHP_CodeSniffer_Sniff {
+// @codingStandardsIgnoreStart
+class MediaWiki_Sniffs_AlternativeSyntax_AlternativeSyntaxSniff
+ implements PHP_CodeSniffer_Sniff {
+ // @codingStandardsIgnoreEnd
public function register() {
- // Per
https://www.mediawiki.org/wiki/Manual:Coding_conventions/PHP#Alternative_syntax_for_control_structures
+ // Per
https://www.mediawiki.org/wiki/Manual:Coding_conventions/PHP
+ // section on alternative syntax.
return array(
T_ENDDECLARE,
T_ENDFOR,
diff --git
a/MediaWiki/Sniffs/ExtraCharacters/CharacterBeforePHPOpeningTagSniff.php
b/MediaWiki/Sniffs/ExtraCharacters/CharacterBeforePHPOpeningTagSniff.php
index 4d436a2..b252e65 100644
--- a/MediaWiki/Sniffs/ExtraCharacters/CharacterBeforePHPOpeningTagSniff.php
+++ b/MediaWiki/Sniffs/ExtraCharacters/CharacterBeforePHPOpeningTagSniff.php
@@ -2,13 +2,16 @@
/**
* Check to see if there's any character before php open tag <? or <?php
*/
-class MediaWiki_Sniffs_ExtraCharacters_CharacterBeforePHPOpeningTagSniff
implements PHP_CodeSniffer_Sniff {
+// @codingStandardsIgnoreStart
+class MediaWiki_Sniffs_ExtraCharacters_CharacterBeforePHPOpeningTagSniff
+ implements PHP_CodeSniffer_Sniff {
+ // @codingStandardsIgnoreEnd
public function register() {
return array( T_OPEN_TAG );
}
public function process( PHP_CodeSniffer_File $phpcsFile, $stackPtr ) {
// do nothing if opening tag is the first character
- if( $stackPtr == 0) {
+ if ( $stackPtr == 0 ) {
return;
}
$tokens = $phpcsFile->getTokens();
diff --git a/MediaWiki/Sniffs/GotoUsage/GotoUsageSniff.php
b/MediaWiki/Sniffs/GotoUsage/GotoUsageSniff.php
index dd566e5..371a689 100644
--- a/MediaWiki/Sniffs/GotoUsage/GotoUsageSniff.php
+++ b/MediaWiki/Sniffs/GotoUsage/GotoUsageSniff.php
@@ -2,7 +2,9 @@
/**
* Report error when `goto` is used
*/
+// @codingStandardsIgnoreStart
class MediaWiki_Sniffs_GotoUsage_GotoUsageSniff implements
PHP_CodeSniffer_Sniff {
+ // @codingStandardsIgnoreEnd
public function register() {
// As per
https://www.mediawiki.org/wiki/Manual:Coding_conventions/PHP#Other
return array(
diff --git
a/MediaWiki/Sniffs/NamingConventions/PrefixedGlobalFunctionsSniff.php
b/MediaWiki/Sniffs/NamingConventions/PrefixedGlobalFunctionsSniff.php
index 0e12a8c..e207c1a 100644
--- a/MediaWiki/Sniffs/NamingConventions/PrefixedGlobalFunctionsSniff.php
+++ b/MediaWiki/Sniffs/NamingConventions/PrefixedGlobalFunctionsSniff.php
@@ -4,7 +4,10 @@
* A global function's name must be prefixed with 'wf' or 'ef'.
* Per https://www.mediawiki.org/wiki/Manual:Coding_conventions/PHP#Naming
*/
-class MediaWiki_Sniffs_NamingConventions_PrefixedGlobalFunctionsSniff
implements PHP_CodeSniffer_Sniff {
+// @codingStandardsIgnoreStart
+class MediaWiki_Sniffs_NamingConventions_PrefixedGlobalFunctionsSniff
+ implements PHP_CodeSniffer_Sniff {
+ // @codingStandardsIgnoreEnd
public function register() {
return array( T_FUNCTION );
}
diff --git a/MediaWiki/Sniffs/NamingConventions/ValidGlobalNameSniff.php
b/MediaWiki/Sniffs/NamingConventions/ValidGlobalNameSniff.php
index 60f3a8a..6b5d339 100644
--- a/MediaWiki/Sniffs/NamingConventions/ValidGlobalNameSniff.php
+++ b/MediaWiki/Sniffs/NamingConventions/ValidGlobalNameSniff.php
@@ -3,8 +3,9 @@
* Verify MediaWiki global variable naming convention.
* A global name must be prefixed with 'wg'.
*/
+// @codingStandardsIgnoreStart
class MediaWiki_Sniffs_NamingConventions_ValidGlobalNameSniff implements
PHP_CodeSniffer_Sniff {
-
+ // @codingStandardsIgnoreEnd
/**
* http://php.net/manual/en/reserved.variables.argv.php
*/
@@ -41,11 +42,14 @@
$nameIndex = $phpcsFile->findNext( T_VARIABLE, $stackPtr + 1 );
$semicolonIndex = $phpcsFile->findNext( T_SEMICOLON, $stackPtr
+ 1 );
- while( $nameIndex < $semicolonIndex ) {
- if( $tokens[ $nameIndex ][ 'code' ] !== T_WHITESPACE &&
$tokens[ $nameIndex ][ 'code' ] !== T_COMMA ) {
+ while ( $nameIndex < $semicolonIndex ) {
+
+ if ( $tokens[ $nameIndex ][ 'code' ] !== T_WHITESPACE
+ && $tokens[ $nameIndex ][ 'code' ] !==
T_COMMA ) {
+
$globalName = $tokens[$nameIndex]['content'];
- if( in_array( $globalName,
self::$mediaWikiValid ) ||
+ if ( in_array( $globalName,
self::$mediaWikiValid ) ||
in_array( $globalName,
self::$PHPReserved )
) {
return;
@@ -55,7 +59,7 @@
$expected = '$wg' . ucfirst(substr(
$globalName, 1 ));
// Verify global is prefixed with wg
- if( strpos($globalName, '$wg' ) !== 0 ) {
+ if ( strpos($globalName, '$wg' ) !== 0 ) {
$phpcsFile->addError(
'Global variable "%s" is
lacking \'wg\' prefix. Should be "%s".',
$stackPtr,
@@ -65,7 +69,7 @@
} else {
// Verify global is probably CamelCase
$val = ord( substr( $globalName, 3, 1 )
);
- if( !($val >= 65 && $val <= 90) ) {
+ if ( !( $val >= 65 && $val <= 90 ) ) {
$phpcsFile->addError(
'Global variable "%s"
should use CamelCase: "%s"',
$stackPtr,
@@ -79,4 +83,3 @@
}
}
}
-
diff --git a/MediaWiki/Sniffs/VariableAnalysis/UnusedGlobalVariablesSniff.php
b/MediaWiki/Sniffs/VariableAnalysis/UnusedGlobalVariablesSniff.php
index 5d18160..33a3405 100644
--- a/MediaWiki/Sniffs/VariableAnalysis/UnusedGlobalVariablesSniff.php
+++ b/MediaWiki/Sniffs/VariableAnalysis/UnusedGlobalVariablesSniff.php
@@ -3,8 +3,10 @@
* Detect unused MediaWiki global variable.
* Unused global variables should be removed.
*/
-class MediaWiki_Sniffs_VariableAnalysis_UnusedGlobalVariablesSniff implements
PHP_CodeSniffer_Sniff {
-
+// @codingStandardsIgnoreStart
+class MediaWiki_Sniffs_VariableAnalysis_UnusedGlobalVariablesSniff
+ implements PHP_CodeSniffer_Sniff {
+ // @codingStandardsIgnoreEnd
public function register() {
return array( T_FUNCTION );
}
diff --git a/MediaWiki/Sniffs/WhiteSpace/SpaceAfterControlStructureSniff.php
b/MediaWiki/Sniffs/WhiteSpace/SpaceAfterControlStructureSniff.php
index feb8464..1dc9ccb 100644
--- a/MediaWiki/Sniffs/WhiteSpace/SpaceAfterControlStructureSniff.php
+++ b/MediaWiki/Sniffs/WhiteSpace/SpaceAfterControlStructureSniff.php
@@ -2,7 +2,10 @@
/**
* Verify specific control structures are followed by a single space.
*/
-class MediaWiki_Sniffs_WhiteSpace_SpaceAfterControlStructureSniff implements
PHP_CodeSniffer_Sniff {
+// @codingStandardsIgnoreStart
+class MediaWiki_Sniffs_WhiteSpace_SpaceAfterControlStructureSniff
+ implements PHP_CodeSniffer_Sniff {
+ // @codingStandardsIgnoreEnd
public function register() {
// Per
https://www.mediawiki.org/wiki/Manual:Coding_conventions/PHP#Spaces
return array(
@@ -25,4 +28,3 @@
}
}
}
-
diff --git a/MediaWiki/Tests/MediaWikiStandardTest.php
b/MediaWiki/Tests/MediaWikiStandardTest.php
index e45aadb..98f9f92 100644
--- a/MediaWiki/Tests/MediaWikiStandardTest.php
+++ b/MediaWiki/Tests/MediaWikiStandardTest.php
@@ -1,7 +1,8 @@
<?php
/**
* This file was copied from CakePhps codesniffer tests before being modified
- *
https://github.com/cakephp/cakephp-codesniffer/blob/015919e55049e696eef9e518026e2d9abcdba722/CakePHP/tests/CakePHPStandardTest.php
+ * File: http://git.io/vkirb
+ * From repository: https://github.com/cakephp/cakephp-codesniffer
*
* @license MIT
* CakePHP(tm) : The Rapid Development PHP Framework (http://cakephp.org)
@@ -45,8 +46,8 @@
$tests = array();
$standard = dirname(dirname(__FILE__));
-
- $iterator = new RecursiveIteratorIterator(new
RecursiveDirectoryIterator(dirname(__FILE__) . '/files'));
+ $directoryIterator = new
RecursiveDirectoryIterator(dirname(__FILE__) . '/files');
+ $iterator = new RecursiveIteratorIterator($directoryIterator);
foreach ($iterator as $dir) {
if ($dir->isDir()) {
continue;
@@ -89,4 +90,4 @@
}
}
-}
\ No newline at end of file
+}
diff --git a/MediaWiki/Tests/files/NamingConventions/case_global_name_fail.php
b/MediaWiki/Tests/files/NamingConventions/case_global_name_fail.php
index f6488a9..c7d8af1 100644
--- a/MediaWiki/Tests/files/NamingConventions/case_global_name_fail.php
+++ b/MediaWiki/Tests/files/NamingConventions/case_global_name_fail.php
@@ -3,4 +3,4 @@
function fooFoo () {
// The below should have capital after wg
global $wgsomething;
-}
\ No newline at end of file
+}
diff --git
a/MediaWiki/Tests/files/VariableAnalysis/used_global_variables_regression_pass.php
b/MediaWiki/Tests/files/VariableAnalysis/used_global_variables_regression_pass.php
index 181a790..c689ff9 100644
---
a/MediaWiki/Tests/files/VariableAnalysis/used_global_variables_regression_pass.php
+++
b/MediaWiki/Tests/files/VariableAnalysis/used_global_variables_regression_pass.php
@@ -1,6 +1,6 @@
<?php
-interface FooBar {
+interface FooBar2 {
public function funcFooBar();
}
diff --git a/TestHelper.php b/TestHelper.php
index acefc8a..844e628 100644
--- a/TestHelper.php
+++ b/TestHelper.php
@@ -1,7 +1,8 @@
<?php
/**
* This file was copied from CakePhps codesniffer tests before being modified
- *
https://github.com/cakephp/cakephp-codesniffer/blob/7abb71ed17a52beb16e208d6964f7c9d967e639d/CakePHP/tests/TestHelper.php
+ * File: http://git.io/vkioq
+ * From repository: https://github.com/cakephp/cakephp-codesniffer
*
* @license MIT
* CakePHP(tm) : The Rapid Development PHP Framework (http://cakephp.org)
@@ -24,16 +25,16 @@
class TestHelper {
- protected $_rootDir;
+ protected $rootDir;
- protected $_dirName;
+ protected $dirName;
- protected $_phpcs;
+ protected $phpcs;
public function __construct() {
- $this->_rootDir = dirname(dirname(__FILE__));
- $this->_dirName = basename($this->_rootDir);
- $this->_phpcs = new PHP_CodeSniffer_CLI();
+ $this->rootDir = dirname(dirname(__FILE__));
+ $this->dirName = basename($this->rootDir);
+ $this->phpcs = new PHP_CodeSniffer_CLI();
}
/**
@@ -44,11 +45,11 @@
* @return string The output from phpcs.
*/
public function runPhpCs($file, $standard = '') {
- if( empty( $standard ) ){
- $standard = $this->_rootDir . '/ruleset.xml';
+ if ( empty( $standard ) ) {
+ $standard = $this->rootDir . '/ruleset.xml';
}
- $defaults = $this->_phpcs->getDefaults();
- //$standard = $this->_rootDir . '/ruleset.xml';
+ $defaults = $this->phpcs->getDefaults();
+ //$standard = $this->rootDir . '/ruleset.xml';
if (
defined('PHP_CodeSniffer::VERSION') &&
version_compare(PHP_CodeSniffer::VERSION, '1.5.0') != -1
@@ -63,15 +64,15 @@
// New PHPCS has a strange issue where the method arguments
// are not stored on the instance causing weird errors.
- $reflection = new ReflectionProperty($this->_phpcs, 'values');
+ $reflection = new ReflectionProperty($this->phpcs, 'values');
$reflection->setAccessible(true);
- $reflection->setValue($this->_phpcs, $options);
+ $reflection->setValue($this->phpcs, $options);
ob_start();
- $this->_phpcs->process($options);
+ $this->phpcs->process($options);
$result = ob_get_contents();
ob_end_clean();
return $result;
}
-}
\ No newline at end of file
+}
diff --git a/composer.json b/composer.json
index 10c6a3e..ab7d680 100644
--- a/composer.json
+++ b/composer.json
@@ -1,20 +1,21 @@
{
- "name": "mediawiki/mediawiki-codesniffer",
- "description": "MediaWiki CodeSniffer Standards",
- "keywords": ["mediawiki", "codesniffer"],
- "homepage": "https://www.mediawiki.org/wiki/Manual:Coding_conventions/PHP";,
- "license": "GPL-2.0+",
- "require": {
- "squizlabs/php_codesniffer": "2.3.0"
- },
- "require-dev": {
- "jakub-onderka/php-parallel-lint": "0.8.*",
- "phpunit/phpunit": "~4.1.0"
- },
- "scripts": {
- "test": [
- "parallel-lint . --exclude vendor",
- "phpunit $PHPUNIT_ARGS"
- ]
- }
+ "name": "mediawiki/mediawiki-codesniffer",
+ "description": "MediaWiki CodeSniffer Standards",
+ "keywords": ["mediawiki", "codesniffer"],
+ "homepage":
"https://www.mediawiki.org/wiki/Manual:Coding_conventions/PHP";,
+ "license": "GPL-2.0+",
+ "require": {
+ "squizlabs/php_codesniffer": "2.3.0"
+ },
+ "require-dev": {
+ "jakub-onderka/php-parallel-lint": "0.8.*",
+ "phpunit/phpunit": "~4.1.0"
+ },
+ "scripts": {
+ "test": [
+ "parallel-lint . --exclude vendor",
+ "phpunit $PHPUNIT_ARGS",
+ "phpcs --standard=./MediaWiki --extensions=php,php5,inc
--ignore=vendor,*fail.php -p ."
+ ]
+ }
}
diff --git a/phpunit.bootstrap.php b/phpunit.bootstrap.php
index ed9b63a..863acde 100644
--- a/phpunit.bootstrap.php
+++ b/phpunit.bootstrap.php
@@ -5,14 +5,14 @@
if ( !class_exists( 'PHP_CodeSniffer_CLI' ) ) {
$composer['local'] = dirname( dirname( dirname( __FILE__ ) ) );
$composer['wmfjenkins'] = '/srv/deployment/integration/phpcs/';
- foreach( $composer as $location ) {
+ foreach ( $composer as $location ) {
$location = $location .
'/vendor/squizlabs/php_codesniffer/CodeSniffer/CLI.php';
- if( file_exists( $location ) ) {
+ if ( file_exists( $location ) ) {
require_once $location;
break;
}
}
- if( !class_exists( 'PHP_CodeSniffer_CLI' ) ) {
+ if ( !class_exists( 'PHP_CodeSniffer_CLI' ) ) {
require_once 'PHP/CodeSniffer/CLI.php';
}
}
--
To view, visit https://gerrit.wikimedia.org/r/214792
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I0612f4392ab61323c44032a0b30ca7765ed72070
Gerrit-PatchSet: 12
Gerrit-Project: mediawiki/tools/codesniffer
Gerrit-Branch: master
Gerrit-Owner: Polybuildr <v.a.ghai...@gmail.com>
Gerrit-Reviewer: Addshore <addshorew...@gmail.com>
Gerrit-Reviewer: Legoktm <legoktm.wikipe...@gmail.com>
Gerrit-Reviewer: Polybuildr <v.a.ghai...@gmail.com>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
