MM-4941: [EQP][Sniffs Consolidation] Create new GitHub repo and move MEQP2 sniffs

lenaorobei · lenaorobei · commit bb77a39caf05 · 2018-12-21T11:52:10.000-06:00
- Removed severity from PHP code and added to the ruleset
diff --git a/Magento/Sniffs/Classes/ObjectInstantiationSniff.php b/Magento/Sniffs/Classes/ObjectInstantiationSniff.php
@@ -13,13 +13,6 @@
  */
 class ObjectInstantiationSniff implements Sniff
 {
-    /**
-     * Violation severity.
-     *
-     * @var int
-     */
-    protected $severity = 8;
-
     /**
      * String representation of warning.
      *
@@ -84,8 +77,7 @@ public function process(File $phpcsFile, $stackPtr)
                 $this->warningMessage,
                 $classNameStart,
                 $this->warningCode,
-                [$className],
-                $this->severity
+                [$className]
             );
         }
     }
diff --git a/Magento/Sniffs/Exceptions/DirectThrowSniff.php b/Magento/Sniffs/Exceptions/DirectThrowSniff.php
@@ -13,13 +13,6 @@
  */
 class DirectThrowSniff implements Sniff
 {
-    /**
-     * Violation severity.
-     *
-     * @var int
-     */
-    protected $severity = 8;
-
     /**
      * String representation of warning.
      */
@@ -54,8 +47,7 @@ public function process(File $phpcsFile, $stackPtr)
                 $this->warningMessage,
                 $stackPtr,
                 $this->warningCode,
-                $posOfException,
-                $this->severity
+                $posOfException
             );
         }
     }
