Add support for generating a baseline file (#5)

* Add support for generating a baseline file

* wip

* wip

Author: dmason30

README.md

@@ -52,6 +52,19 @@ $ php artisan translation:unused
 +--------+----------------------+-----------------------------------------------+
 ```
 
+You can generate a baseline file which will be used to ignore specific keys with the 
+`--generate-baseline` or `-b` command options:
+
+```sh
+$ php artisan translation:unused --generate-baseline 
+
+   INFO  Baseline file written with 5 unused translation keys.  
+
+$ php artisan translation:unused
+
+   INFO  No unused translations found!  
+```
+
 ## Roadmap
 - [x] Supports JSON and PHP translation files
     - You can enable / disable file types in the config

config/translation-linter.php

@@ -88,6 +88,18 @@
     ],
 
     'unused' => [
+        /*
+        |--------------------------------------------------------------------------
+        | Baseline file
+        |--------------------------------------------------------------------------
+        |
+        | This is the location of the baseline file that is used to ignore specific
+        | translation keys. You can generate this file by using the `--generate-baseline`
+        | option when running the command.
+        |
+        */
+        'baseline' => base_path('translations.unused.baseline.json'),
+
         /*
         |--------------------------------------------------------------------------
         | Output Fields

pint.json

@@ -1,5 +1,8 @@
 {
     "preset": "laravel",
+    "exclude": [
+        "workbench"
+    ],
     "rules": {
         "single_line_empty_body": true
     }

src/Collections/BaselineCollection.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Fidum\LaravelTranslationLinter\Collections;
+
+use Illuminate\Support\Collection;
+
+class BaselineCollection extends Collection
+{
+    public function shouldReport(string $locale, string $key): bool
+    {
+        $ignoredKeys = $this->get($locale) ?: [];
+
+        if (in_array($key, $ignoredKeys, true)) {
+            return false;
+        }
+
+        return true;
+    }
+}

src/Collections/ResultObjectCollection.php

@@ -16,6 +16,14 @@ public function reset(): void
         $this->items = [];
     }
 
+    public function toBaseLineJson(): string
+    {
+        return $this
+            ->groupBy('locale')
+            ->map(fn (ResultObjectCollection $collection) => $collection->pluck('namespaceHintedKey')->values())
+            ->toJson(JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES);
+    }
+
     public function toCommandTableOutputArray(FieldCollectionContract $fields): array
     {
         $only = $fields->enabled()->toArray();

src/Commands/UnusedCommand.php

@@ -5,20 +5,39 @@
 use Fidum\LaravelTranslationLinter\Contracts\Collections\UnusedFieldCollection;
 use Fidum\LaravelTranslationLinter\Contracts\Collections\UnusedFilterCollection;
 use Fidum\LaravelTranslationLinter\Contracts\Linters\UnusedTranslationLinter;
+use Fidum\LaravelTranslationLinter\Filters\IgnoreKeysFromUnusedBaselineFileFilter;
+use Fidum\LaravelTranslationLinter\Writers\UnusedBaselineFileWriter;
 use Illuminate\Console\Command;
 
 class UnusedCommand extends Command
 {
-    public $signature = 'translation:unused';
+    public $signature = 'translation:unused
+        {--b|generate-baseline : Generate a baseline file from the unused keys.}';
 
     public $description = 'Finds unused language keys.';
 
     public function handle(
+        UnusedBaselineFileWriter $writer,
         UnusedFieldCollection $fields,
         UnusedFilterCollection $filters,
         UnusedTranslationLinter $linter,
     ): int {
-        $results = $linter->execute()->whereShouldReport($filters);
+        $baseline = (bool) $this->option('generate-baseline');
+        $results = $linter->execute();
+
+        if ($baseline) {
+            $results = $results->whereShouldReport($filters);
+
+            $writer->execute($results);
+
+            $this->components->info("Baseline file written with {$results->count()} unused translation keys.");
+
+            return self::SUCCESS;
+        }
+
+        $filters->push(IgnoreKeysFromUnusedBaselineFileFilter::class);
+
+        $results = $results->whereShouldReport($filters);
 
         if ($results->isEmpty()) {
             $this->components->info('No unused translations found!');

src/Contracts/Collections/FilterCollection.php

@@ -8,5 +8,7 @@
 
 interface FilterCollection extends Arrayable, Enumerable
 {
+    public function push(...$values);
+
     public function shouldReport(ResultObject $object): bool;
 }

src/Contracts/Collections/ResultObjectCollection.php

@@ -16,6 +16,8 @@ interface ResultObjectCollection extends Arrayable, Enumerable
 {
     public function reset(): void;
 
+    public function toBaseLineJson(): string;
+
     public function toCommandTableOutputArray(FieldCollectionContract $fields): array;
 
     public function whereShouldReport(FilterCollectionContract $filters): self;

src/Contracts/Readers/UnusedBaselineFileReader.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Fidum\LaravelTranslationLinter\Contracts\Readers;
+
+use Fidum\LaravelTranslationLinter\Collections\BaselineCollection;
+
+interface UnusedBaselineFileReader
+{
+    public function execute(): BaselineCollection;
+}

src/Contracts/Writers/UnusedBaselineFileWriter.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Fidum\LaravelTranslationLinter\Contracts\Writers;
+
+use Fidum\LaravelTranslationLinter\Contracts\Collections\ResultObjectCollection;
+
+interface UnusedBaselineFileWriter
+{
+    public function execute(ResultObjectCollection $results);
+}