✨ Add new rule

Author: VincentLanglet

SymfonyCustom/Sniffs/Namespaces/UseWithoutStartingBackslashSniff.php

@@ -0,0 +1,69 @@
+<?php
+
+namespace SymfonyCustom\Sniffs\Namespaces;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+use PHP_CodeSniffer\Util\Tokens;
+use SymfonyCustom\Sniffs\SniffHelper;
+
+/**
+ * Class UseWithoutStartingBackslashSniff
+ */
+class UseWithoutStartingBackslashSniff implements Sniff
+{
+    /**
+     * @return int[]
+     */
+    public function register()
+    {
+        return [T_USE];
+    }
+
+    /**
+     * @param File $phpcsFile
+     * @param int  $stackPtr
+     *
+     * @return int|void
+     */
+    public function process(File $phpcsFile, $stackPtr)
+    {
+        if (!SniffHelper::isGlobalUse($phpcsFile, $stackPtr)) {
+            return;
+        }
+
+        $tokens = $phpcsFile->getTokens();
+        $classPtr = $phpcsFile->findNext(
+            Tokens::$emptyTokens,
+            $stackPtr + 1,
+            null,
+            true
+        );
+
+        $lowerContent = strtolower($tokens[$classPtr]['content']);
+        if ('function' === $lowerContent || 'const' === $lowerContent) {
+            $classPtr = $phpcsFile->findNext(
+                Tokens::$emptyTokens,
+                $classPtr + 1,
+                null,
+                true
+            );
+        }
+
+        if (T_NS_SEPARATOR === $tokens[$classPtr]['code']
+            || (T_STRING === $tokens[$classPtr]['code']
+                && '\\' === $tokens[$classPtr]['content'])
+        ) {
+            $error = 'Use statement cannot start with a backslash';
+            $fix = $phpcsFile->addFixableError($error, $classPtr, 'BackslashAtStart');
+
+            if ($fix) {
+                if (T_WHITESPACE !== $tokens[$classPtr - 1]['code']) {
+                    $phpcsFile->fixer->replaceToken($classPtr, ' ');
+                } else {
+                    $phpcsFile->fixer->replaceToken($classPtr, '');
+                }
+            }
+        }
+    }
+}

SymfonyCustom/Tests/Namespaces/UseWithoutStartingBackslashUnitTest.inc

@@ -0,0 +1,18 @@
+<?php
+
+namespace Foo;
+
+use \DateTime;
+use const \E_COMPILE_ERROR as ECE;
+use FUNCTION\array_combine as ac;
+
+class Bar
+{
+    use MyTrait;
+
+    public function __construct($foo)
+    {
+        $closure = function ($x) use ($foo) {
+        };
+    }
+}

SymfonyCustom/Tests/Namespaces/UseWithoutStartingBackslashUnitTest.inc.fixed

@@ -0,0 +1,18 @@
+<?php
+
+namespace Foo;
+
+use DateTime;
+use const E_COMPILE_ERROR as ECE;
+use FUNCTION array_combine as ac;
+
+class Bar
+{
+    use MyTrait;
+
+    public function __construct($foo)
+    {
+        $closure = function ($x) use ($foo) {
+        };
+    }
+}

SymfonyCustom/Tests/Namespaces/UseWithoutStartingBackslashUnitTest.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace SymfonyCustom\Tests\Namespaces;
+
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+
+/**
+ * Unit test class for the UseWithoutStartingBackslash sniff.
+ *
+ * @group SymfonyCustom
+ */
+class UseWithoutStartingBackslashUnitTest extends AbstractSniffUnitTest
+{
+    /**
+     * Returns the lines where errors should occur.
+     *
+     * The key of the array should represent the line number and the value
+     * should represent the number of errors that should occur on that line.
+     *
+     * @return array<int, int>
+     */
+    public function getErrorList()
+    {
+        return [
+            2 => 1,
+            3 => 1,
+            4 => 1,
+        ];
+    }
+
+    /**
+     * Returns the lines where warnings should occur.
+     *
+     * The key of the array should represent the line number and the value
+     * should represent the number of errors that should occur on that line.
+     *
+     * @return array(int => int)
+     */
+    public function getWarningList()
+    {
+        return [];
+    }
+}

