add comment suppoer

Author: matronator

README.md

@@ -16,6 +16,7 @@ Enhance your files with variables, conditional blocks and PHP functions as filte
   - [Templates Syntax Highlighting for VS Code](#templates-syntax-highlighting-for-vs-code)
 - [Usage](#usage)
   - [Template syntax](#template-syntax)
+    - [Comments](#comments)
     - [Conditions](#conditions)
     - [Variables](#variables)
       - [Default values](#default-values)
@@ -37,6 +38,7 @@ Enhance your files with variables, conditional blocks and PHP functions as filte
     - Use [built-in filters](#built-in-filters) or provide custom functions
   - Use `<% if %>` blocks to conditionally parse the template
     - Use `<% else %>` blocks to provide an alternative content if the condition is not met
+  - Include `<# comments #>` in the template files that are removed after patsing
 - Parse template files to string
   - Parse the entire file as a string
 - Provide a custom regex pattern to parse functions to use a custom syntax
@@ -69,6 +71,16 @@ To get syntax highlighting for template files (highlight `<% variable|placeholde
 
 ### Template syntax
 
+#### Comments
+
+You can use comments in your templates by using the following syntax:
+
+```
+<# This is a comment #>
+```
+
+Comments are ignored by the parser and will be removed from the parsed output.
+
 #### Conditions
 
 You can use conditions in your templates by using the `<% if %>` and `<% endif %>` tags. The condition must be a valid PHP expression that will be evaluated and if it returns `true`, the content between the tags will be included in the final output.

src/Parsem/Parser.php

@@ -24,10 +24,10 @@ final class Parser
      * 0: <% var='default'|filter:10,'arg','another' %> --> (full match)
      * 1: var                                           --> (only variable name)
      * 2: ='default'                                    --> (default value)
-     * 3: |filter:10,'arg','another'                     --> (filter with args)
+     * 3: |filter:10,'arg','another'                    --> (filter with args)
      * 4: filter                                        --> (only filter name)
      */
-    public const string VARIABLE_PATTERN = '/<%\s?((?!endif|else)[a-zA-Z0-9_]+)(=.*?)?(\|([a-zA-Z0-9_]+?)(?:\:(?:(?:\\?\'|\\?")?.?(?:\\?\'|\\?")?,?)+?)*?)?\s?%>/m';
+    public const VARIABLE_PATTERN = '/<%\s?((?!endif|else)[a-zA-Z0-9_]+)(=.*?)?(\|([a-zA-Z0-9_]+?)(?:\:(?:(?:\\?\'|\\?")?.?(?:\\?\'|\\?")?,?)+?)*?)?\s?%>/m';
 
     /**
      * Matches:
@@ -39,10 +39,17 @@ final class Parser
      * 5: >               --> (operator)
      * 6: 10              --> (right side)
      */
-    public const string CONDITION_PATTERN = '/(?<all><%\s?if\s(?<condition>(?<negation>!?)(?<left>\S+?)\s?(?<right>(?<operator>(?:<=|<|===|==|>=|>|!==|!=))\s?(?<value>.+?))?)\s?%>\n?)/m';
+    public const CONDITION_PATTERN = '/(?<all><%\s?if\s(?<condition>(?<negation>!?)(?<left>\S+?)\s?(?<right>(?<operator>(?:<=|<|===|==|>=|>|!==|!=))\s?(?<value>.+?))?)\s?%>\n?)/m';
+
+    /**
+     * Matches:
+     * 0: <# comment #> --> (full match)
+     * 1: comment       --> (only comment)
+     */
+    public const COMMENT_PATTERN = '/<#\s?(.+?)\s?#>/m';
 
     /** @internal */
-    private const string LITERALLY_NULL = '⚠︎__:-␀LITERALLY_NULL␀-:__⚠︎';
+    private const LITERALLY_NULL = '⚠︎__:-␀LITERALLY_NULL␀-:__⚠︎';
 
     /**
      * Parses a file to a PHP object, replacing all template variables with the provided `$arguments` values.
@@ -77,6 +84,7 @@ public static function parseString(mixed $string, array $arguments = [], bool $s
         if (!is_string($string)) return $string;
 
         $string = static::parseConditions($string, $arguments);
+        $string = static::removeComments($string);
 
         preg_match_all($pattern ?? static::VARIABLE_PATTERN, $string, $matches);
         $args = [];
@@ -140,7 +148,7 @@ public static function parseConditions(string $string, array $arguments = [], in
         if (!$endMatches) {
             throw new RuntimeException("Missing <% endif %> tag.");
         }
-        
+
         $conditionEnd = $endMatches[0][1];
         $replaceLength = $conditionEnd - $conditionStart + strlen($endMatches[0][0]);
 
@@ -155,6 +163,11 @@ public static function parseConditions(string $string, array $arguments = [], in
         return static::parseConditions($string, $arguments, $conditionStart);
     }
 
+    public static function removeComments(string $string): string
+    {
+        return preg_replace(static::COMMENT_PATTERN, '', $string);
+    }
+
     /**
      * Converts a YAML, JSON or NEON file to a corresponding PHP object, replacing all template variables with the provided `$arguments` values.
      * @deprecated 3.2.0 __Will be removed in the next version.__ This was used for parsing JSON/YAML/NEON templates in v1 and is no longer needed in v2 and later.
@@ -272,7 +285,7 @@ public static function isValid(string $filename, ?string $contents = null): bool
                 throw new RuntimeException("Failed to get template schema from remote server: " . $e->getMessage());
             }
         }
-        
+
         return $validator->validate($parsed, $schema)->isValid();
     }
 
@@ -412,7 +425,7 @@ protected static function getConditionResult(array $matches, array $arguments =
         if ($negation === '!') {
             $left = !$left;
         }
-        
+
         if (isset($right)) {
             $right = static::transformConditionValue($right, $arguments);
             $result = static::getResultByOperator($left, $operator, $right);
@@ -529,7 +542,7 @@ protected static function parseElseTag(string &$string, int $elseStart, int $els
         $conditionEnd = $endMatches[0][1];
 
         $elseBlock = substr($string, $elseStart + $elseTagLength, $conditionEnd - $elseStart - $elseTagLength);
-        
+
         return $elseBlock;
     }