✨ Add Whitespace check for delimiter

Author: VincentLanglet

TwigCS/Sniff/Standard/EnsureWhitespaceDelimiterSniff.php

@@ -0,0 +1,99 @@
+<?php
+
+namespace TwigCS\Sniff\Standard;
+
+use \Exception;
+use TwigCS\Sniff\AbstractPreParserSniff;
+use TwigCS\Token\Token;
+
+/**
+ * Ensure there is one space before and after a delimiter {{, {%, {#, }}, %} and #}
+ */
+class EnsureWhitespaceDelimiterSniff extends AbstractPreParserSniff
+{
+    /**
+     * @param Token   $token
+     * @param int     $tokenPosition
+     * @param Token[] $tokens
+     *
+     * @return Token
+     *
+     * @throws Exception
+     */
+    public function process(Token $token, $tokenPosition, $tokens)
+    {
+        if ($this->isTokenMatching($token, Token::VAR_START_TYPE)
+            || $this->isTokenMatching($token, Token::BLOCK_START_TYPE)
+            || $this->isTokenMatching($token, Token::COMMENT_START_TYPE)
+        ) {
+            $this->processStart($token, $tokenPosition, $tokens);
+        }
+
+        if ($this->isTokenMatching($token, Token::VAR_END_TYPE)
+            || $this->isTokenMatching($token, Token::BLOCK_END_TYPE)
+            || $this->isTokenMatching($token, Token::COMMENT_END_TYPE)
+        ) {
+            $this->processEnd($token, $tokenPosition, $tokens);
+        }
+
+        return $token;
+    }
+
+    /**
+     * @param Token   $token
+     * @param int     $tokenPosition
+     * @param Token[] $tokens
+     *
+     * @throws Exception
+     */
+    public function processStart(Token $token, $tokenPosition, $tokens)
+    {
+        $offset = 1;
+        while ($this->isTokenMatching($tokens[$tokenPosition + $offset], Token::WHITESPACE_TYPE)) {
+            ++$offset;
+        }
+
+        // Ignore new line
+        if ($this->isTokenMatching($tokens[$tokenPosition + $offset], Token::EOL_TYPE)) {
+            return;
+        }
+
+        $count = $offset - 1;
+        if (1 !== $count) {
+            $this->addMessage(
+                $this::MESSAGE_TYPE_ERROR,
+                sprintf('Expecting 1 whitespace AFTER start of expression eg. "{{" or "{%%"; found %d', $count),
+                $token
+            );
+        }
+    }
+
+    /**
+     * @param Token   $token
+     * @param int     $tokenPosition
+     * @param Token[] $tokens
+     *
+     * @throws Exception
+     */
+    public function processEnd(Token $token, $tokenPosition, $tokens)
+    {
+        $offset = 1;
+        while ($this->isTokenMatching($tokens[$tokenPosition - $offset], Token::WHITESPACE_TYPE)) {
+            ++$offset;
+        }
+
+        // Ignore new line
+        if ($this->isTokenMatching($tokens[$tokenPosition - $offset], Token::EOL_TYPE)) {
+            return;
+        }
+
+        $count = $offset - 1;
+        if (1 !== $count) {
+            $this->addMessage(
+                $this::MESSAGE_TYPE_ERROR,
+                sprintf('Expecting 1 whitespace BEFORE end of expression eg. "}}" or "%%}"; found %d', $count),
+                $token
+            );
+        }
+    }
+}

TwigCS/Tests/Fixtures/ensureWhitespaceDelimiter.twig

@@ -0,0 +1,14 @@
+{{ foo }}
+{# comment #}
+{% if foo %}{% endif %}
+
+{{- foo -}}
+{#- comment -#}
+{%- if foo -%}{%- endif -%}
+
+{{
+    shouldNotCareAboutNewLine
+}}
+{%-if foo  -%}{%-  endif-%}
+
+{{ foo({'bar': {'baz': 'shouldNotCareAboutDoubleHashes'}}) }}

TwigCS/Tests/Sniff/EnsureWhitespaceDelimiterTest.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace TwigCS\Tests\Sniff;
+
+use TwigCS\Sniff\Standard\EnsureWhitespaceDelimiterSniff;
+use TwigCS\Tests\AbstractSniffTest;
+
+/**
+ * Class EnsureWhitespaceDelimiterTest
+ */
+class EnsureWhitespaceDelimiterTest extends AbstractSniffTest
+{
+    public function testSniff1()
+    {
+        $this->checkGenericSniff('ensureWhitespaceDelimiter.twig', new EnsureWhitespaceDelimiterSniff(), [
+            [12, 1],
+            [12, 12],
+            [12, 15],
+            [12, 25],
+        ]);
+    }
+}

TwigCS/Token/Tokenizer.php

@@ -279,7 +279,7 @@ protected function lex($endType, $endRegex)
     {
         preg_match($endRegex, $this->code, $match, PREG_OFFSET_CAPTURE, $this->cursor);
 
-        if (!isset($match[0])) {
+        if (!empty($this->brackets) || !isset($match[0])) {
             $this->lexExpression();
         } elseif ($match[0][1] === $this->cursor) {
             $this->pushToken($endType, $match[0][0]);
@@ -290,6 +290,7 @@ protected function lex($endType, $endRegex)
             // Parse as text until the end position.
             $this->lexData($match[0][1]);
         } else {
+            // Should not happen
             while ($this->cursor < $match[0][1]) {
                 $this->lexExpression();
             }