fix phpstan and update readme

Bottelet · Sep 19, 2024 · 985a78a · 985a78a
1 parent ff17fc0
commit 985a78a
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -35,9 +35,10 @@ php artisan translations:check en
 ```json
 {
   "test.value": "Value",
-  "translate this string": "translate this string"
+  "translate this string": null
 }
 ```
+The reason we default to null when no translation service are used is because it defaults to the key used in the function call.
 
 ## Quick Start
 

diff --git a/src/Commands/FindMissingTranslation.php b/src/Commands/FindMissingTranslation.php
@@ -48,7 +48,7 @@ protected function parseOptions(): CommandOptions
     }
 
     /**
-     * @param array<string, string> $missingTranslations
+     * @param array<string, string|null> $missingTranslations
      */
     private function printMissingTranslations(array $missingTranslations): void
     {

diff --git a/src/Finder/MissingKeysFinder.php b/src/Finder/MissingKeysFinder.php
@@ -36,7 +36,7 @@ public function findTranslatableStrings(array $files): array
      * @param  array<int, SplFileInfo>  $files
      * @param  array<string, string>  $existingTranslatedStrings
      *
-     * @return array<string, string>
+     * @return array<string, string|null>
      */
     public function findMissingTranslatableStrings(array $files, array $existingTranslatedStrings): array
     {
@@ -48,7 +48,7 @@ public function findMissingTranslatableStrings(array $files, array $existingTran
     /**
      * @param  array<string>  $foundStrings
      * @param  array<string, string>  $jsonTranslations
-     * @return array<string, string>
+     * @return array<string, string|null>
      */
     protected function extractMissingTranslations(array $foundStrings, array $jsonTranslations): array
     {

diff --git a/src/Finder/TranslationFinder.php b/src/Finder/TranslationFinder.php
@@ -19,7 +19,7 @@ public function getLanguageFilerManager(): LanguageFileManager
     /**
      * @param  array<string>  $sourceFilePaths
      *
-     * @return array<string, string>
+     * @return array<string, string|null>
      */
     public function findMissingTranslations(array $sourceFilePaths): array
     {

diff --git a/src/TranslationManager.php b/src/TranslationManager.php
@@ -20,7 +20,7 @@ public function __construct(
 
     /**
      * @param  array<string>  $sourceFilePaths
-     * @return array<string, string>
+     * @return array<string, string|null>
      */
     public function updateTranslationsFromFile(array $sourceFilePaths, string $targetJsonPath, bool $sort = false, ?string $targetLanguage = null, bool $translateMissing = false, string $sourceLanguage = 'en'): array
     {