Remove unwanted lang translation when generated xcStrings catalog

Reviewed-on: #20
Reviewed-by: Thibaut Schmitt <t.schmitt@openium.fr>
Co-authored-by: Quentin Bandera <q.bandera@openium.fr>
Co-committed-by: Quentin Bandera <q.bandera@openium.fr>

Makefile

@@ -1,7 +1,6 @@
 SHELL = /bin/zsh
 
-#INSTALL_DIR ?= /usr/local/bin
-INSTALL_DIR = /tmp/ResgenYolo
+INSTALL_DIR = /usr/local/bin
 
 MAN_DIR := /usr/local/share/man
 MAN_PAGE_NAME = resgen-swift.1
@@ -14,7 +13,7 @@ BUILD_DIR = $(REPO_DIR)/.build
 
 # create-man-files:
 # 	swift package plugin generate-manual
-# 	cp $(BUILDDIR)/plugins/GenerateManualPlugin/outputs/ResgenSwift/resgen-swift.1 $(REPODIR)/man/resgen-swift.1
+# 	cp $(BUILDDIR)/plugins/GenerateManual/outputs/ResgenSwift/resgen-swift.1 $(REPODIR)/man/resgen-swift.1
 
 # install-man-files:
 # 	mkdir -p ${DESTDIR}${mandir}/man1
@@ -23,7 +22,7 @@ BUILD_DIR = $(REPO_DIR)/.build
 create-and-install-man-files:
 	swift package plugin generate-manual
 	mkdir -p ${MAN_DIR}/man1
-	cp $(BUILD_DIR)/plugins/GenerateManualPlugin/outputs/ResgenSwift/${MAN_PAGE_NAME} ${MAN_DIR}/man1/${MAN_PAGE_NAME}
+	cp $(BUILD_DIR)/plugins/GenerateManual/outputs/ResgenSwift/${MAN_PAGE_NAME} ${MAN_DIR}/man1/${MAN_PAGE_NAME}
 
 #
 # Build and install

Package.resolved

@@ -1,4 +1,5 @@
 {
+  "originHash" : "fae67d9ce14b6664edc4151ad1a55b74d50d7281499f09eeca50b0376d0f837f",
   "pins" : [
     {
       "identity" : "swift-argument-parser",
@@ -14,8 +15,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/lukepistrol/SwiftLintPlugin",
       "state" : {
-        "revision" : "87454f5c9ff4d644086aec2a0df1ffba678e7f3c",
-        "version" : "0.57.1"
+        "revision" : "8e785a9801fc7961fef3d41ccb81acb3bd3d9735",
+        "version" : "0.60.0"
       }
     },
     {
@@ -28,5 +29,5 @@
       }
     }
   ],
-  "version" : 2
+  "version" : 3
 }

Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version:5.9
+// swift-tools-version:6.1
 // The swift-tools-version declares the minimum version of Swift required to build this package.
 
 import PackageDescription
