Add translation finder with a command

composer.json

@@ -16,6 +16,7 @@
     ],
     "require": {
         "php": "^8.1",
+        "illuminate/console": "^9.0|^10.0|^11.0",
         "illuminate/support": "^9.0|^10.0|^11.0",
         "illuminate/translation": "^9.0|^10.0|^11.0"
     },

src/Console/FindTranslationsCommand.php

@@ -0,0 +1,23 @@
+<?php declare(strict_types=1);
+
+namespace Bambamboole\LaravelTranslationDumper\Console;
+
+use Bambamboole\LaravelTranslationDumper\TranslationDumperInterface;
+use Bambamboole\LaravelTranslationDumper\TranslationFinder;
+use Illuminate\Console\Command;
+
+class FindTranslationsCommand extends Command
+{
+    protected $signature = 'translations:find';
+
+    protected $description = 'Find translations in PHP code and template files';
+
+    public function handle(TranslationFinder $finder, TranslationDumperInterface $dumper): int
+    {
+        $translations = $finder->findTranslations();
+        $this->info(sprintf('Found %s translations', count($translations)));
+        $dumper->dump($translations);
+
+        return self::SUCCESS;
+    }
+}

src/LaravelTranslationDumperServiceProvider.php

@@ -2,6 +2,7 @@
 
 namespace Bambamboole\LaravelTranslationDumper;
 
+use Bambamboole\LaravelTranslationDumper\Console\FindTranslationsCommand;
 use Illuminate\Contracts\Config\Repository;
 use Illuminate\Contracts\Foundation\Application;
 use Illuminate\Filesystem\Filesystem;
