fastlane-plugin-translate_gpt 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d61950fe5af16ec1511687b4cab646b8397be0d4870a5e7c2a8d7f22adc06687
-  data.tar.gz: a04a4b37ba73505bdfea8d6ca7a1b6b0b63cd95f8e2856c9d237a21f513d0a91
+  metadata.gz: b7c0d621832f411e542d6c8dad89a1d3014a6d339d2d384d6f1c06af11263804
+  data.tar.gz: 5feaad22d9a7fdc77dc03420276ba2284946b381e760cdb49297634e51f4eb36
 SHA512:
-  metadata.gz: 15b62929364a8be8f709c950d728a22ee72179a65aeffcb7a1156a23d3883404daf36219101b9aab8c2f0c8b12e22316d93a60407c9addaa72fdac5a1a68ca42
-  data.tar.gz: 6ac27ed65e2acca6a533ada325f1fe3e0756befd2fb803429b79864092a66eadaefff681a1eefd5fcd74e3f2b65bb87b301ded820a6541e628183df816a2a8ee
+  metadata.gz: 82b6bdab41b284e766cb3132e05ac232bcc67699d1f6dd1dca6bdfc944a439148d21d0938802a23fa7cc381ac691c705c077d0a97197b506f78039ab07d968a2
+  data.tar.gz: 90566f6958edcd137faa972a4aa7d3e96ea58ea9cb5fd9d17fa9f2aecf137bf1a3744ae7ee264d1380508aa182aef5be8c02b0532ab5b5825c83da3fa13cf5bf

data/README.md

@@ -52,6 +52,34 @@ The following options are available for `translate-gpt`:
 | `target_language` | The target language of the translated strings. Required. | `GPT_TARGET_LANGUAGE` |
 | `source_file` | The path to the `Localizable.strings` file to be translated. Defaults to `./Resources/Localizable.strings`. | `GPT_SOURCE_FILE` |
 | `target_file` | The path to the output file for the translated strings. Defaults to `./Resources/Localizable.strings.<target_language>`. | `GPT_TARGET_FILE` |
+| `context` | Common context for the translation | `GPT_COMMON_CONTEXT` |
+
+## Providing context
+
+The `TranslateGptAction` allows you to provide additional context for your translation requests in two ways:
+
+### 1. Using a common context
+
+You can provide a common context for your project that will be used in all translation requests. This can be done by setting the `common` property when calling the `TranslateGptAction`. The `common` property should be a string that describes the context of your project.
+
+```ruby
+translate_gpt(
+  target_language: 'fr',
+  common: "This is a mobile app for ordering food online"
+)
+```
+
+### 2. Adding comments for specific keys
+
+You can also add comments to your Localizable.strings file for specific keys. These comments will be included in the translation request for that key. To add a comment for a specific key, simply include a comment before the key in your Localizable.strings file.
+
+```text
+/* This is a comment for KEY1 */
+"KEY1" = "Value for KEY1";
+```
+
+When you run the `TranslateGptAction`, the comment will be included in the translation request for `KEY1`.
+
 
 ## Authentication
 

data/lib/fastlane/plugin/translate_gpt/actions/translate_gpt_action.rb

@@ -20,14 +20,17 @@ module Fastlane
           to_translate = input_hash
         end
 
-        UI.message "Translating #{input_hash.size} strings..."
+        UI.message "Translating #{to_translate.size} strings..."
 
-        to_translate.each do |key, value|
-          prompt = "Translate the following string from #{params[:source_language]} to #{params[:target_language]}:\n#{value}"
+        to_translate.each_with_index do |(key, value), index|
+          prompt = "Translate the following string from #{params[:source_language]} to #{params[:target_language]}: #{value}"
           context = Helper::TranslateGptHelper.get_context(params[:source_file], key)
           if context && !context.empty?
             prompt += "\n\nAdditional context:\n#{context}"
           end
+          if params[:context] && !params[:context].empty?
+            prompt += "\n\nCommon context:\n#{params[:context]}"
+          end
           # translate the source string to the target language
           response = client.chat(
             parameters: {
@@ -36,7 +39,6 @@ module Fastlane
               temperature: params[:temperature],
             }
           )
-          #puts response
           # extract the translated string from the response
           error = response.dig("error", "message")
           if error
@@ -50,7 +52,9 @@ module Fastlane
               UI.warning "Unable to translate #{key} - #{value}"
             end
           end
-          Helper::TranslateGptHelper.timeout params[:request_timeout]
+          if index < to_translate.size - 1
+            Helper::TranslateGptHelper.timeout params[:request_timeout]
+          end
         end
 
         UI.message "Writing #{output_hash.size} strings to #{params[:target_file]}..."
@@ -138,7 +142,14 @@ module Fastlane
               UI.user_error!("Invalid file path: #{value}") unless File.exist?(value)
               UI.user_error!("Translation file must have .strings extension") unless File.extname(value) == ".strings"
             end
-          ),                         
+          ),    
+          FastlaneCore::ConfigItem.new(
+            key: :context,
+            env_name: "GPT_COMMON_CONTEXT",
+            description: "Common context for the translation",
+            optional: true,
+            type: String
+          )                     
         ]
       end
 

data/lib/fastlane/plugin/translate_gpt/helper/translate_gpt_helper.rb

@@ -30,7 +30,7 @@ module Fastlane
         content = File.read(localization_file)
 
         # search for the comments associated with the localization key
-        regex = /\/\*\*\n\s*\* @key\s+#{localization_key}\n((\s*\*.*\n)+)\s*\*\/\n\s*"#{localization_key}"/
+        regex = /^\/\*(.+)\*\/\n"#{localization_key}"/ 
         match = content.match(regex)
 
         # return the comments, if found

data/lib/fastlane/plugin/translate_gpt/version.rb

@@ -1,5 +1,5 @@
 module Fastlane
   module TranslateGpt
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-translate_gpt
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Aleksei Cherepanov