Excluding keys

config/translation-checker.php

@@ -0,0 +1,20 @@
+<?php
+return [
+
+    /*
+    |--------------------------------------------------------------------------
+    | Laravel Translation Checker
+    |--------------------------------------------------------------------------
+    |
+    | This package allows you to check your Laravel translations for missing
+    | keys, unused keys and unused translations.
+    | You can ignore some keys by adding them to the 'ignore' array.
+    |
+    */
+
+
+    'excluded_keys' => [
+        //
+    ],
+
+];

src/Console/Commands/CheckIfTranslationsAreAllThereCommand.php

@@ -3,6 +3,7 @@
 namespace Larswiegers\LaravelTranslationsChecker\Console\Commands;
 
 use Illuminate\Console\Command;
+use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\File;
 use Illuminate\Support\Str;
 use RecursiveDirectoryIterator;
@@ -15,7 +16,7 @@ class CheckIfTranslationsAreAllThereCommand extends Command
      *
      * @var string
      */
-    protected $signature = 'translations:check {--directory=} {--excludedDirectories=none}';
+    protected $signature = 'translations:check {--directory=} {--excludedDirectories=none} {--excludedKeys=none}';
 
     /**
      * The console command description.
@@ -33,6 +34,7 @@ class CheckIfTranslationsAreAllThereCommand extends Command
      * @var array
      */
     public array $realLines = [];
+    private Collection $excludedKeys;
 
     /**
      * Create a new command instance.
@@ -52,20 +54,16 @@ public function __construct()
     public function handle()
     {
         $directory = $this->option('directory') ?: app()->langPath();
-
-        if ($this->option('excludedDirectories') === 'none') {
-            $this->excludedDirectories = [];
-        } elseif ($this->option('excludedDirectories')) {
-            $this->excludedDirectories = explode(',', $this->option('excludedDirectories'));
-        } else {
-            $this->excludedDirectories = [];
-        }
-
         if (!$this->checkIfDirectoryExists($directory)) {
             $this->error('The passed directory (' . $directory . ') does not exist.');
             return $this::FAILURE;
         }
 
+        $this->excludedDirectories = $this->getExcludedDirectories();
+
+        $this->excludedKeys = $this->getExcludedKeys();
+
+
         $languages = $this->getLanguages($directory);
         $missingFiles = [];
 
@@ -106,24 +104,25 @@ public function handle()
 
 				$exists = $this->translationExistsAsJsonOrAsSubDir($directory, $language, $fileKey, $keyWithoutFile);
 
-                if ($this->isDirInExcludedDirectories($language)) {
+                if ($this->isDirInExcludedDirectories($language) ||
+                    $exists ||
+                    $this->excludedKeys->contains($keyWithoutFile)
+                ) {
                     continue;
                 }
-                if (!$exists) {
-                    $fileName = Str::replace(['.php', '.json'], '', $fileKey);
 
-                    foreach($languages as $checkingLanguage) {
-                        if(Str::contains($fileName, $checkingLanguage)) {
-                            $fileName = str_replace($checkingLanguage, '', $fileName);
-                        }
-                    }
+                $fileName = Str::replace(['.php', '.json'], '', $fileKey);
 
-                    if(Str::contains($fileKey, $languages)) {
-                        $missing[] = $language . '.' . $keyWithoutFile;
-                    }else {
-                        $missing[] = $language . '.' . $fileName . '.' . $keyWithoutFile;
+                foreach($languages as $checkingLanguage) {
+                    if(Str::contains($fileName, $checkingLanguage)) {
+                        $fileName = str_replace($checkingLanguage, '', $fileName);
                     }
+                }
 
+                if(Str::contains($fileKey, $languages)) {
+                    $missing[] = $language . '.' . $keyWithoutFile;
+                }else {
+                    $missing[] = $language . '.' . $fileName . '.' . $keyWithoutFile;
                 }
             }
         }
@@ -246,4 +245,29 @@ public function translationExistsAsJsonOrAsSubDir($directory, $language, string
         $existsAsJSONValue = array_key_exists($directory . DIRECTORY_SEPARATOR . $language . '.' . $fileKeyWithoutLangComponent . '**' . $keyWithoutFile, $this->realLines);
         return $existsAsSubDirValue || $existsAsJSONValue;
     }
+
+    /**
+     * @return array
+     */
+    public function getExcludedDirectories(): array
+    {
+        if ($this->option('excludedDirectories') === 'none') {
+            return [];
+        } elseif ($this->option('excludedDirectories')) {
+            return explode(',', $this->option('excludedDirectories'));
+        } else {
+            return [];
+        }
+    }
+
+    private function getExcludedKeys(): Collection
+    {
+        if ($this->option('excludedKeys') === 'none') {
+            return collect(config('translation-checker.excluded_keys'));
+        } elseif ($this->option('excludedKeys')) {
+            return collect(explode(',', $this->option('excludedKeys')));
+        } else {
+            return collect();
+        }
+    }
 }

src/LaravelTranslationsCheckerServiceProvider.php

@@ -22,7 +22,7 @@ public function boot()
 
         if ($this->app->runningInConsole()) {
             $this->publishes([
-                __DIR__.'/../config/config.php' => config_path('laravel-translations-checker.php'),
+                __DIR__ . '/../config/translation-checker.php' => config_path('laravel-translations-checker.php'),
             ], 'config');
 
             // Publishing the views.
@@ -53,7 +53,7 @@ public function boot()
     public function register()
     {
         // Automatically apply the package configuration
-        $this->mergeConfigFrom(__DIR__.'/../config/config.php', 'laravel-translations-checker');
+        $this->mergeConfigFrom(__DIR__ . '/../config/translation-checker.php', 'laravel-translations-checker');
 
         // Register the main class to use with the facade
         $this->app->singleton('laravel-translations-checker', function () {

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

@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Console\Commands;
+
+use Illuminate\Contracts\Support\Arrayable;
+use Illuminate\Support\Facades\Artisan;
+use Illuminate\Support\Facades\Config;
+use Tests\TestCase;
+
+final class ConfigExcludesTest extends TestCase
+{
+
+    public string $excludesDir = "tests/resources/lang/excluded_keys/";
+    public function test_it_is_okay_if_we_dont_pass_in_excluded_keys()
+    {
+        $dir = $this->excludesDir . 'no_excludes';
+        $command = $this->artisan('translations:check', [
+            '--directory' => $dir,
+            '--excludedKeys' => []
+        ]);
+
+        $command->assertExitCode(0);
+    }
+
+    public function test_it_excludes_a_key_if_it_is_passed_in()
+    {
+        $dir = $this->excludesDir . 'exclude_one_missing_key';
+        $command = $this->artisan('translations:check', [
+            '--directory' => $dir,
+            '--excludedKeys' => implode(',', [
+                'test_key'
+            ])
+        ]);
+
+        $command->assertExitCode(0);
+    }
+
+    public function test_it_can_get_them_from_config()
+    {
+        $dir = $this->excludesDir . 'exclude_one_missing_key';
+
+        Config::set('translation-checker.excluded_keys', ['test_key']);
+
+        $command = $this->artisan('translations:check', [
+            '--directory' => $dir
+        ]);
+
+        $command->assertExitCode(0);
+    }
+}

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

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

tests/resources/lang/excluded_keys/exclude_one_missing_key/nl/test.php

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

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

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

tests/resources/lang/excluded_keys/no_excludes/nl/test.php

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