@@ -18,7 +18,7 @@ let package = Package(
         ),
         .package(
             url: "https://github.com/lukepistrol/SwiftLintPlugin",
-            exact: "0.57.1"
+            exact: "0.60.0"
         ),
     ],
     targets: [

SampleFiles/Strings/Generated/String+GenAllScript.swift

@@ -6,7 +6,7 @@ fileprivate let kStringsFileName = "sampleStrings"
 
 extension String {
 
-    public enum KeyGenAllScript: String {
+    internal enum KeyGenAllScript: String {
         case param_lang = "param_lang"
         case generic_back = "generic_back"
         case generic_loading_data = "generic_loading_data"
@@ -14,7 +14,7 @@ extension String {
         case test_equal_symbol = "test_equal_symbol"
         case placeholders_test_one = "placeholders_test_one"
 
-        public var keyPath: KeyPath<String, String> {
+        internal var keyPath: KeyPath<String, String> {
             switch self {
             case .param_lang: return \String.param_lang
             case .generic_back: return \String.generic_back
@@ -33,7 +33,7 @@ extension String {
     ///
     /// Comment :
     /// No comment
-    public var param_lang: String {
+    internal var param_lang: String {
         NSLocalizedString("param_lang", tableName: kStringsFileName, bundle: Bundle.main, value: "en", comment: "")
     }
 
@@ -44,17 +44,17 @@ extension String {
     ///
     /// Comment :
     /// No comment
-    public var generic_back: String {
+    internal var generic_back: String {
         NSLocalizedString("generic_back", tableName: kStringsFileName, bundle: Bundle.main, value: "Back", comment: "")
     }
 
     /// Translation in en :
-    /// Loading data...
+    /// Loading\ndata...
     ///
     /// Comment :
     /// No comment
-    public var generic_loading_data: String {
-        NSLocalizedString("generic_loading_data", tableName: kStringsFileName, bundle: Bundle.main, value: "Loading data...", comment: "")
+    internal var generic_loading_data: String {
+        NSLocalizedString("generic_loading_data", tableName: kStringsFileName, bundle: Bundle.main, value: "Loading\ndata...", comment: "")
     }
 
     /// Translation in en :
@@ -62,7 +62,7 @@ extension String {
     ///
     /// Comment :
     /// No comment
-    public var generic_welcome_firstname_format: String {
+    internal var generic_welcome_firstname_format: String {
         NSLocalizedString("generic_welcome_firstname_format", tableName: kStringsFileName, bundle: Bundle.main, value: "Welcome \"%@\" !", comment: "")
     }
     /// Translation in en :
@@ -70,7 +70,7 @@ extension String {
     ///
     /// Comment :
     /// No comment
-    public func generic_welcome_firstname_format(arg0: String) -> String {
+    internal func generic_welcome_firstname_format(arg0: String) -> String {
         String(format: self.generic_welcome_firstname_format, arg0)
     }
 
@@ -81,7 +81,7 @@ extension String {
     ///
     /// Comment :
     /// No comment
-    public var test_equal_symbol: String {
+    internal var test_equal_symbol: String {
         NSLocalizedString("test_equal_symbol", tableName: kStringsFileName, bundle: Bundle.main, value: "1€ = 1 point !", comment: "")
     }
 
@@ -92,7 +92,7 @@ extension String {
     ///
     /// Comment :
     /// No comment
-    public var placeholders_test_one: String {
+    internal var placeholders_test_one: String {
         NSLocalizedString("placeholders_test_one", tableName: kStringsFileName, bundle: Bundle.main, value: "You %%: %2$@ %1$@ Age: %3$d", comment: "")
     }
     /// Translation in en :
@@ -100,7 +100,7 @@ extension String {
     ///
     /// Comment :
     /// No comment
-    public func placeholders_test_one(arg0: String, arg1: String, arg2: Int) -> String {
+    internal func placeholders_test_one(arg0: String, arg1: String, arg2: Int) -> String {
         String(format: self.placeholders_test_one, arg0, arg1, arg2)
     }
 }

SampleFiles/Strings/Generated/sampleStrings.xcstrings

@@ -32,19 +32,19 @@
         "en" : {
           "stringUnit" : {
             "state" : "translated",
-            "value" : "Loading data..."
+            "value" : "Loading\ndata..."
           }
         },
         "en-us" : {
           "stringUnit" : {
             "state" : "translated",
-            "value" : "Loading data..."
+            "value" : "Loading\ndata..."
           }
         },
         "fr" : {
           "stringUnit" : {
             "state" : "translated",
-            "value" : "Chargement des données..."
+            "value" : "Chargement\ndes données..."
           }
         }
       }
@@ -56,19 +56,19 @@
         "en" : {
           "stringUnit" : {
             "state" : "translated",
-            "value" : "Welcome \\\"%@\\\" !"
+            "value" : "Welcome \"%@\" !"
           }
         },
         "en-us" : {
           "stringUnit" : {
             "state" : "translated",
-            "value" : "Welcome \\\"%@\\\" !"
+            "value" : "Welcome \"%@\" !"
           }
         },
         "fr" : {
           "stringUnit" : {
             "state" : "translated",
-            "value" : "Bienvenue \\\"%@\\\" !"
+            "value" : "Bienvenue \"%@\" !"
           }
         }
       }

SampleFiles/Strings/sampleStrings.txt

@@ -14,11 +14,11 @@
         fr = Retour
         en-us = Back
     [generic_loading_data]
-        en = Loading data...
+        en = Loading\ndata...
         tags = droid,ios
         comments =
-        fr = Chargement des données...
-        en-us = Loading data...
+        fr = Chargement\ndes données...
+        en-us = Loading\ndata...
     [generic_welcome_firstname_format]
         en = Welcome "%@" !
         tags = droid,ios

SampleFiles/Tags/Generated/Analytics+GenAllScript.swift

@@ -133,7 +133,7 @@ class FirebaseAnalyticsManager: AnalyticsManagerProtocol {
         category: String,
         params: [String: Any]?
     ) {
-        var parameters: [String:NSObject] = [
+        var parameters: [String: NSObject] = [
             AnalyticsParameterItemName: name.replacingOccurrences(of: " ", with: "_") as NSObject
         ]
 

SampleFiles/genAllRessources.sh

@@ -3,34 +3,34 @@
 FORCE_FLAG="$1"
 
 ## Font
-swift run -c release ResgenSwift fonts $FORCE_FLAG "./Fonts/sampleFontsAll.txt" \
- --extension-output-path "./Fonts/Generated" \
- --extension-name "FontYolo" \
- --extension-name-ui-kit "UIFontYolo" \
- --extension-suffix "GenAllScript" \
- --info-plist-paths "./Fonts/Generated/test.plist ./Fonts/Generated/test2.plist"
-
-echo "\n-------------------------\n"
-
-## Color
-swift run -c release ResgenSwift colors $FORCE_FLAG "./Colors/sampleColors1.txt" \
- --style all \
- --xcassets-path "./Colors/colors.xcassets" \
- --extension-output-path "./Colors/Generated/" \
- --extension-name "ColorYolo" \
- --extension-name-ui-kit "UIhkjhkColorYolo" \
- --extension-suffix "GenAllScript"
-
-echo "\n-------------------------\n"
-
-## Twine
-swift run -c release ResgenSwift strings twine $FORCE_FLAG "./Twine/sampleStrings.txt" \
- --output-path "./Twine/Generated" \
- --langs "fr en en-us" \
- --default-lang "en" \
- --extension-output-path "./Twine/Generated"
-
-echo "\n-------------------------\n"
+#swift run -c release ResgenSwift fonts $FORCE_FLAG "./Fonts/sampleFontsAll.txt" \
+# --extension-output-path "./Fonts/Generated" \
+# --extension-name "FontYolo" \
+# --extension-name-ui-kit "UIFontYolo" \
+# --extension-suffix "GenAllScript" \
+# --info-plist-paths "./Fonts/Generated/test.plist ./Fonts/Generated/test2.plist"
+#
+#echo "\n-------------------------\n"
+#
+### Color
+#swift run -c release ResgenSwift colors $FORCE_FLAG "./Colors/sampleColors1.txt" \
+# --style all \
+# --xcassets-path "./Colors/colors.xcassets" \
+# --extension-output-path "./Colors/Generated/" \
+# --extension-name "ColorYolo" \
+# --extension-name-ui-kit "UIhkjhkColorYolo" \
+# --extension-suffix "GenAllScript"
+#
+#echo "\n-------------------------\n"
+#
+### Twine
+#swift run -c release ResgenSwift strings twine $FORCE_FLAG "./Twine/sampleStrings.txt" \
+# --output-path "./Twine/Generated" \
+# --langs "fr en en-us" \
+# --default-lang "en" \
+# --extension-output-path "./Twine/Generated"
+#
+#echo "\n-------------------------\n"
 
 ## Strings
 swift run -c release ResgenSwift strings stringium $FORCE_FLAG "./Strings/sampleStrings.txt" \
@@ -41,31 +41,31 @@ swift run -c release ResgenSwift strings stringium $FORCE_FLAG "./Strings/sample
  --extension-name "String" \
  --extension-suffix "GenAllScript"
 
-echo "\n-------------------------\n"
-
-## Tags
-swift run -c release ResgenSwift strings tags $FORCE_FLAG "./Tags/sampleTags.txt" \
- --lang "ium" \
- --extension-output-path "./Tags/Generated" \
- --extension-name "Tags" \
- --extension-suffix "GenAllScript"
-
-echo "\n-------------------------\n"
-
-# Analytics
-swift run -c release ResgenSwift analytics $FORCE_FLAG "./Tags/sampleTags.yml" \
- --target "firebase" \
- --extension-output-path "./Tags/Generated" \
- --extension-name "Analytics" \
- --extension-suffix "GenAllScript" \
- --static-members true
-
-echo "\n-------------------------\n"
-
-## Images
-swift run -c release ResgenSwift images $FORCE_FLAG "./Images/sampleImages.txt" \
- --xcassets-path "./Images/imagium.xcassets" \
- --extension-output-path "./Images/Generated" \
- --extension-name "ImageYolo" \
- --extension-name-ui-kit "UIImageYolo" \
- --extension-suffix "GenAllScript"
+#echo "\n-------------------------\n"
+#
+### Tags
+#swift run -c release ResgenSwift strings tags $FORCE_FLAG "./Tags/sampleTags.txt" \
+# --lang "ium" \
+# --extension-output-path "./Tags/Generated" \
+# --extension-name "Tags" \
+# --extension-suffix "GenAllScript"
+#
+#echo "\n-------------------------\n"
+#
+## Analytics
+#swift run -c release ResgenSwift analytics $FORCE_FLAG "./Tags/sampleTags.yml" \
+# --target "firebase" \
+# --extension-output-path "./Tags/Generated" \
+# --extension-name "Analytics" \
+# --extension-suffix "GenAllScript" \
+# --static-members true
+#
+#echo "\n-------------------------\n"
+#
+### Images
+#swift run -c release ResgenSwift images $FORCE_FLAG "./Images/sampleImages.txt" \
+# --xcassets-path "./Images/imagium.xcassets" \
+# --extension-output-path "./Images/Generated" \
+# --extension-name "ImageYolo" \
+# --extension-name-ui-kit "UIImageYolo" \
+# --extension-suffix "GenAllScript"

Sources/ResgenSwift/Analytics/Analytics.swift

@@ -13,7 +13,7 @@ struct Analytics: ParsableCommand {
 
     // MARK: - Command Configuration
 
-    static var configuration = CommandConfiguration(
+    static let configuration = CommandConfiguration(
         abstract: "Generate analytics extension file.",
         version: ResgenSwiftVersion
     )

Sources/ResgenSwift/Analytics/Generator/FirebaseGenerator.swift

@@ -79,7 +79,7 @@ enum FirebaseGenerator {
                 category: String,
                 params: [String: Any]?
             ) {
-                var parameters: [String:NSObject] = [
+                var parameters: [String: NSObject] = [
                     AnalyticsParameterItemName: name.replacingOccurrences(of: " ", with: "_") as NSObject
                 ]
 

Sources/ResgenSwift/Fonts/Fonts.swift

@@ -13,7 +13,7 @@ struct Fonts: ParsableCommand {
 
     // MARK: - CommandConfiguration
 
-    static var configuration = CommandConfiguration(
+    static let configuration = CommandConfiguration(
         abstract: "A utility to generate an helpful etension to access your custom font from code and also Info.plist UIAppsFont content.",
         version: ResgenSwiftVersion
     )

Sources/ResgenSwift/Generate/Generate.swift

@@ -13,7 +13,7 @@ struct Generate: ParsableCommand {
 
     // MARK: - CommandConfiguration
 
-    static var configuration = CommandConfiguration(
+    static let configuration = CommandConfiguration(
         abstract: "A utility to generate ressources based on a configuration file",
         version: ResgenSwiftVersion
     )

Sources/ResgenSwift/Generate/Runnable/StringsConfiguration+Runnable.swift

@@ -38,8 +38,8 @@ extension StringsConfiguration: Runnable {
             ("--extension-suffix", extensionSuffix),
             ("--visibility", visibility),
             ("--asset-bundle", assetBundle),
-            ("--xc-strings", staticMembers?.description),
-            ("--static-members", xcStrings?.description)
+            ("--xc-strings", xcStrings?.description),
+            ("--static-members", staticMembers?.description)
         ].forEach { argumentName, argumentValue in
             if let argumentValue {
                 args += [

Sources/ResgenSwift/Images/Generator/XcassetsGenerator.swift

@@ -186,8 +186,6 @@ class XcassetsGenerator {
                 atomically: false,
                 encoding: .utf8
             )
-
-            print("\(parsedImage.name) -> Generated")
         }
 
         // Success info

Sources/ResgenSwift/Images/Images.swift

@@ -13,7 +13,7 @@ struct Images: ParsableCommand {
 
     // MARK: - CommandConfiguration
 
-    static var configuration = CommandConfiguration(
+    static let configuration = CommandConfiguration(
         abstract: "A utility for generate images and an extension to access them easily.",
         version: ResgenSwiftVersion
     )

Sources/ResgenSwift/Strings/Generator/StringsFileGenerator.swift

@@ -133,15 +133,17 @@ enum StringsFileGenerator {
         tags inputTags: [String],
         sections: [Section]
     ) -> String {
-        let rootObject = generateRootObject(
-            langs: langs,
-            defaultLang: defaultLang,
-            tags: inputTags,
-            sections: sections
+        generateXcStringsFileContentFromRootObject(
+            rootObject: generateRootObject(
+                langs: langs,
+                defaultLang: defaultLang,
+                tags: inputTags,
+                sections: sections
+            )
         )
-        let file = generateXcStringsFileContentFromRootObject(rootObject: rootObject)
-
-        return file
+        // Remove unwanted \ generated when transforming object to json
+        .replacingOccurrences(of: "\\\\", with: "\\")
+        .replacingOccurrences(of: "\\\"", with: "\"")
     }
 
     static func generateXcStringsFileContentFromRootObject(rootObject: Root) -> String {
@@ -173,22 +175,23 @@ enum StringsFileGenerator {
             guard section.hasOneOrMoreMatchingTags(tags: inputTags) else {
                 return // Go to next section
             }
+            print("DOUDOU")
+            section
+                .definitions
+                .forEach { definition in // swiftlint:disable:this closure_body_length
+                    var skipDefinition = false
+                    var isNoTranslation = false
 
-            section.definitions.forEach { definition in // swiftlint:disable:this closure_body_length
-                var skipDefinition = false
-                var isNoTranslation = false
+                    var localizationTab: [XCStringLocalization] = []
 
-                var localizationTab: [XCStringLocalization] = []
+                    guard definition.hasOneOrMoreMatchingTags(inputTags: inputTags) else {
+                        return
+                    }
 
-                if definition.hasOneOrMoreMatchingTags(inputTags: inputTags) == false {
-                    skipDefinition = true
-                }
+                    if definition.tags.contains(Stringium.noTranslationTag) {
+                        isNoTranslation = true
+                    }
 
-                if definition.tags.contains(Stringium.noTranslationTag) {
-                    isNoTranslation = true
-                }
-
-                if !skipDefinition {
                     if isNoTranslation {
                         // Search for langs in yaml
                         for lang in langs {
@@ -196,7 +199,10 @@ enum StringsFileGenerator {
                                 let localization = XCStringLocalization(
                                     lang: lang,
                                     content: XCStringLocalizationLangContent(
-                                        stringUnit: DefaultStringUnit(state: "translated", value: value)
+                                        stringUnit: DefaultStringUnit(
+                                            state: "translated",
+                                            value: value
+                                        )
                                     )
                                 )
                                 localizationTab.append(localization)
@@ -204,14 +210,18 @@ enum StringsFileGenerator {
                         }
                     } else {
                         // Search for langs in twine
-                        for (lang, value) in definition.translations where !value.isEmpty {
+                        for (lang, value) in definition.translations
+                        where langs.contains(lang) && !value.isEmpty {
+                            print("DOUDOU-> generate for \(lang)")
                             let localization = XCStringLocalization(
                                 lang: lang,
                                 content: XCStringLocalizationLangContent(
-                                    stringUnit: DefaultStringUnit(state: "translated", value: value)
+                                    stringUnit: DefaultStringUnit(
+                                        state: "translated",
+                                        value: value
+                                    )
                                 )
                             )
-
                             localizationTab.append(localization)
                         }
                     }
@@ -229,7 +239,6 @@ enum StringsFileGenerator {
 
                     xcStringDefinitionTab.append(xcStringDefinition)
                 }
-            }
         }
 
         let xcStringContainer = XCStringDefinitionContainer(strings: xcStringDefinitionTab)

Sources/ResgenSwift/Strings/Stringium/Stringium.swift

@@ -13,7 +13,7 @@ struct Stringium: ParsableCommand {
 
     // MARK: - Command Configuration
 
-    static var configuration = CommandConfiguration(
+    static let configuration = CommandConfiguration(
         abstract: "Generate strings with custom scripts.",
         version: ResgenSwiftVersion
     )

Sources/ResgenSwift/Strings/Strings.swift

@@ -11,7 +11,7 @@ import ToolCore
 
 struct Strings: ParsableCommand {
 
-    static var configuration = CommandConfiguration(
+    static let configuration = CommandConfiguration(
         abstract: "A utility for generate strings.",
         version: ResgenSwiftVersion,
 

Sources/ResgenSwift/Strings/Tag/Tags.swift

@@ -13,7 +13,7 @@ struct Tags: ParsableCommand {
 
     // MARK: - Command Configuration
 
-    static var configuration = CommandConfiguration(
+    static let configuration = CommandConfiguration(
         abstract: "Generate tags extension file.",
         version: ResgenSwiftVersion
     )

Sources/ResgenSwift/Strings/Twine/Twine.swift

@@ -13,7 +13,7 @@ struct Twine: ParsableCommand {
 
     // MARK: - Command Configuration
 
-    static var configuration = CommandConfiguration(
+    static let configuration = CommandConfiguration(
         abstract: "Generate strings with twine.",
         version: ResgenSwiftVersion
     )

Sources/ResgenSwift/main.swift

@@ -11,7 +11,7 @@ import ToolCore
 
 struct ResgenSwift: ParsableCommand {
 
-    static var configuration = CommandConfiguration(
+    static let configuration = CommandConfiguration(
         abstract: "A utility for generate ressources.",
         version: ResgenSwiftVersion,
 

Tests/ResgenSwiftTests/Analytics/AnalyticsGeneratorTests.swift

@@ -101,7 +101,7 @@ final class AnalyticsGeneratorTests: XCTestCase {
                 category: String,
                 params: [String: Any]?
             ) {
-                var parameters: [String:NSObject] = [
+                var parameters: [String: NSObject] = [
                     AnalyticsParameterItemName: name.replacingOccurrences(of: " ", with: "_") as NSObject
                 ]