allow to exclude paths

Author: QuentinGab

config/translator.php

@@ -43,14 +43,13 @@
     'searchcode' => [
         'service' => 'php-parser',
 
-        'services' => [
-            'php-parser' => [
-                'paths' => [
-                    app_path(),
-                    resource_path(),
-                ],
-            ],
+        'paths' => [
+            app_path(),
+            resource_path(),
         ],
+
+        'excluded_paths' => [],
+
     ],
 
 ];

src/Services/SearchCode/PhpParserService.php

@@ -15,7 +15,8 @@
 class PhpParserService implements SearchCodeServiceInterface
 {
     public function __construct(
-        public array $paths
+        public array $paths,
+        public array $excludedPaths = [],
     ) {
         //
     }
@@ -24,13 +25,16 @@ public function finder(): Finder
     {
         return Finder::create()
             ->in($this->paths)
-            ->followLinks()
+            // ->exclude($this->excludedPaths)
+            ->notPath($this->excludedPaths)
+            ->exclude('vendor')
+            ->exclude('node_modules')
             ->ignoreDotFiles(true)
             ->ignoreVCS(true)
+            ->ignoreVCSIgnored(true)
             ->ignoreUnreadableDirs(true)
-            ->exclude('vendor')
-            ->exclude('node_modules')
             ->name('*.php')
+            ->followLinks()
             ->files();
     }
 

src/TranslatorServiceProvider.php

@@ -91,7 +91,8 @@ public static function getSearchcodeServiceFromConfig(?string $serviceName = nul
 
         return match ($service) {
             'php-parser', PhpParserService::class => new PhpParserService(
-                config('translator.searchcode.services.php-parser.paths')
+                paths: config('translator.searchcode.paths'),
+                excludedPaths: config('translator.searchcode.excluded_paths', [])
             ),
             '', null => null,
             default => new $service,

tests/Feature/TranslatorTest.php

@@ -88,10 +88,13 @@
 it('finds dead translations in a namespace', function () {
     $translator = new Translator(
         storage: $this->getStorage(),
-        searchcodeService: new PhpParserService([
-            $this->getAppPath(),
-            $this->getResourcesPath(),
-        ])
+        searchcodeService: new PhpParserService(
+            paths: [
+                $this->getAppPath(),
+                $this->getResourcesPath(),
+            ],
+            excludedPaths: $this->getExcludedPaths()
+        )
     );
 
     $dead = $translator->getDeadTranslations(
@@ -113,10 +116,13 @@
 it('finds all dead translations', function () {
     $translator = new Translator(
         storage: $this->getStorage(),
-        searchcodeService: new PhpParserService([
-            $this->getAppPath(),
-            $this->getResourcesPath(),
-        ])
+        searchcodeService: new PhpParserService(
+            paths: [
+                $this->getAppPath(),
+                $this->getResourcesPath(),
+            ],
+            excludedPaths: $this->getExcludedPaths()
+        )
     );
 
     $deadTranslations = $translator->getAllDeadTranslations();

tests/TestCase.php

@@ -10,6 +10,14 @@
 
 class TestCase extends Orchestra
 {
+    public function getExcludedPaths(): array
+    {
+        return [
+            'ignored',
+            'ignored.blade.php',
+        ];
+    }
+
     public function getAppPath(): string
     {
         return __DIR__.'/src/app';

tests/Unit/PhpParserServiceTest.php

@@ -26,6 +26,7 @@
             $appPath,
             $resourcesPath,
         ],
+        excludedPaths: $this->getExcludedPaths()
     );
 
     expect($service->translationsByFiles())->toBe([
@@ -53,6 +54,7 @@
             $appPath,
             $resourcesPath,
         ],
+        excludedPaths: $this->getExcludedPaths()
     );
 
     expect($service->filesByTranslations())->toBe([

tests/src/app/ignored/IgnoredDummyClass.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Elegantly\Translator\Tests\Src\App\Ignored;
+
+class IgnoredDummyClass
+{
+    public function getLabel()
+    {
+        return __(key: 'messages.hello');
+    }
+}

tests/src/resources/ignored.blade.php

@@ -0,0 +1,3 @@
+<div>
+    {{ __('messages.hello') }}
+</div>