TwigCS/Command/TwigCSCommand.php

@@ -2,7 +2,7 @@
 
 namespace TwigCS\Command;
 
-use \Exception;
+use Exception;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;

TwigCS/Config/Config.php

@@ -2,7 +2,7 @@
 
 namespace TwigCS\Config;
 
-use \Exception;
+use Exception;
 use Symfony\Component\Finder\Finder;
 
 /**

TwigCS/Report/SniffViolation.php

@@ -2,7 +2,7 @@
 
 namespace TwigCS\Report;
 
-use \LogicException;
+use LogicException;
 use TwigCS\Sniff\SniffInterface;
 
 /**

TwigCS/Ruleset/Generic/BlankEOFSniff.php

@@ -2,7 +2,7 @@
 
 namespace TwigCS\Ruleset\Generic;
 
-use \Exception;
+use Exception;
 use TwigCS\Sniff\AbstractSniff;
 use TwigCS\Token\Token;
 

TwigCS/Ruleset/Generic/DisallowCommentedCodeSniff.php

@@ -2,7 +2,7 @@
 
 namespace TwigCS\Ruleset\Generic;
 
-use \Exception;
+use Exception;
 use TwigCS\Sniff\AbstractSniff;
 use TwigCS\Token\Token;
 

TwigCS/Ruleset/Generic/EmptyLinesSniff.php

@@ -2,7 +2,7 @@
 
 namespace TwigCS\Ruleset\Generic;
 
-use \Exception;
+use Exception;
 use TwigCS\Sniff\AbstractSniff;
 use TwigCS\Token\Token;
 

TwigCS/Ruleset/Ruleset.php

@@ -2,8 +2,8 @@
 
 namespace TwigCS\Ruleset;
 
-use \Exception;
-use \SplFileInfo;
+use Exception;
+use SplFileInfo;
 use Symfony\Component\Finder\Finder;
 use TwigCS\Sniff\SniffInterface;
 

TwigCS/Runner/Fixer.php

@@ -2,7 +2,7 @@
 
 namespace TwigCS\Runner;
 
-use \Exception;
+use Exception;
 use Twig\Source;
 use TwigCS\Ruleset\Ruleset;
 use TwigCS\Token\Token;

TwigCS/Runner/Linter.php

@@ -2,7 +2,7 @@
 
 namespace TwigCS\Runner;
 
-use \Exception;
+use Exception;
 use Twig\Environment;
 use Twig\Error\Error;
 use Twig\Source;

TwigCS/Sniff/AbstractSniff.php

@@ -2,7 +2,7 @@
 
 namespace TwigCS\Sniff;
 
-use \Exception;
+use Exception;
 use TwigCS\Report\Report;
 use TwigCS\Report\SniffViolation;
 use TwigCS\Runner\Fixer;

TwigCS/Sniff/AbstractSpacingSniff.php

@@ -2,7 +2,7 @@
 
 namespace TwigCS\Sniff;
 
-use \Exception;
+use Exception;
 use TwigCS\Token\Token;
 
 /**

TwigCS/Tests/AbstractSniffTest.php

@@ -2,8 +2,8 @@
 
 namespace TwigCS\Tests;
 
-use \Exception;
-use \ReflectionClass;
+use Exception;
+use ReflectionClass;
 use PHPUnit\Framework\TestCase;
 use TwigCS\Environment\StubbedEnvironment;
 use TwigCS\Report\Report;

TwigCS/Token/TokenParser.php

@@ -2,7 +2,7 @@
 
 namespace TwigCS\Token;
 
-use \Exception;
+use Exception;
 use Twig\Node\Node;
 use Twig\Token;
 use Twig\TokenParser\AbstractTokenParser;

TwigCS/Token/Tokenizer.php

@@ -2,7 +2,7 @@
 
 namespace TwigCS\Token;
 
-use \Exception;
+use Exception;
 use Twig\Environment;
 use Twig\Source;