@@ -13,6 +14,9 @@
     public function boot(): void
     {
         if ($this->app->runningInConsole()) {
+            $this->commands([
+                FindTranslationsCommand::class,
+            ]);
             $this->publishes([
                 dirname(__DIR__).'/config/config.php' => $this->app->configPath('translation.php'),
             ], 'config');
@@ -23,23 +27,28 @@
     {
         $this->mergeConfigFrom(__DIR__.'/../config/config.php', 'translation');
 
-        if ($this->app->make(Repository::class)->get('translation.dump_translations')) {
-            $this->app->singleton(
-                TranslationDumper::class,
-                static fn (Application $app) => new TranslationDumper(
-                    new Filesystem(),
-                    new ArrayExporter(),
-                    $app->langPath(),
-                    $app->make(Repository::class)->get('app.locale'),
-                    $app->make(Repository::class)->get('translation.dump_prefix'),
-                ),
-            );
+        $this->app->singleton(
+            TranslationDumper::class,
+            static fn (Application $app) => new TranslationDumper(
+                new Filesystem(),
+                new ArrayExporter(),
+                $app->langPath(),
+                $app->make(Repository::class)->get('app.locale'),
+                $app->make(Repository::class)->get('translation.dump_prefix'),
+            ),
+        );
 
-            $this->app->bind(
-                TranslationDumperInterface::class,
-                static fn (Application $app) => $app->make($app->make(Repository::class)->get('translation.dumper'))
-            );
+        $this->app->bind(
+            TranslationDumperInterface::class,
+            static fn (Application $app) => $app->make($app->make(Repository::class)->get('translation.dumper'))
+        );
+
+        $this->app->singleton(
+            TranslationFinder::class,
+            static fn (Application $app) => new TranslationFinder($app->basePath()),
+        );
 
+        if ($this->app->make(Repository::class)->get('translation.dump_translations')) {
             $this->app->extend(
                 'translator',
                 static fn (Translator $translator, $app) => new DumpingTranslator(

src/TranslationFinder.php

@@ -0,0 +1,98 @@
+<?php declare(strict_types=1);
+
+namespace Bambamboole\LaravelTranslationDumper;
+
+use Illuminate\Support\Str;
+use Symfony\Component\Finder\Finder;
+
+class TranslationFinder
+{
+    public function __construct(private readonly string $basePath)
+    {
+    }
+
+    public function findTranslations(): array
+    {
+        $groupKeys = [];
+        $stringKeys = [];
+        $functions = [
+            'trans',
+            'trans_choice',
+            'Lang::get',
+            'Lang::choice',
+            'Lang::trans',
+            'Lang::transChoice',
+            '@lang',
+            '@choice',
+            '__',
+        ];
+
+        // The translation search part is based on the work of the awesome barryvdh in
+        // https://github.com/barryvdh/laravel-translation-manager/blob/master/src/Manager.php
+        $groupPattern =                          // See https://regex101.com/r/WEJqdL/6
+            '[^\w|>]'.                          // Must not have an alphanum or _ or > before real method
+            '('.implode('|', $functions).')'.  // Must start with one of the functions
+            '\('.                               // Match opening parenthesis
+            "[\'\"]".                           // Match " or '
+            '('.                                // Start a new group to match:
+            '[\/a-zA-Z0-9_-]+'.                 // Must start with group
+            "([.](?! )[^\1)]+)+".               // Be followed by one or more items/keys
+            ')'.                                // Close group
+            "[\'\"]".                           // Closing quote
+            '[\),]';                             // Close parentheses or new parameter
+
+        $stringPattern =
+            '[^\w]'.                                     // Must not have an alphanum before real method
+            '('.implode('|', $functions).')'.             // Must start with one of the functions
+            '\(\s*'.                                       // Match opening parenthesis
+            "(?P<quote>['\"])".                            // Match " or ' and store in {quote}
+            "(?P<string>(?:\\\k{quote}|(?!\k{quote}).)*)". // Match any string that can be {quote} escaped
+            '\k{quote}'.                                   // Match " or ' previously matched
+            '\s*[\),]';                                    // Close parentheses or new parameter
+
+        // Find all PHP + Twig files in the app folder, except for storage
+        $finder = new Finder();
+        $files = $finder->in($this->basePath)
+            ->exclude('storage')
+            ->exclude('vendor')
+            ->name('*.php')
+            ->files();
+
+        /** @var \Symfony\Component\Finder\SplFileInfo $file */
+        foreach ($files as $file) {
+            // Search the current file for the pattern
+            if (preg_match_all("/$groupPattern/siU", $file->getContents(), $matches)) {
+                // Get all matches
+                foreach ($matches[2] as $key) {
+                    $groupKeys[] = $key;
+                }
+            }
+
+            if (preg_match_all("/$stringPattern/siU", $file->getContents(), $matches)) {
+                foreach ($matches['string'] as $key) {
+                    if (preg_match("/(^[\/a-zA-Z0-9_-]+([.][^\1)\ ]+)+$)/siU", $key, $groupMatches)) {
+                        // group{.group}.key format, already in $groupKeys but also matched here
+                        // do nothing, it has to be treated as a group
+                        continue;
+                    }
+
+                    //TODO: This can probably be done in the regex, but I couldn't do it.
+                    //skip keys which contain namespacing characters, unless they also contain a
+                    //space, which makes it JSON.
+                    if (! (Str::contains($key, '::') && Str::contains($key, '.'))
+                        || Str::contains($key, ' ')) {
+                        $stringKeys[] = $key;
+                    }
+                }
+            }
+        }
+        // Remove duplicates
+        $groupKeys = array_unique($groupKeys);
+        $stringKeys = array_unique($stringKeys);
+        // Merge and order them
+        $keys = array_merge($groupKeys, $stringKeys);
+        ksort($keys, SORT_NATURAL | SORT_FLAG_CASE);
+
+        return $keys;
+    }
+}

tests/Feature/TranslationFinderTest.php

@@ -0,0 +1,30 @@
+<?php declare(strict_types=1);
+
+namespace Bambamboole\LaravelTranslationDumper\Tests\Feature;
+
+use Bambamboole\LaravelTranslationDumper\TranslationFinder;
+use PHPUnit\Framework\TestCase;
+
+class TranslationFinderTest extends TestCase
+{
+    public function testItCanFindTranslationsInCode(): void
+    {
+        $translations = $this->createSubject()->findTranslations();
+
+        $expected = [
+            'test.dotted',
+            'test.dotted.additional',
+            'This is just a sentence',
+            'test undotted key',
+            'test',
+        ];
+        foreach ($expected as $item) {
+            self::assertContains($item, $translations);
+        }
+    }
+
+    private function createSubject(): TranslationFinder
+    {
+        return new TranslationFinder(__DIR__.'/fixtures/code');
+    }
+}

tests/Feature/fixtures/code/TestClass.php

@@ -0,0 +1,15 @@
+<?php declare(strict_types=1);
+
+namespace Bambamboole\LaravelTranslationDumper\Tests\Feature\fixtures\code;
+
+class TestClass
+{
+    public function get(): array
+    {
+        return [
+            __('test.dotted.additional'),
+            trans('test undotted key'),
+            trans_choice('test'),
+        ];
+    }
+}

tests/Feature/fixtures/code/template.blade.php

@@ -0,0 +1,2 @@
+<div>{{ __('test.dotted') }}</div>
+<div>@lang('This is just a sentence')</div>