[+]: "PhpCodeParser" -> allow to exclude some files

Author: voku

src/voku/SimplePhpParser/Parsers/PhpCodeChecker.php

@@ -34,6 +34,7 @@ public static function checkFromString(
      * @param bool     $skipFunctionsWithLeadingUnderscore
      * @param bool     $skipParseErrorsAsError
      * @param string[] $composerAutoloaderProjectPaths
+     * @param string[] $pathExcludeRegex
      *
      * @return string[][]
      */
@@ -44,11 +45,13 @@ public static function checkPhpFiles(
         bool $skipDeprecatedFunctions = false,
         bool $skipFunctionsWithLeadingUnderscore = false,
         bool $skipParseErrorsAsError = true,
-        array $composerAutoloaderProjectPaths = []
+        array $composerAutoloaderProjectPaths = [],
+        array $pathExcludeRegex = []
     ): array {
         $phpInfo = PhpCodeParser::getPhpFiles(
             $path,
-            $composerAutoloaderProjectPaths
+            $composerAutoloaderProjectPaths,
+            $pathExcludeRegex
         );
 
         $errors = $phpInfo->getParseErrors();

src/voku/SimplePhpParser/Parsers/PhpCodeParser.php

@@ -23,14 +23,26 @@
 
 final class PhpCodeParser
 {
-    public static function getFromString(string $code): ParserContainer
-    {
-        return self::getPhpFiles($code);
+    /**
+     * @param string   $code
+     * @param string[] $composerAutoloaderProjectPaths
+     *
+     * @return \voku\SimplePhpParser\Parsers\Helper\ParserContainer
+     */
+    public static function getFromString(
+        string $code,
+        array $composerAutoloaderProjectPaths = []
+    ): ParserContainer {
+        return self::getPhpFiles(
+            $code,
+            $composerAutoloaderProjectPaths
+        );
     }
 
     /**
      * @param string   $pathOrCode
      * @param string[] $composerAutoloaderProjectPaths
+     * @param string[] $pathExcludeRegex
      *
      * @return \voku\SimplePhpParser\Parsers\Helper\ParserContainer
      *
@@ -39,9 +51,13 @@ public static function getFromString(string $code): ParserContainer
      */
     public static function getPhpFiles(
         string $pathOrCode,
-        array $composerAutoloaderProjectPaths = []
+        array $composerAutoloaderProjectPaths = [],
+        array $pathExcludeRegex = []
     ): ParserContainer {
-        $phpCodes = self::getCode($pathOrCode);
+        $phpCodes = self::getCode(
+            $pathOrCode,
+            $pathExcludeRegex
+        );
 
         $parserContainer = new ParserContainer();
         $visitor = new ASTVisitor($parserContainer);
@@ -235,14 +251,17 @@ public static function file_get_contents_with_cache(string $fileName, Cache $cac
     }
 
     /**
-     * @param string $pathOrCode
+     * @param string   $pathOrCode
+     * @param string[] $pathExcludeRegex
      *
      * @return array
      *
      * @psalm-return array<string, array{content: string, fileName: null|string}>
      */
-    private static function getCode(string $pathOrCode): array
-    {
+    private static function getCode(
+        string $pathOrCode,
+        array $pathExcludeRegex = []
+    ): array {
         // init
         $phpCodes = [];
         /** @var SplFileInfo[] $phpFileIterators */
@@ -271,6 +290,12 @@ private static function getCode(string $pathOrCode): array
                 continue;
             }
 
+            foreach ($pathExcludeRegex as $regex) {
+                if (\preg_match($regex, $path)) {
+                    continue 2;
+                }
+            }
+
             $phpFilePromises[] = Worker\enqueueCallable(
                 [self::class, 'file_get_contents_with_cache'],
                 $path,

tests/ParserTest.php

@@ -43,7 +43,11 @@ public function testSimpleOneClassV2(): void
 
     public function testSimpleDirectory(): void
     {
-        $phpCode = PhpCodeParser::getPhpFiles(__DIR__ . '/');
+        $phpCode = PhpCodeParser::getPhpFiles(
+            __DIR__ . '/',
+            [],
+            ['/Dummy5/']
+        );
 
         $phpClasses = $phpCode->getClasses();