Improved the name of the config variable for adding persistent strings to translation files. Improved some formatting. Fixed some typos.

Author: kkomelin

config/laravel-translatable-string-exporter.php

@@ -12,7 +12,7 @@
         '*.js',
     ],
 
-    // Indicates weather new lines are allowed in translations.
+    // Indicates whether new lines are allowed in translations.
     'allow-newlines' => false,
 
     // Translation function names.
@@ -23,12 +23,12 @@
         '@lang',
     ],
 
-    // Indicates weather you need to sort the translations alphabetically 
+    // Indicates whether you need to sort the translations alphabetically 
     // by original strings (keys).
     // It helps navigate a translation file and detect possible duplicates.
     'sort-keys' => true,
 
-    // Indicates weather keys added to persistent-strings file should be added
-    // to translation file
-    'add-persistent-strings' => false,
+    // Indicates whether keys from the persistent-strings file should be also added
+    // to translation files automatically on export if they don't yet exist there.
+    'add-persistent-strings-to-translations' => false,
 ];

src/Core/Exporter.php

@@ -52,8 +52,8 @@ public function export($base_path, $language)
             IO::languageFilePath($base_path, self::PERSISTENT_STRINGS_FILENAME_WO_EXT);
         $persistent_strings = IO::readTranslationFile($persistent_strings_path);
 
-        //if enabled import persistent string to translation file
-        $new_strings = $this->addPersistentStringIfEnabled($new_strings, $persistent_strings);
+        // Add persistent strings to the export if enabled.
+        $new_strings = $this->addPersistentStringsIfEnabled($new_strings, $persistent_strings);
 
         // Merge old an new translations preserving existing translations and persistent strings.
         $resulting_strings = $this->mergeStrings($new_strings, $existing_strings, $persistent_strings);
@@ -101,15 +101,18 @@ protected function sortIfEnabled($strings)
     }
 
     /**
-     * Also add keys from persistent-string file to new_string.
+     * Add keys from the persistent-strings file to new strings array.
      *
      * @param array $new_strings
      * @param array $persistent_strings
      * @return array
      */
-    protected function addPersistentStringIfEnabled($new_strings, $persistent_strings) {
-        if (config('laravel-translatable-string-exporter.add-persistent-strings', false)) {
-            $new_strings = array_merge($new_strings, array_combine($persistent_strings, $persistent_strings));
+    protected function addPersistentStringsIfEnabled($new_strings, $persistent_strings) {
+        if (config('laravel-translatable-string-exporter.add-persistent-strings-to-translations', false)) {
+            $new_strings = array_merge(
+                array_combine($persistent_strings, $persistent_strings),
+                $new_strings
+            );
         }
 
         return $new_strings;

tests/ExporterTest.php

@@ -256,9 +256,12 @@ public function testPersistentTranslations()
         $this->assertEquals($expected, $actual);
     }
 
-    public function testAlsoAddPersistentTranslations()
+    public function testAddingPersistentStringsToExport()
     {
-        $this->app['config']->set('laravel-translatable-string-exporter.add-persistent-strings', true);
+        $this->app['config']->set(
+            'laravel-translatable-string-exporter.add-persistent-strings-to-translations',
+            true
+        );
 
         $this->cleanLangsFolder();
 
@@ -274,12 +277,13 @@ public function testAlsoAddPersistentTranslations()
 
         $this->writeToTranslationFile('es', $content);
 
-        // 2. Create a file with the keys of any strings which should persist and added to export file even if they are not contained in the views.
+        // 2. Create a file with the keys of any strings which should persist
+        // even if they are not contained in the views.
 
         $persistentContent = json_encode(['name3_en', 'name5_en']);
         $this->writeToTranslationFile(Exporter::PERSISTENT_STRINGS_FILENAME_WO_EXT, $persistentContent);
 
-        // 3. Create a test view only containing a new string and a string that also in persistent.
+        // 3. Create a test view only containing a new string and a string that is also in persistent strings.
 
         $this->createTestView("{{ __('name1_en') . __('name2_en') . __('name3_en') . __('name4_en') }}");
 
@@ -289,17 +293,13 @@ public function testAlsoAddPersistentTranslations()
 
         $actual = $this->getTranslationFileContent('es');
 
-        // The new and persistent, strings should be added. The rest should remain.
+        // The new and persistent strings should be added. The rest should remain.
 
-        $expected = [
-            'name1_en' => 'name1_es',
-            'name2_en' => 'name2_es',
-            'name3_en' => 'name3_es',
+        $expected = array_merge($existing_translations, [
             'name4_en' => 'name4_en',
             'name5_en' => 'name5_en',
-        ];
+        ]);
 
         $this->assertEquals($expected, $actual);
-
     }
 }