diff --git a/Magento/Sniffs/Exceptions/NamespaceSniff.php b/Magento/Sniffs/Exceptions/NamespaceSniff.php
@@ -13,13 +13,6 @@
  */
 class NamespaceSniff implements Sniff
 {
-    /**
-     * Violation severity.
-     *
-     * @var int
-     */
-    protected $severity = 10;
-
     /**
      * String representation of error.
      *
@@ -63,8 +56,7 @@ public function process(File $phpcsFile, $stackPtr)
                     $this->errorMessage,
                     $stackPtr,
                     $this->errorCode,
-                    $exceptionClassName,
-                    $this->severity
+                    $exceptionClassName
                 );
             }
         }
diff --git a/Magento/Sniffs/Legacy/MageEntitySniff.php b/Magento/Sniffs/Legacy/MageEntitySniff.php
@@ -13,18 +13,11 @@
  */
 class MageEntitySniff implements Sniff
 {
-    /**
-     * Violation severity.
-     *
-     * @var int
-     */
-    protected $severity = 10;
-
-    /**
-     * String representation of error.
-     *
-     * @var string
-     */
+   /**
+    * String representation of error.
+    *
+    * @var string
+    */
     protected $errorMessage = 'Possible Magento 2 design violation. Detected typical Magento 1.x construction "%s".';
 
     /**
@@ -94,15 +87,12 @@ public function process(File $phpcsFile, $stackPtr)
             $entityName = $tokens[$stackPtr]['content'];
             $error = [$tokens[$oldPosition]['content'] . ' ' . $entityName];
         }
-        if ($entityName === $this->legacyEntity ||
-            $this->isPrefixLegacy($entityName)
-        ) {
+        if ($entityName === $this->legacyEntity || $this->isPrefixLegacy($entityName)) {
             $phpcsFile->addError(
                 $this->errorMessage,
                 $stackPtr,
                 $this->errorCode,
-                $error,
-                $this->severity
+                $error
             );
         }
     }
diff --git a/Magento/Sniffs/NamingConvention/InterfaceNameSniff.php b/Magento/Sniffs/NamingConvention/InterfaceNameSniff.php
@@ -13,13 +13,6 @@
  */
 class InterfaceNameSniff implements Sniff
 {
-    /**
-     * Violation severity.
-     *
-     * @var int
-     */
-    protected $severity = 6;
-
     /**
      * String representation of warning.
      *
@@ -61,7 +54,7 @@ public function process(File $sourceFile, $stackPtr)
         while ($tokens[$stackPtr]['line'] === $declarationLine) {
             if ($tokens[$stackPtr]['type'] === 'T_STRING') {
                 if (substr($tokens[$stackPtr]['content'], 0 - $suffixLength) !== $this->interfaceSuffix) {
-                    $sourceFile->addWarning($this->warningMessage, $stackPtr, $this->warningCode, [], $this->severity);
+                    $sourceFile->addWarning($this->warningMessage, $stackPtr, $this->warningCode);
                 }
                 break;
             }
diff --git a/Magento/Sniffs/PHP/DateTimeSniff.php b/Magento/Sniffs/PHP/DateTimeSniff.php
@@ -13,13 +13,6 @@
  */
 class DateTimeSniff implements Sniff
 {
-    /**
-     * Violation severity.
-     *
-     * @var int
-     */
-    protected $severity = 6;
-
     /**
      * String representation of warning.
      *
@@ -63,7 +56,7 @@ public function process(File $phpcsFile, $stackPtr)
         $posOfClassName = $phpcsFile->findNext(T_STRING, $stackPtr);
         $posOfNsSeparator = $phpcsFile->findNext(T_NS_SEPARATOR, $stackPtr, $posOfClassName);
         if ($posOfNsSeparator !== false && in_array($tokens[$posOfClassName]['content'], $this->dateTimeClasses)) {
-            $phpcsFile->addWarning($this->warningMessage, $stackPtr, $this->warningCode, [], $this->severity);
+            $phpcsFile->addWarning($this->warningMessage, $stackPtr, $this->warningCode);
         }
     }
 }
diff --git a/Magento/Sniffs/PHP/DiscouragedFunctionSniff.php b/Magento/Sniffs/PHP/DiscouragedFunctionSniff.php
@@ -13,13 +13,6 @@
  */
 class DiscouragedFunctionSniff extends ForbiddenFunctionsSniff
 {
-    /**
-     * Violation severity.
-     *
-     * @var int
-     */
-    protected $severity = 8;
-
     /**
      * Pattern flag.
      *
@@ -254,6 +247,6 @@ protected function addError($phpcsFile, $stackPtr, $function, $pattern = null)
             $data[] = $this->forbiddenFunctions[$pattern];
             $warningMessage .= '; use %s instead.';
         }
-        $phpcsFile->addWarning($warningMessage, $stackPtr, $warningCode, $data, $this->severity);
+        $phpcsFile->addWarning($warningMessage, $stackPtr, $warningCode, $data);
     }
 }
diff --git a/Magento/Sniffs/PHP/GotoSniff.php b/Magento/Sniffs/PHP/GotoSniff.php
@@ -13,13 +13,6 @@
  */
 class GotoSniff implements Sniff
 {
-    /**
-     * Violation severity.
-     *
-     * @var int
-     */
-    protected $severity = 10;
-
     /**
      * String representation of warning.
      *
@@ -47,6 +40,6 @@ public function register()
      */
     public function process(File $phpcsFile, $stackPtr)
     {
-        $phpcsFile->addError($this->errorMessage, $stackPtr, $this->errorCode, [], $this->severity);
+        $phpcsFile->addError($this->errorMessage, $stackPtr, $this->errorCode);
     }
 }
diff --git a/Magento/Sniffs/PHP/ReturnValueCheckSniff.php b/Magento/Sniffs/PHP/ReturnValueCheckSniff.php
@@ -3,6 +3,7 @@
  * Copyright © Magento. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 namespace Magento\Sniffs\PHP;
 
 use PHP_CodeSniffer\Sniffs\Sniff;
@@ -13,13 +14,6 @@
  */
 class ReturnValueCheckSniff implements Sniff
 {
-    /**
-     * Violation severity.
-     *
-     * @var int
-     */
-    protected $severity = 10;
-
     /**
      * String representation of error.
      *
@@ -131,7 +125,7 @@ public function process(File $phpcsFile, $stackPtr)
                 && (!$this->findIdentical($i - 1, $this->findFunctionParenthesisCloser($i) + 1))
             ) {
                 $foundFunctionName = $this->tokens[$i]['content'];
-                $phpcsFile->addError($this->errorMessage, $i, $this->errorCode, [$foundFunctionName], $this->severity);
+                $phpcsFile->addError($this->errorMessage, $i, $this->errorCode, [$foundFunctionName]);
             }
         }
     }
diff --git a/Magento/Sniffs/PHP/VarSniff.php b/Magento/Sniffs/PHP/VarSniff.php
@@ -13,13 +13,6 @@
  */
 class VarSniff implements Sniff
 {
-    /**
-     * Violation severity.
-     *
-     * @var int
-     */
-    protected $severity = 8;
-
     /**
      * String representation of warning.
      *
@@ -47,6 +40,6 @@ public function register()
      */
     public function process(File $phpcsFile, $stackPtr)
     {
-        $phpcsFile->addWarning($this->warningMessage, $stackPtr, $this->warningCode, [], $this->severity);
+        $phpcsFile->addWarning($this->warningMessage, $stackPtr, $this->warningCode);
     }
 }
diff --git a/Magento/Sniffs/Performance/EmptyCheckSniff.php b/Magento/Sniffs/Performance/EmptyCheckSniff.php
@@ -13,13 +13,6 @@
  */
 class EmptyCheckSniff implements Sniff
 {
-    /**
-     * Violation severity.
-     *
-     * @var int
-     */
-    protected $severity = 8;
-
     /**
      * Mapping for function's code and message.
      *
@@ -118,12 +111,12 @@ public function process(File $phpcsFile, $stackPtr)
             $message = $this->map[$this->tokens[$functionPosition]['content']]['message'];
             if ($operatorPosition !== false) {
                 if ($phpcsFile->findNext(T_LNUMBER, $operatorPosition, $endOfStatementPosition, false, '0') !== false) {
-                    $phpcsFile->addWarning($message, $stackPtr, $code, [], $this->severity);
+                    $phpcsFile->addWarning($message, $stackPtr, $code);
                 }
             } else {
                 // phpcs:ignore Generic.Files.LineLength.TooLong
                 if ($phpcsFile->findNext($this->otherComparisonOperators, $functionPosition, $endOfStatementPosition) === false) {
-                    $phpcsFile->addWarning($message, $stackPtr, $code, [], $this->severity);
+                    $phpcsFile->addWarning($message, $stackPtr, $code);
                 }
             }
         }
diff --git a/Magento/Sniffs/Security/IncludeFileSniff.php b/Magento/Sniffs/Security/IncludeFileSniff.php
@@ -14,18 +14,11 @@
  */
 class IncludeFileSniff implements Sniff
 {
-    /**
-     * Violation severity.
-     *
-     * @var int
-     */
-    protected $severity = 8;
-
-    /**
-     * Warning violation code.
-     *
-     * @var string
-     */
+   /**
+    * Warning violation code.
+    *
+    * @var string
+    */
     protected $warningCode = 'FoundIncludeFile';
 
     /**
@@ -102,8 +95,7 @@ public function process(File $phpcsFile, $stackPtr)
             $message,
             $stackPtr,
             $this->warningCode,
-            [$tokens[$stackPtr]['content']],
-            $this->severity
+            [$tokens[$stackPtr]['content']]
         );
     }
 }
diff --git a/Magento/Sniffs/Security/LanguageConstructSniff.php b/Magento/Sniffs/Security/LanguageConstructSniff.php
@@ -13,13 +13,6 @@
  */
 class LanguageConstructSniff implements Sniff
 {
-    /**
-     * Violation severity.
-     *
-     * @var int
-     */
-    protected $severity = 10;
-
     /**
      * String representation of error.
      *
@@ -79,14 +72,14 @@ public function process(File $phpcsFile, $stackPtr)
             if ($phpcsFile->findNext(T_BACKTICK, $stackPtr + 1)) {
                 return;
             }
-            $phpcsFile->addError($this->errorMessageBacktick, $stackPtr, $this->backtickCode, [], $this->severity);
+            $phpcsFile->addError($this->errorMessageBacktick, $stackPtr, $this->backtickCode);
             return;
         }
         if ($tokens[$stackPtr]['code'] === T_EXIT) {
             $code = $this->exitUsage;
         } else {
             $code = $this->directOutput;
         }
-        $phpcsFile->addError($this->errorMessage, $stackPtr, $code, [$tokens[$stackPtr]['content']], $this->severity);
+        $phpcsFile->addError($this->errorMessage, $stackPtr, $code, [$tokens[$stackPtr]['content']]);
     }
 }
diff --git a/Magento/Sniffs/Security/SuperglobalSniff.php b/Magento/Sniffs/Security/SuperglobalSniff.php
@@ -13,20 +13,6 @@
  */
 class SuperglobalSniff implements Sniff
 {
-    /**
-     * Violation severity for error.
-     *
-     * @var int
-     */
-    protected $errorSeverity = 10;
-
-    /**
-     * Violation severity for warning.
-     *
-     * @var int
-     */
-    protected $warningSeverity = 6;
-
     /**
      * String representation of warning.
      *
@@ -96,16 +82,14 @@ public function process(File $phpcsFile, $stackPtr)
                 $this->errorMessage,
                 $stackPtr,
                 $this->errorCode,
-                [$var],
-                $this->errorSeverity
+                [$var]
             );
         } elseif (in_array($var, $this->superGlobalWarning)) {
             $phpcsFile->addWarning(
                 $this->warningMessage,
                 $stackPtr,
                 $this->warningCode,
-                [$var],
-                $this->warningSeverity
+                [$var]
             );
         }
     }
diff --git a/Magento/Sniffs/Security/XssTemplateSniff.php b/Magento/Sniffs/Security/XssTemplateSniff.php
diff --git a/Magento/Sniffs/Strings/RegExSniff.php b/Magento/Sniffs/Strings/RegExSniff.php
diff --git a/Magento/Sniffs/Strings/StringConcatSniff.php b/Magento/Sniffs/Strings/StringConcatSniff.php
diff --git a/Magento/Sniffs/Templates/ThisInTemplateSniff.php b/Magento/Sniffs/Templates/ThisInTemplateSniff.php
diff --git a/Magento/Sniffs/Translation/ConstantUsageSniff.php b/Magento/Sniffs/Translation/ConstantUsageSniff.php
diff --git a/Magento/Sniffs/Whitespace/MultipleEmptyLinesSniff.php b/Magento/Sniffs/Whitespace/MultipleEmptyLinesSniff.php
diff --git a/Magento/ruleset.xml b/Magento/ruleset.xml

Original file line number	Diff line number	Diff line change
`@@ -13,13 +13,6 @@`
`13`	`13`	`*/`
`14`	`14`	`class ObjectInstantiationSniff implements Sniff`
`15`	`15`	`{`
`16`		`- /**`
`17`		`- * Violation severity.`
`18`		`- *`
`19`		`- * @var int`
`20`		`- */`
`21`		`- protected $severity = 8;`
`22`		`-`
`23`	`16`	`/**`
`24`	`17`	`* String representation of warning.`
`25`	`18`	`*`
`@@ -84,8 +77,7 @@ public function process(File $phpcsFile, $stackPtr)`
`84`	`77`	`$this->warningMessage,`
`85`	`78`	`$classNameStart,`
`86`	`79`	`$this->warningCode,`
`87`		`- [$className],`
`88`		`- $this->severity`
	`80`	`+ [$className]`
`89`	`81`	`);`
`90`	`82`	`}`
`91`	`83`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`* Copyright © Magento. All rights reserved.`
`4`	`4`	`* See COPYING.txt for license details.`
`5`	`5`	`*/`
	`6`	`+`
`6`	`7`	`namespace Magento\Sniffs\PHP;`
`7`	`8`
`8`	`9`	`use PHP_CodeSniffer\Sniffs\Sniff;`
`@@ -13,13 +14,6 @@`
`13`	`14`	`*/`
`14`	`15`	`class ReturnValueCheckSniff implements Sniff`
`15`	`16`	`{`
`16`		`- /**`
`17`		`- * Violation severity.`
`18`		`- *`
`19`		`- * @var int`
`20`		`- */`
`21`		`- protected $severity = 10;`
`22`		`-`
`23`	`17`	`/**`
`24`	`18`	`* String representation of error.`
`25`	`19`	`*`
`@@ -131,7 +125,7 @@ public function process(File $phpcsFile, $stackPtr)`
`131`	`125`	`&& (!$this->findIdentical($i - 1, $this->findFunctionParenthesisCloser($i) + 1))`
`132`	`126`	`) {`
`133`	`127`	`$foundFunctionName = $this->tokens[$i]['content'];`
`134`		`- $phpcsFile->addError($this->errorMessage, $i, $this->errorCode, [$foundFunctionName], $this->severity);`
	`128`	`+ $phpcsFile->addError($this->errorMessage, $i, $this->errorCode, [$foundFunctionName]);`
`135`	`129`	`}`
`136`	`130`	`}`
`137`	`131`	`}`