crude key exclusion

src/Console/Commands/CheckIfTranslationsAreAllThereCommand.php

@@ -6,6 +6,7 @@
 use Illuminate\Support\Facades\File as FileFacade;
 use Larswiegers\LaravelTranslationsChecker\Console\Domain\Features\DirectoryExclusion;
 use Larswiegers\LaravelTranslationsChecker\Console\Domain\Features\GetLanguages;
+use Larswiegers\LaravelTranslationsChecker\Console\Domain\Features\KeyExclusion;
 use Larswiegers\LaravelTranslationsChecker\Console\Domain\Features\LanguagesWithMissingFiles;
 use Larswiegers\LaravelTranslationsChecker\Console\Domain\Features\LanguagesWithMissingKeys;
 use Larswiegers\LaravelTranslationsChecker\Console\Domain\File;
@@ -20,7 +21,7 @@ class CheckIfTranslationsAreAllThereCommand extends Command
      *
      * @var string
      */
-    protected $signature = 'translations:check {--directory=} {--excludedDirectories=config}';
+    protected $signature = 'translations:check {--directory=} {--excludedDirectories=config} {--excludedKeys=config}';
 
     /**
      * The console command description.
@@ -66,6 +67,7 @@ public function handle(): int
         }
 
         DirectoryExclusion::getExcludedDirectories($this->options());
+        KeyExclusion::getExcludedKeys($this->options());
 
         $languages = $this->getLanguages->getLanguages($topDirectory);
 

src/Console/Domain/Features/KeyExclusion.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Larswiegers\LaravelTranslationsChecker\Console\Domain\Features;
+
+use Larswiegers\LaravelTranslationsChecker\Console\Domain\Line;
+
+class KeyExclusion
+{
+
+    /**
+     * @var array|false|string[]
+     */
+    private static array $excludedKeys = [];
+
+    public static function shouldExclude(Line $line): bool
+    {
+        return in_array($line->getKey(), self::$excludedKeys);
+    }
+
+    /**
+     * @param  array<string>  $options
+     */
+    public static function getExcludedKeys(array $options): void
+    {
+        if ($options['excludedKeys'] === 'config') {
+            self::$excludedKeys = (array) config('translations-checker.excluded_keys', []);
+        } elseif ($options['excludedKeys']) {
+            self::$excludedKeys = explode(',', $options['excludedKeys']);
+        } elseif (empty((array) config('translations-checker.excluded_keys', []))) {
+            self::$excludedKeys = (array) config('translations-checker.excluded_keys', []);
+        } else {
+            self::$excludedKeys = [];
+        }
+    }
+}

src/Console/Domain/Features/LanguagesWithMissingKeys.php

@@ -50,6 +50,10 @@ public function getMissingKeysTexts(array $realLines, array $languages): void
                     continue;
                 }
 
+                if(KeyExclusion::shouldExclude($line)) {
+                    continue;
+                }
+
                 $file = new File($fileKey);
                 $fileName = $file->withoutExtensionAndLanguages($languages);
 

tests/Tests/Unit/Console/Commands/CheckExcludeKeysTest.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Console\Commands;
+
+use Tests\TestCase;
+
+class CheckExcludeKeysTest extends TestCase
+{
+    private string $exclusionDir = 'tests/resources/lang/excluded_keys';
+
+    public function setUp(): void
+    {
+        parent::setUp();
+    }
+
+    public function testItWorksFineIfKeyExistButIsExcluded()
+    {
+        $command = $this->artisan('translations:check', [
+            '--directory' => $this->exclusionDir .'/excluded_but_existing',
+            '--excludedKeys' => 'test.existing_key',
+        ]);
+
+        $command->assertExitCode(0);
+    }
+
+    public function testItWorksFineIfKeyIsMissingButIsExcluded()
+    {
+        config()->set('translations-checker.excluded_keys', null);
+
+
+        $command = $this->artisan('translations:check', [
+            '--directory' => $this->exclusionDir .'/excluded_but_missing',
+            '--excludedKeys' => 'existing_key',
+        ]);
+
+        $command->assertExitCode(0);
+    }
+}

tests/resources/lang/excluded_keys/excluded_but_existing/de/test.php

@@ -0,0 +1,5 @@
+<?php
+
+return [
+    'existing_key' => 'existing_key',
+];

tests/resources/lang/excluded_keys/excluded_but_existing/en/test.php

@@ -0,0 +1,5 @@
+<?php
+
+return [
+    'existing_key' => 'existing_key',
+];

tests/resources/lang/excluded_keys/excluded_but_missing/de/test.php

@@ -0,0 +1,5 @@
+<?php
+
+return [
+    'existing_key' => 'existing_key',
+];

tests/resources/lang/excluded_keys/excluded_but_missing/en/test.php

@@ -0,0 +1,4 @@
+<?php
+
+return [
+];