feat(RES-33): Generation de l'architecture compatible Swift 6 (#13)

Reviewed-on: #13

Jenkinsfile

@@ -1,6 +1,6 @@
 library "openiumpipeline"
 
-env.DEVELOPER_DIR="/Applications/Xcode-15.0.1.app/Contents/Developer"
+env.DEVELOPER_DIR="/Applications/Xcode-15.4.0.app/Contents/Developer"
 //env.SIMULATOR_DEVICE_TYPES="iPad--7th-generation-"
 env.IS_PACKAGE_SWIFT=1
 env.TARGETS_MACOS=1

Package.resolved

@@ -14,8 +14,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/krzyzanowskim/CryptoSwift.git",
       "state" : {
-        "revision" : "db51c407d3be4a051484a141bf0bff36c43d3b1e",
+        "revision" : "c9c3df6ab812de32bae61fc0cd1bf6d45170ebf0",
-        "version" : "1.8.0"
+        "version" : "1.8.2"
       }
     },
     {

README.md

@@ -81,7 +81,7 @@ swift run -c release ResgenSwift strings twine $FORCE_FLAG "./Twine/strings.txt"
 2. Input translations file (must be Twine formatted)
 3. `--langs`: langs to generate (string with space between each lang)
 4. `--default-lang`: default lang that will be in `Base.lproj`. It must be in `langs` as well
-4. `--extension-output-path`: path where to generate generated extension
+5. `--extension-output-path`: path where to generate generated extension
 
 ### Stringium (recommended)
 
@@ -93,6 +93,7 @@ swift run -c release ResgenSwift strings stringium $FORCE_FLAG "./Strings/string
  --extension-output-path "./Strings/Generated" \
  --extension-name "AppString" \
  --extension-suffix "GreatApp" \
+ --xcStrings true
  --static-members true
 ```
 
@@ -105,6 +106,7 @@ swift run -c release ResgenSwift strings stringium $FORCE_FLAG "./Strings/string
 4. `--extension-output-path`: path where to generate generated extension
 5. `--extension-name` *(optional)* : name of class to add the extension
 6. `--extension-suffix` *(optional)* : additional text which is added to filename (ex: `AppString+GreatApp.swift`)
+6. `--xcStrings`*(optional)* : generate string catalog
 7. `--static-members` *(optional)*: generate static properties or not
 
 
@@ -223,6 +225,7 @@ swift run -c release ResgenSwift images $FORCE_FLAG "./Images/images.txt" \
 6. `--extension-suffix` *(optional)* : additional text which is added to filename (ex: `AppImage+GreatApp.swift`)
 7. `--static-members` *(optional)*: generate static properties or not
 
+> ⚠️ Svg images will be copied in the assets and rendered as "Original", however if those images are not rendered correctly you can force the png generation by adding the key word "png" like this: id arrow_back 15 ? png
 
 ## All at once
 

Sources/ResgenSwift/Generate/GenerateError.swift

@@ -9,7 +9,7 @@ import Foundation
 
 enum GenerateError: Error {
     case fileNotExists(String)
-    case invalidConfigurationFile(String)
+    case invalidConfigurationFile(String, String)
     case commandError([String], String)
     case writeFile(String, String)
     
@@ -18,8 +18,8 @@ enum GenerateError: Error {
         case .fileNotExists(let filename):
             return "error: [\(Generate.toolName)] File \(filename) does not exists"
     
-        case .invalidConfigurationFile(let filename):
+        case .invalidConfigurationFile(let filename, let underneathErrorDescription):
-            return "error: [\(Generate.toolName)] File \(filename) is not a valid configuration file"
+            return "error: [\(Generate.toolName)] File \(filename) is not a valid configuration file. Underneath error: \(underneathErrorDescription)"
             
         case .commandError(let command, let terminationStatus):
             let readableCommand = command

Sources/ResgenSwift/Generate/Model/ConfigurationFile.swift

@@ -55,7 +55,7 @@ struct ConfigurationArchitecture: Codable {
     
     func getClass(generateStaticProperty: Bool = true) -> String {
         guard children?.isEmpty == false else {
-            return "class \(classname) {}"
+            return "final class \(classname): Sendable {}"
         }
         
         let classDefinition = [
@@ -269,6 +269,7 @@ struct StringsConfiguration: Codable, CustomDebugStringConvertible {
     let extensionName: String?
     let extensionSuffix: String?
     private let staticMembers: Bool?
+    private let xcStrings: Bool?
 
     var staticMembersOptions: Bool {
         if let staticMembers = staticMembers {
@@ -277,6 +278,13 @@ struct StringsConfiguration: Codable, CustomDebugStringConvertible {
         return false
     }
 
+    var xcStringsOptions: Bool {
+        if let xcStrings = xcStrings {
+            return xcStrings
+        }
+        return false
+    }
+
     internal init(inputFile: String,
                   outputPath: String,
                   langs: String,
@@ -284,7 +292,8 @@ struct StringsConfiguration: Codable, CustomDebugStringConvertible {
                   extensionOutputPath: String,
                   extensionName: String?,
                   extensionSuffix: String?,
-                  staticMembers: Bool?) {
+                  staticMembers: Bool?,
+                  xcStrings: Bool?) {
         self.inputFile = inputFile
         self.outputPath = outputPath
         self.langs = langs
@@ -293,6 +302,7 @@ struct StringsConfiguration: Codable, CustomDebugStringConvertible {
         self.extensionName = extensionName
         self.extensionSuffix = extensionSuffix
         self.staticMembers = staticMembers
+        self.xcStrings = xcStrings
     }
     
     var debugDescription: String {

Sources/ResgenSwift/Generate/Parser/ConfigurationFileParser.swift

@@ -16,12 +16,15 @@ class ConfigurationFileParser {
             Generate.exit(withError: error)
         }
         
-        guard let configuration = try? YAMLDecoder().decode(ConfigurationFile.self, from: data) else {
+        do {
-            let error = GenerateError.invalidConfigurationFile(configurationFile)
+            return try YAMLDecoder().decode(ConfigurationFile.self, from: data)
+        } catch {
+            let error = GenerateError.invalidConfigurationFile(
+                configurationFile,
+                error.localizedDescription.description
+            )
             print(error.description)
             Generate.exit(withError: error)
         }
-        
-        return configuration
     }
 }

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

@@ -26,7 +26,9 @@ extension StringsConfiguration: Runnable {
             "--extension-output-path",
             extensionOutputPath.prependIfRelativePath(projectDirectory),
             "--static-members",
-            "\(staticMembersOptions)"
+            "\(staticMembersOptions)",
+            "--xc-strings",
+            "\(xcStringsOptions)"
         ]
         
         if let extensionName = extensionName {

Sources/ResgenSwift/Images/Generator/XcassetsGenerator.swift

@@ -8,9 +8,12 @@
 import Foundation
 import ToolCore
 
-class XcassetsGenerator {
+enum OutputImageExtension: String {
+    case png
+    case svg
+}
 
-    static let outputImageExtension = "png"
+class XcassetsGenerator {
 
     let forceGeneration: Bool
     
@@ -60,13 +63,20 @@ class XcassetsGenerator {
             generatedAssetsPaths.append(imagesetName)
             
             // Generate output images path
-            let output1x = "\(imagesetPath)/\(parsedImage.name).\(XcassetsGenerator.outputImageExtension)"
+            let output1x = "\(imagesetPath)/\(parsedImage.name).\(OutputImageExtension.png.rawValue)"
-            let output2x = "\(imagesetPath)/\(parsedImage.name)@2x.\(XcassetsGenerator.outputImageExtension)"
+            let output2x = "\(imagesetPath)/\(parsedImage.name)@2x.\(OutputImageExtension.png.rawValue)"
-            let output3x = "\(imagesetPath)/\(parsedImage.name)@3x.\(XcassetsGenerator.outputImageExtension)"
+            let output3x = "\(imagesetPath)/\(parsedImage.name)@3x.\(OutputImageExtension.png.rawValue)"
 
             // Check if we need to convert image
-            guard self.shouldGenerate(inputImagePath: imageData.path, xcassetImagePath: output1x) else {
+
-                //print("\(parsedImage.name) -> Not regenerating")
+            var needToGenerateForSvg = false
+
+            if imageData.ext == "svg" && !parsedImage.imageExtensions.contains(.png) {
+                needToGenerateForSvg = true
+            }
+
+            guard self.shouldGenerate(inputImagePath: imageData.path, xcassetImagePath: output1x, needToGenerateForSvg: needToGenerateForSvg) else {
+                print("\(parsedImage.name) -> Not regenerating")
                 return
             }
             
@@ -80,29 +90,55 @@ class XcassetsGenerator {
                     print(error.description)
                     Images.exit(withError: error)
                 }
+            } else {
+                do {
+                    let documentsDirectory = try fileManager.contentsOfDirectory(atPath: imagesetPath)
+                    for filePath in documentsDirectory {
+                        try fileManager.removeItem(atPath: "\(imagesetPath)/\(filePath)")
+                    }
+                } catch {
+                    print("Error deleting previous assets")
+                }
             }
 
-            // Convert image
             let convertArguments = parsedImage.convertArguments
+
             if imageData.ext == "svg" {
-                // /usr/local/bin/rsvg-convert path/to/image.png -w 200 -h 300 -o path/to/output.png
+                if parsedImage.imageExtensions.contains(.png) {
-                // /usr/local/bin/rsvg-convert path/to/image.png -w 200 -o path/to/output.png
-                // /usr/local/bin/rsvg-convert path/to/image.png -h 300 -o path/to/output.png
-                var command1x = ["\(svgConverter)", "\(imageData.path)"]
-                var command2x = ["\(svgConverter)", "\(imageData.path)"]
-                var command3x = ["\(svgConverter)", "\(imageData.path)"]
 
-                self.addConvertArgument(command: &command1x, convertArgument: convertArguments.x1)
+                    // /usr/local/bin/rsvg-convert path/to/image.png -w 200 -h 300 -o path/to/output.png
-                self.addConvertArgument(command: &command2x, convertArgument: convertArguments.x2)
+                    // /usr/local/bin/rsvg-convert path/to/image.png -w 200 -o path/to/output.png
-                self.addConvertArgument(command: &command3x, convertArgument: convertArguments.x3)
+                    // /usr/local/bin/rsvg-convert path/to/image.png -h 300 -o path/to/output.png
+                    var command1x = ["\(svgConverter)", "\(imageData.path)"]
+                    var command2x = ["\(svgConverter)", "\(imageData.path)"]
+                    var command3x = ["\(svgConverter)", "\(imageData.path)"]
 
-                command1x.append(contentsOf: ["-o", output1x])
+                    self.addConvertArgument(command: &command1x, convertArgument: convertArguments.x1)
-                command2x.append(contentsOf: ["-o", output2x])
+                    self.addConvertArgument(command: &command2x, convertArgument: convertArguments.x2)
-                command3x.append(contentsOf: ["-o", output3x])
+                    self.addConvertArgument(command: &command3x, convertArgument: convertArguments.x3)
 
-                Shell.shell(command1x)
+                    command1x.append(contentsOf: ["-o", output1x])
-                Shell.shell(command2x)
+                    command2x.append(contentsOf: ["-o", output2x])
-                Shell.shell(command3x)
+                    command3x.append(contentsOf: ["-o", output3x])
+
+                    Shell.shell(command1x)
+                    Shell.shell(command2x)
+                    Shell.shell(command3x)
+
+                } else {
+
+                    let output = "\(imagesetPath)/\(parsedImage.name).\(OutputImageExtension.svg.rawValue)"
+                    let tempURL = URL(fileURLWithPath: output)
+
+                    do {
+                        if FileManager.default.fileExists(atPath: tempURL.path) {
+                            try FileManager.default.removeItem(atPath: tempURL.path)
+                        }
+                        try FileManager.default.copyItem(atPath: imageData.path, toPath: tempURL.path)
+                    } catch {
+                        print(error.localizedDescription)
+                    }
+                }
             } else {
                 // convert path/to/image.png -resize 200x300 path/to/output.png
                 // convert path/to/image.png -resize 200x path/to/output.png
@@ -119,7 +155,7 @@ class XcassetsGenerator {
             }
             
             // Write Content.json
-            let imagesetContentJson = parsedImage.contentJson
+            guard let imagesetContentJson = parsedImage.generateContentJson(isVector: imageData.ext == "svg") else { return }
             let contentJsonFilePath = "\(imagesetPath)/Contents.json"
             
             let contentJsonFilePathURL = URL(fileURLWithPath: contentJsonFilePath)
@@ -161,8 +197,8 @@ class XcassetsGenerator {
     
     // MARK: - Helpers: bypass generation
     
-    private func shouldGenerate(inputImagePath: String, xcassetImagePath: String) -> Bool {
+    private func shouldGenerate(inputImagePath: String, xcassetImagePath: String, needToGenerateForSvg: Bool) -> Bool {
-        if forceGeneration {
+        if forceGeneration || needToGenerateForSvg {
             return true
         }
         

Sources/ResgenSwift/Images/ImagesError.swift

@@ -36,7 +36,7 @@ enum ImagesError: Error {
             return "error: [\(Images.toolName)] Getting file attributes of \(filename) failed with error: \(errorDescription)"
             
         case .rsvgConvertNotFound:
-            return "error: [\(Images.toolName)] Can't find rsvg-convert (can be installed with 'brew remove imagemagick && brew install imagemagick --with-librsvg')"
+            return "error: [\(Images.toolName)] Can't find rsvg-convert (can be installed with 'brew remove imagemagick && brew install librsvg')"
             
         case .writeFile(let subErrorDescription, let filename):
             return "error: [\(Images.toolName)] An error occured while writing content to \(filename): \(subErrorDescription)"

Sources/ResgenSwift/Images/Model/ImageContent.swift

@@ -0,0 +1,76 @@
+//
+//  ImageContent.swift
+//
+//
+//  Created by Quentin Bandera on 19/04/2024.
+//
+
+import Foundation
+
+enum TemplateRenderingIntent: String, Codable {
+    case template
+    case original
+}
+
+struct AssetContent: Codable, Equatable {
+    let images: [AssetImageDescription]
+    let info: AssetInfo
+    let properties: AssetProperties?
+
+    init(
+        images: [AssetImageDescription],
+        info: AssetInfo,
+        properties: AssetProperties? = nil
+    ) {
+        self.images = images
+        self.info = info
+        self.properties = properties
+    }
+
+    static func == (lhs: AssetContent, rhs: AssetContent) -> Bool {
+        guard lhs.images.count == rhs.images.count else { return false }
+        let lhsImages = lhs.images.sorted(by: { $0.filename < $1.filename })
+        let rhsImages = rhs.images.sorted(by: { $0.filename < $1.filename })
+
+        return lhsImages == rhsImages
+    }
+}
+
+struct AssetImageDescription: Codable, Equatable {
+    let idiom: String
+    let scale: String?
+    let filename: String
+
+    init(
+        idiom: String,
+        scale: String? = nil,
+        filename: String
+    ) {
+        self.idiom = idiom
+        self.scale = scale
+        self.filename = filename
+    }
+}
+
+struct AssetInfo: Codable, Equatable {
+    let version: Int
+    let author: String
+}
+
+struct AssetProperties: Codable, Equatable {
+    let preservesVectorRepresentation: Bool
+    let templateRenderingIntent: TemplateRenderingIntent?
+
+    init(
+        preservesVectorRepresentation: Bool,
+        templateRenderingIntent: TemplateRenderingIntent? = nil
+    ) {
+        self.preservesVectorRepresentation = preservesVectorRepresentation
+        self.templateRenderingIntent = templateRenderingIntent
+    }
+
+    enum CodingKeys: String, CodingKey {
+        case preservesVectorRepresentation = "preserves-vector-representation"
+        case templateRenderingIntent = "template-rendering-intent"
+    }
+}

Sources/ResgenSwift/Images/Model/ParsedImage.swift

@@ -7,11 +7,30 @@
 
 import Foundation
 
+enum ImageExtension: String {
+    case png
+}
+
 struct ParsedImage {
     let name: String
     let tags: String
     let width: Int
     let height: Int
+    let imageExtensions: [ImageExtension]
+
+    init(
+        name: String,
+        tags: String,
+        width: Int,
+        height: Int,
+        imageExtensions: [ImageExtension] = []
+    ) {
+        self.name = name
+        self.tags = tags
+        self.width = width
+        self.height = height
+        self.imageExtensions = imageExtensions
+    }
 
     // MARK: - Convert
     
@@ -42,32 +61,67 @@ struct ParsedImage {
     
     // MARK: - Assets
     
-    var contentJson: String {
+    func generateContentJson(isVector: Bool) -> String? {
-        """
+        let encoder = JSONEncoder()
-        {
+        encoder.outputFormatting = .prettyPrinted
-          "images" : [
+
-            {
+        let imageContent = generateImageContent(isVector: isVector)
-              "idiom" : "universal",
+
-              "scale" : "1x",
+        guard let data = try? encoder.encode(imageContent) else {
-              "filename" : "\(name).\(XcassetsGenerator.outputImageExtension)"
+            let error = ImagesError.writeFile("Contents.json", "Error encoding json file")
-            },
+            print(error.description)
-            {
+            Images.exit(withError: error)
-              "idiom" : "universal",
+        }
-              "scale" : "2x",
+
-              "filename" : "\(name)@2x.\(XcassetsGenerator.outputImageExtension)"
+        return String(decoding: data, as: UTF8.self)
-            },
+    }
-            {
+
-              "idiom" : "universal",
+    func generateImageContent(isVector: Bool) -> AssetContent {
-              "scale" : "3x",
+
-              "filename" : "\(name)@3x.\(XcassetsGenerator.outputImageExtension)"
+        if !imageExtensions.contains(.png) && isVector {
-            }
+            //Generate svg
-          ],
+            return AssetContent(
-          "info" : {
+                images: [
-            "version" : 1,
+                    AssetImageDescription(
-            "author" : "ResgenSwift-Imagium"
+                        idiom: "universal",
-          }
+                        filename: "\(name).\(OutputImageExtension.svg.rawValue)"
+                    )
+                ],
+                info: AssetInfo(
+                    version: 1,
+                    author: "ResgenSwift-Imagium"
+                ),
+                properties: AssetProperties(
+                    preservesVectorRepresentation: true,
+                    templateRenderingIntent: .original
+                )
+            )
+        } else {
+            //Generate png
+            return AssetContent(
+                images: [
+                    AssetImageDescription(
+                        idiom: "universal",
+                        scale: "1x",
+                        filename: "\(name).\(OutputImageExtension.png.rawValue)"
+                    ),
+                    AssetImageDescription(
+                        idiom: "universal",
+                        scale: "2x",
+                        filename: "\(name)@2x.\(OutputImageExtension.png.rawValue)"
+                    ),
+                    AssetImageDescription(
+                        idiom: "universal",
+                        scale: "3x",
+                        filename: "\(name)@3x.\(OutputImageExtension.png.rawValue)"
+                    )
+                ],
+                info: AssetInfo(
+                    version: 1,
+                    author: "ResgenSwift-Imagium"
+                )
+            )
         }
-        """
     }
 
     // MARK: - Extension property

Sources/ResgenSwift/Images/Parser/ImageFileParser.swift

@@ -39,10 +39,20 @@ class ImageFileParser {
                 return Int(splittedLine[3])!
             }()
 
-            let image = ParsedImage(name: String(splittedLine[1]), tags: String(splittedLine[0]), width: width, height: height)
+            var imageExtensions: [ImageExtension] = []
+
+            splittedLine.forEach { stringExtension in
+                if let imageExtension = ImageExtension(rawValue: String(stringExtension)) {
+                    imageExtensions.append(imageExtension)
+                }
+            }
+
+            let image = ParsedImage(name: String(splittedLine[1]), tags: String(splittedLine[0]), width: width, height: height, imageExtensions: imageExtensions)
             imagesToGenerate.append(image)
         }
 
+        print(imagesToGenerate)
+
         return imagesToGenerate.filter {
             $0.tags.contains(platform.rawValue)
         }

Sources/ResgenSwift/Strings/Generator/StringsFileGenerator.swift

@@ -18,6 +18,7 @@ class StringsFileGenerator {
                                   tags: [String],
                                   outputPath: String,
                                   inputFilenameWithoutExt: String) {
+
         var stringsFilesContent = [String: String]()
         for lang in langs {
             stringsFilesContent[lang] = Self.generateStringsFileContent(lang: lang,
@@ -42,6 +43,31 @@ class StringsFileGenerator {
         }
     }
 
+    static func writeXcStringsFiles(sections: [Section],
+                                    langs: [String],
+                                    defaultLang: String,
+                                    tags: [String],
+                                    outputPath: String,
+                                    inputFilenameWithoutExt: String) {
+
+        let fileContent: String = Self.generateXcStringsFileContent(
+            langs: langs,
+            defaultLang: defaultLang,
+            tags: tags,
+            sections: sections
+        )
+
+        let stringsFilePath = "\(outputPath)/\(inputFilenameWithoutExt).xcstrings"
+        let stringsFilePathURL = URL(fileURLWithPath: stringsFilePath)
+        do {
+            try fileContent.write(to: stringsFilePathURL, atomically: false, encoding: .utf8)
+        } catch let error {
+            let error = StringiumError.writeFile(error.localizedDescription, stringsFilePath)
+            print(error.description)
+            Stringium.exit(withError: error)
+        }
+    }
+
     static func generateStringsFileContent(lang: String,
                                            defaultLang: String,
                                            tags inputTags: [String],
@@ -92,6 +118,115 @@ class StringsFileGenerator {
         return stringsFileContent
     }
 
+    // MARK: - XcStrings Generation
+
+    static func generateXcStringsFileContent(langs: [String],
+                                             defaultLang: String,
+                                             tags inputTags: [String],
+                                             sections: [Section]) -> String {
+        let rootObject = generateRootObject(langs: langs, defaultLang: defaultLang, tags: inputTags, sections: sections)
+        let file = generateXcStringsFileContentFromRootObject(rootObject: rootObject)
+
+        return file
+    }
+
+    static func generateXcStringsFileContentFromRootObject(rootObject: Root) -> String {
+        do {
+            let encoder = JSONEncoder()
+            encoder.outputFormatting = [.prettyPrinted]
+
+            let json = try encoder.encode(rootObject)
+
+            return String(decoding: json, as: UTF8.self)
+
+        } catch {
+            debugPrint("Failed to encode: \(error)")
+        }
+
+        return ""
+    }
+
+    static func generateRootObject(langs: [String],
+                                   defaultLang: String,
+                                   tags inputTags: [String],
+                                   sections: [Section]) -> Root {
+
+        var xcStringDefinitionTab: [XCStringDefinition] = []
+
+        sections.forEach { section in
+            // Check that at least one string will be generated
+            guard section.hasOneOrMoreMatchingTags(tags: inputTags) else {
+                return // Go to next section
+            }
+
+            section.definitions.forEach { definition in
+                var skipDefinition = false
+                var isNoTranslation = false
+
+                var localizationTab: [XCStringLocalization] = []
+
+                if definition.hasOneOrMoreMatchingTags(inputTags: inputTags) == false {
+                    skipDefinition = true
+                }
+
+                if definition.tags.contains(Stringium.noTranslationTag) {
+                    isNoTranslation = true
+                }
+
+                if !skipDefinition {
+                    if isNoTranslation {
+                        // Search for langs in yaml
+                        for lang in langs {
+                            if let value = definition.translations[defaultLang], !value.isEmpty {
+                                let localization = XCStringLocalization(
+                                    lang: lang,
+                                    content: XCStringLocalizationLangContent(
+                                        stringUnit: DefaultStringUnit(state: "translated", value: value)
+                                    )
+                                )
+                                localizationTab.append(localization)
+                            }
+                        }
+                    } else {
+                        // Search for langs in twine
+                        for (lang, value) in definition.translations where !value.isEmpty {
+
+                            let localization = XCStringLocalization(
+                                lang: lang,
+                                content: XCStringLocalizationLangContent(
+                                    stringUnit: DefaultStringUnit(state: "translated", value: value)
+                                )
+                            )
+
+                            localizationTab.append(localization)
+                        }
+                    }
+
+                    let xcStringDefinition = XCStringDefinition(
+                        title: definition.name,
+                        content: XCStringDefinitionContent(
+                            comment: definition.comment,
+                            extractionState: "manual",
+                            localizations: XCStringLocalizationContainer(
+                                localizations: localizationTab
+                            )
+                        )
+                    )
+
+                    xcStringDefinitionTab.append(xcStringDefinition)
+                }
+            }
+        }
+
+        let xcStringContainer = XCStringDefinitionContainer(strings: xcStringDefinitionTab)
+        
+        return Root(
+            sourceLanguage: defaultLang,
+            strings: xcStringContainer,
+            version: "1.0"
+        )
+    }
+
     // MARK: - Extension file
 
     static func writeExtensionFiles(sections: [Section],

Sources/ResgenSwift/Strings/Model/Definition.swift

@@ -84,22 +84,29 @@ class Definition {
         return (inputParameters: inputParameters, translationArguments: translationArguments)
     }
     
-    private func getBaseProperty(lang: String, translation: String, isStatic: Bool) -> String {
+    private func getBaseProperty(lang: String, translation: String, isStatic: Bool, comment: String?) -> String {
         """
             /// Translation in \(lang) :
             /// \(translation)
+            ///
+            /// Comment :
+            /// \(comment?.isEmpty == false ? comment! : "No comment")
             \(isStatic ? "static ": "")var \(name): String {
-                NSLocalizedString("\(name)", tableName: kStringsFileName, bundle: Bundle.main, value: "\(translation)", comment: "")
+                NSLocalizedString("\(name)", tableName: kStringsFileName, bundle: Bundle.main, value: "\(translation)", comment: "\(comment ?? "")")
             }
         """
+
     }
     
-    private func getBaseMethod(lang: String, translation: String, isStatic: Bool, inputParameters: [String], translationArguments: [String]) -> String {
+    private func getBaseMethod(lang: String, translation: String, isStatic: Bool, inputParameters: [String], translationArguments: [String], comment: String?) -> String {
-        """
 
+        """
 
             /// Translation in \(lang) :
             /// \(translation)
+            ///
+            /// Comment :
+            /// \(comment?.isEmpty == false ? comment! : "No comment")
             \(isStatic ? "static ": "")func \(name)(\(inputParameters.joined(separator: ", "))) -> String {
                 String(format: \(isStatic ? "Self" : "self").\(name), \(translationArguments.joined(separator: ", ")))
             }
@@ -114,7 +121,12 @@ class Definition {
         }
 
         // Generate property
-        let property = getBaseProperty(lang: lang, translation: translation, isStatic: false)
+        let property = getBaseProperty(
+            lang: lang,
+            translation: translation,
+            isStatic: false,
+            comment: self.comment
+        )
 
         // Generate method
         var method = ""
@@ -123,7 +135,8 @@ class Definition {
                                    translation: translation,
                                    isStatic: false,
                                    inputParameters: parameters.inputParameters,
-                                   translationArguments: parameters.translationArguments)
+                                   translationArguments: parameters.translationArguments,
+                                   comment: self.comment)
         }
         
         return property + method
@@ -137,7 +150,12 @@ class Definition {
         }
         
         // Generate property
-        let property = getBaseProperty(lang: lang, translation: translation, isStatic: true)
+        let property = getBaseProperty(
+            lang: lang,
+            translation: translation,
+            isStatic: true,
+            comment: self.comment
+        )
         
         // Generate method
         var method = ""
@@ -146,7 +164,8 @@ class Definition {
                                    translation: translation,
                                    isStatic: true,
                                    inputParameters: parameters.inputParameters,
-                                   translationArguments: parameters.translationArguments)
+                                   translationArguments: parameters.translationArguments,
+                                   comment: self.comment)
         }
         
         return property + method
@@ -164,6 +183,10 @@ class Definition {
         return """
             /// Translation in \(lang) :
             /// \(translation)
+            ///
+            /// Comment :
+            /// \(comment?.isEmpty == false ? comment! : "No comment")
+
             var \(name): String {
                 "\(translation)"
             }
@@ -180,6 +203,9 @@ class Definition {
         return """
             /// Translation in \(lang) :
             /// \(translation)
+            ///
+            /// Comment :
+            /// \(comment?.isEmpty == false ? comment! : "No comment")
             static var \(name): String {
                 "\(translation)"
             }

Sources/ResgenSwift/Strings/Model/XcString.swift

@@ -0,0 +1,109 @@
+//
+//  XcString.swift
+//
+//
+//  Created by Quentin Bandera on 12/04/2024.
+//
+
+import SwiftUI
+
+struct DynamicKey: CodingKey {
+    var intValue: Int?
+    init?(intValue: Int) {
+        self.intValue = intValue
+        self.stringValue = "\(intValue)"
+    }
+
+    var stringValue: String
+    init?(stringValue: String) {
+        self.stringValue = stringValue
+    }
+}
+
+struct Root: Codable, Equatable {
+    let sourceLanguage: String
+    let strings: XCStringDefinitionContainer
+    let version: String
+}
+
+struct XCStringDefinitionContainer: Codable, Equatable {
+    let strings: [XCStringDefinition]
+
+    func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: DynamicKey.self)
+
+        for str in strings {
+            if let codingKey = DynamicKey(stringValue: str.title) {
+                try container.encode(str.content, forKey: codingKey)
+            }
+        }
+    }
+
+    static func == (lhs: XCStringDefinitionContainer, rhs: XCStringDefinitionContainer) -> Bool {
+        return lhs.strings.sorted(by: {
+            $0.title < $1.title
+        }) == rhs.strings.sorted(by: { $0.title < $1.title })
+    }
+}
+
+struct XCStringDefinition: Codable, Equatable {
+    let title: String // json key -> custom encoding methods
+    let content: XCStringDefinitionContent
+}
+
+struct XCStringDefinitionContent: Codable, Equatable {
+    let comment: String?
+    let extractionState: String
+    var localizations: XCStringLocalizationContainer
+
+    init(comment: String? = nil, extractionState: String, localizations: XCStringLocalizationContainer) {
+        self.comment = comment
+        self.extractionState = extractionState
+        self.localizations = localizations
+    }
+}
+
+struct XCStringLocalizationContainer: Codable, Equatable {
+    let localizations: [XCStringLocalization]
+
+    func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: DynamicKey.self)
+
+        for loca in localizations {
+            if let codingKey = DynamicKey(stringValue: loca.lang) {
+                try container.encode(loca.content, forKey: codingKey)
+            }
+        }
+    }
+
+    static func == (lhs: XCStringLocalizationContainer, rhs: XCStringLocalizationContainer) -> Bool {
+        return lhs.localizations.count == rhs.localizations.count && lhs.localizations.sorted(by: { $0.lang < $1.lang }) == rhs.localizations.sorted(by: { $0.lang < $1.lang })
+    }
+}
+
+struct XCStringLocalization: Codable, Equatable {
+    let lang: String // json key -> custom encoding method
+    let content: XCStringLocalizationLangContent
+}
+
+struct XCStringLocalizationLangContent: Codable, Equatable {
+    let stringUnit: DefaultStringUnit
+}
+
+//enum VarationOrStringUnit: Encodable {
+//    case variations([Varation])
+//    case stringUnit: (DefaultStringUnit)
+//
+//    func encode(to encoder: any Encoder) throws {
+//        if let varations {
+//
+//        } else if let  {
+//
+//        }
+//    }
+//}
+
+struct DefaultStringUnit: Codable, Equatable {
+    let state: String
+    let value: String
+}

Sources/ResgenSwift/Strings/Stringium/Stringium.swift

@@ -43,12 +43,25 @@ struct Stringium: ParsableCommand {
         let sections = TwineFileParser.parse(options.inputFile)
         
         // Generate strings files
-        StringsFileGenerator.writeStringsFiles(sections: sections,
+        print(options.xcStrings)
-                                               langs: options.langs,
+        if !options.xcStrings {
-                                               defaultLang: options.defaultLang,
+            print("[\(Self.toolName)] Will generate strings")
-                                               tags: options.tags,
+
-                                               outputPath: options.stringsFileOutputPath,
+            StringsFileGenerator.writeStringsFiles(sections: sections,
-                                               inputFilenameWithoutExt: options.inputFilenameWithoutExt)
+                                                   langs: options.langs,
+                                                   defaultLang: options.defaultLang,
+                                                   tags: options.tags,
+                                                   outputPath: options.stringsFileOutputPath,
+                                                   inputFilenameWithoutExt: options.inputFilenameWithoutExt)
+        } else {
+            print("[\(Self.toolName)] Will generate xcStrings")
+            StringsFileGenerator.writeXcStringsFiles(sections: sections,
+                                                     langs: options.langs,
+                                                     defaultLang: options.defaultLang,
+                                                     tags: options.tags,
+                                                     outputPath: options.stringsFileOutputPath,
+                                                     inputFilenameWithoutExt: options.inputFilenameWithoutExt)
+        }
 
         // Generate extension
         StringsFileGenerator.writeExtensionFiles(sections: sections,

Sources/ResgenSwift/Strings/Stringium/StringiumOptions.swift

@@ -12,7 +12,7 @@ struct StringiumOptions: ParsableArguments {
     @Flag(name: [.customShort("f"), .customShort("F")], help: "Should force generation")
     var forceGeneration = false
 
-    @Argument(help: "Input files where strings ared defined.", transform: { $0.replaceTiltWithHomeDirectoryPath() })
+    @Argument(help: "Input files where strings are defined.", transform: { $0.replaceTiltWithHomeDirectoryPath() })
     var inputFile: String
     
     @Option(name: .customLong("output-path"), help: "Path where to strings file.", transform: { $0.replaceTiltWithHomeDirectoryPath() })
@@ -33,6 +33,9 @@ struct StringiumOptions: ParsableArguments {
     @Option(help: "Tell if it will generate static properties or not")
     var staticMembers: Bool = false
 
+    @Option(help: "Tell if it will generate xcStrings file or not")
+    var xcStrings: Bool = false
+
     @Option(help: "Extension name. If not specified, it will generate an String extension.")
     var extensionName: String = Stringium.defaultExtensionName
     

Tests/ResgenSwiftTests/Colors/ParsedColorTests.swift

@@ -91,7 +91,7 @@ final class ParsedColorTests: XCTestCase {
         // When
         let contentJson = color.contentsJSON()
         guard let data = contentJson.data(using: .utf8),
-        let parsedJson = try? JSONSerialization.jsonObject(with: data) as? [String: Any] else {
+              let parsedJson = try? JSONSerialization.jsonObject(with: data) as? [String: Any] else {
             XCTFail("Cannot convert `contentJSON` string to Data")
             return
         }

Tests/ResgenSwiftTests/Images/ImageFileParserTests.swift

@@ -17,8 +17,8 @@ class ImageFileParserTests: XCTestCase {
         #
         # SMAAS Support
         #
-        id image_one 25 ?
+        id image_one 25 ? png
-        di image_two ? 50
+        di image_two ? 50 webp png
         d image_three 25 ?
         d image_four 75 ?
         """
@@ -38,6 +38,7 @@ class ImageFileParserTests: XCTestCase {
         XCTAssertEqual(firstImage!.tags, "id")
         XCTAssertEqual(firstImage!.width, 25)
         XCTAssertEqual(firstImage!.height, -1)
+        XCTAssertEqual(firstImage!.imageExtensions, [.png])
 
         let secondImage = parsedImages.first {
             $0.name == "image_two"
@@ -46,5 +47,6 @@ class ImageFileParserTests: XCTestCase {
         XCTAssertEqual(secondImage!.tags, "di")
         XCTAssertEqual(secondImage!.width, -1)
         XCTAssertEqual(secondImage!.height, 50)     
+        XCTAssertEqual(firstImage!.imageExtensions, [.png])
     }
 }

Tests/ResgenSwiftTests/Images/ParsedImageTests.swift

@@ -127,35 +127,77 @@ final class ParsedImageTests: XCTestCase {
                                       height: 10)
         
         // When
-        let property = parsedImage.contentJson
+        let property = parsedImage.generateImageContent(isVector: false)
 
         // Expect
-        let expect = """
+        let expect = AssetContent(
-        {
+            images: [
-          "images" : [
+                AssetImageDescription(
-            {
+                    idiom: "universal",
-              "idiom" : "universal",
+                    scale: "1x",
-              "scale" : "1x",
+                    filename: "\(parsedImage.name).\(OutputImageExtension.png.rawValue)"
-              "filename" : "\(imageName).\(XcassetsGenerator.outputImageExtension)"
+                ),
-            },
+                AssetImageDescription(
-            {
+                    idiom: "universal",
-              "idiom" : "universal",
+                    scale: "2x",
-              "scale" : "2x",
+                    filename: "\(parsedImage.name)@2x.\(OutputImageExtension.png.rawValue)"
-              "filename" : "\(imageName)@2x.\(XcassetsGenerator.outputImageExtension)"
+                ),
-            },
+                AssetImageDescription(
-            {
+                    idiom: "universal",
-              "idiom" : "universal",
+                    scale: "3x",
-              "scale" : "3x",
+                    filename: "\(parsedImage.name)@3x.\(OutputImageExtension.png.rawValue)"
-              "filename" : "\(imageName)@3x.\(XcassetsGenerator.outputImageExtension)"
+                )
-            }
+            ],
-          ],
+            info: AssetInfo(
-          "info" : {
+                version: 1,
-            "version" : 1,
+                author: "ResgenSwift-Imagium"
-            "author" : "ResgenSwift-Imagium"
+            )
-          }
+        )
-        }
-        """
 
-        XCTAssertEqual(property.adaptForXCTest(), expect.adaptForXCTest())
+        XCTAssertEqual(property, expect)
+    }
+
+    func testAssetPng() {
+        // Given
+        let imageName = "the_name"
+        let parsedImage = ParsedImage(name: imageName,
+                                      tags: "id",
+                                      width: 10,
+                                      height: 10,
+                                      imageExtensions: [.png])
+
+        // When
+        let property = parsedImage.generateImageContent(isVector: false)
+
+        // Expect
+
+        let expect = AssetContent(
+            images: [
+                AssetImageDescription(
+                    idiom: "universal",
+                    scale: "1x",
+                    filename: "\(parsedImage.name).\(OutputImageExtension.png.rawValue)"
+                ),
+                AssetImageDescription(
+                    idiom: "universal",
+                    scale: "2x",
+                    filename: "\(parsedImage.name)@2x.\(OutputImageExtension.png.rawValue)"
+                ),
+                AssetImageDescription(
+                    idiom: "universal",
+                    scale: "3x",
+                    filename: "\(parsedImage.name)@3x.\(OutputImageExtension.png.rawValue)"
+                )
+            ],
+            info: AssetInfo(
+                version: 1,
+                author: "ResgenSwift-Imagium"
+            )
+        )
+
+        debugPrint(property)
+        debugPrint(expect)
+
+        XCTAssertEqual(property, expect)
     }
 }

Tests/ResgenSwiftTests/Strings/DefinitionTests.swift

@@ -100,6 +100,64 @@ final class DefinitionTests: XCTestCase {
         let expectFr = """
         /// Translation in fr :
         /// C'est la traduction francaise
+        ///
+        /// Comment :
+        /// This is a comment
+        var definition_name: String {
+            NSLocalizedString("definition_name", tableName: kStringsFileName, bundle: Bundle.main, value: "C'est la traduction francaise", comment: "This is a comment")
+        }
+        """
+        
+        let expectEn = """
+        /// Translation in en :
+        /// This is the english translation
+        ///
+        /// Comment :
+        /// This is a comment
+        var definition_name: String {
+            NSLocalizedString("definition_name", tableName: kStringsFileName, bundle: Bundle.main, value: "This is the english translation", comment: "This is a comment")
+        }
+        """
+        
+        let expectEnUs = """
+        /// Translation in en-us :
+        /// This is the english us translation
+        ///
+        /// Comment :
+        /// This is a comment
+        var definition_name: String {
+            NSLocalizedString("definition_name", tableName: kStringsFileName, bundle: Bundle.main, value: "This is the english us translation", comment: "This is a comment")
+        }
+        """
+        
+        XCTAssertEqual(propertyFr.adaptForXCTest(), expectFr.adaptForXCTest())
+        XCTAssertEqual(propertyEn.adaptForXCTest(), expectEn.adaptForXCTest())
+        XCTAssertEqual(propertyEnUs.adaptForXCTest(), expectEnUs.adaptForXCTest())
+    }
+
+    func testGeneratedNSLocalizedStringPropertyWithEmptyComment() {
+        // Given
+        let definition = Definition(name: "definition_name")
+        definition.tags = ["ios","iosonly","notranslation"]
+        definition.comment = ""
+        definition.translations = [
+            "fr": "C'est la traduction francaise",
+            "en": "This is the english translation",
+            "en-us": "This is the english us translation"
+        ]
+
+        // When
+        let propertyFr = definition.getNSLocalizedStringProperty(forLang: "fr")
+        let propertyEn = definition.getNSLocalizedStringProperty(forLang: "en")
+        let propertyEnUs = definition.getNSLocalizedStringProperty(forLang: "en-us")
+
+        // Expect
+        let expectFr = """
+        /// Translation in fr :
+        /// C'est la traduction francaise
+        ///
+        /// Comment :
+        /// No comment
         var definition_name: String {
             NSLocalizedString("definition_name", tableName: kStringsFileName, bundle: Bundle.main, value: "C'est la traduction francaise", comment: "")
         }
@@ -108,6 +166,9 @@ final class DefinitionTests: XCTestCase {
         let expectEn = """
         /// Translation in en :
         /// This is the english translation
+        ///
+        /// Comment :
+        /// No comment
         var definition_name: String {
             NSLocalizedString("definition_name", tableName: kStringsFileName, bundle: Bundle.main, value: "This is the english translation", comment: "")
         }
@@ -116,6 +177,9 @@ final class DefinitionTests: XCTestCase {
         let expectEnUs = """
         /// Translation in en-us :
         /// This is the english us translation
+        ///
+        /// Comment :
+        /// No comment
         var definition_name: String {
             NSLocalizedString("definition_name", tableName: kStringsFileName, bundle: Bundle.main, value: "This is the english us translation", comment: "")
         }
@@ -126,6 +190,62 @@ final class DefinitionTests: XCTestCase {
         XCTAssertEqual(propertyEnUs.adaptForXCTest(), expectEnUs.adaptForXCTest())
     }
 
+    func testGeneratedNSLocalizedStringPropertyWithNoComment() {
+        // Given
+        let definition = Definition(name: "definition_name")
+        definition.tags = ["ios","iosonly","notranslation"]
+        definition.translations = [
+            "fr": "C'est la traduction francaise",
+            "en": "This is the english translation",
+            "en-us": "This is the english us translation"
+        ]
+
+        // When
+        let propertyFr = definition.getNSLocalizedStringProperty(forLang: "fr")
+        let propertyEn = definition.getNSLocalizedStringProperty(forLang: "en")
+        let propertyEnUs = definition.getNSLocalizedStringProperty(forLang: "en-us")
+
+        // Expect
+        let expectFr = """
+        /// Translation in fr :
+        /// C'est la traduction francaise
+        ///
+        /// Comment :
+        /// No comment
+        var definition_name: String {
+            NSLocalizedString("definition_name", tableName: kStringsFileName, bundle: Bundle.main, value: "C'est la traduction francaise", comment: "")
+        }
+        """
+
+        let expectEn = """
+        /// Translation in en :
+        /// This is the english translation
+        ///
+        /// Comment :
+        /// No comment
+        var definition_name: String {
+            NSLocalizedString("definition_name", tableName: kStringsFileName, bundle: Bundle.main, value: "This is the english translation", comment: "")
+        }
+        """
+
+        let expectEnUs = """
+        /// Translation in en-us :
+        /// This is the english us translation
+        ///
+        /// Comment :
+        /// No comment
+        var definition_name: String {
+            NSLocalizedString("definition_name", tableName: kStringsFileName, bundle: Bundle.main, value: "This is the english us translation", comment: "")
+        }
+        """
+
+        XCTAssertEqual(propertyFr.adaptForXCTest(), expectFr.adaptForXCTest())
+        XCTAssertEqual(propertyEn.adaptForXCTest(), expectEn.adaptForXCTest())
+        XCTAssertEqual(propertyEnUs.adaptForXCTest(), expectEnUs.adaptForXCTest())
+    }
+
+    // MARK: - getNSLocalizedStringStaticProperty
+
     func testGeneratedNSLocalizedStringStaticProperty() {
         // Given
         let definition = Definition(name: "definition_name")
@@ -146,6 +266,64 @@ final class DefinitionTests: XCTestCase {
         let expectFr = """
         /// Translation in fr :
         /// C'est la traduction francaise
+        ///
+        /// Comment :
+        /// This is a comment
+        static var definition_name: String {
+            NSLocalizedString("definition_name", tableName: kStringsFileName, bundle: Bundle.main, value: "C'est la traduction francaise", comment: "This is a comment")
+        }
+        """
+        
+        let expectEn = """
+        /// Translation in en :
+        /// This is the english translation
+        ///
+        /// Comment :
+        /// This is a comment
+        static var definition_name: String {
+            NSLocalizedString("definition_name", tableName: kStringsFileName, bundle: Bundle.main, value: "This is the english translation", comment: "This is a comment")
+        }
+        """
+        
+        let expectEnUs = """
+        /// Translation in en-us :
+        /// This is the english us translation
+        ///
+        /// Comment :
+        /// This is a comment
+        static var definition_name: String {
+            NSLocalizedString("definition_name", tableName: kStringsFileName, bundle: Bundle.main, value: "This is the english us translation", comment: "This is a comment")
+        }
+        """
+        
+        XCTAssertEqual(propertyFr.adaptForXCTest(), expectFr.adaptForXCTest())
+        XCTAssertEqual(propertyEn.adaptForXCTest(), expectEn.adaptForXCTest())
+        XCTAssertEqual(propertyEnUs.adaptForXCTest(), expectEnUs.adaptForXCTest())
+    }
+
+    func testGeneratedNSLocalizedStringStaticPropertyWithEmptyComment() {
+        // Given
+        let definition = Definition(name: "definition_name")
+        definition.tags = ["ios","iosonly","notranslation"]
+        definition.comment = ""
+        definition.translations = [
+            "fr": "C'est la traduction francaise",
+            "en": "This is the english translation",
+            "en-us": "This is the english us translation"
+        ]
+
+        // When
+        let propertyFr = definition.getNSLocalizedStringStaticProperty(forLang: "fr")
+        let propertyEn = definition.getNSLocalizedStringStaticProperty(forLang: "en")
+        let propertyEnUs = definition.getNSLocalizedStringStaticProperty(forLang: "en-us")
+
+        // Expect
+        let expectFr = """
+        /// Translation in fr :
+        /// C'est la traduction francaise
+        ///
+        /// Comment :
+        /// No comment
         static var definition_name: String {
             NSLocalizedString("definition_name", tableName: kStringsFileName, bundle: Bundle.main, value: "C'est la traduction francaise", comment: "")
         }
@@ -154,6 +332,9 @@ final class DefinitionTests: XCTestCase {
         let expectEn = """
         /// Translation in en :
         /// This is the english translation
+        ///
+        /// Comment :
+        /// No comment
         static var definition_name: String {
             NSLocalizedString("definition_name", tableName: kStringsFileName, bundle: Bundle.main, value: "This is the english translation", comment: "")
         }
@@ -162,6 +343,63 @@ final class DefinitionTests: XCTestCase {
         let expectEnUs = """
         /// Translation in en-us :
         /// This is the english us translation
+        ///
+        /// Comment :
+        /// No comment
+        static var definition_name: String {
+            NSLocalizedString("definition_name", tableName: kStringsFileName, bundle: Bundle.main, value: "This is the english us translation", comment: "")
+        }
+        """
+
+        XCTAssertEqual(propertyFr.adaptForXCTest(), expectFr.adaptForXCTest())
+        XCTAssertEqual(propertyEn.adaptForXCTest(), expectEn.adaptForXCTest())
+        XCTAssertEqual(propertyEnUs.adaptForXCTest(), expectEnUs.adaptForXCTest())
+    }
+
+    func testGeneratedNSLocalizedStringStaticPropertyWithNoComment() {
+        // Given
+        let definition = Definition(name: "definition_name")
+        definition.tags = ["ios","iosonly","notranslation"]
+        definition.translations = [
+            "fr": "C'est la traduction francaise",
+            "en": "This is the english translation",
+            "en-us": "This is the english us translation"
+        ]
+
+        // When
+        let propertyFr = definition.getNSLocalizedStringStaticProperty(forLang: "fr")
+        let propertyEn = definition.getNSLocalizedStringStaticProperty(forLang: "en")
+        let propertyEnUs = definition.getNSLocalizedStringStaticProperty(forLang: "en-us")
+
+        // Expect
+        let expectFr = """
+        /// Translation in fr :
+        /// C'est la traduction francaise
+        ///
+        /// Comment :
+        /// No comment
+        static var definition_name: String {
+            NSLocalizedString("definition_name", tableName: kStringsFileName, bundle: Bundle.main, value: "C'est la traduction francaise", comment: "")
+        }
+        """
+
+        let expectEn = """
+        /// Translation in en :
+        /// This is the english translation
+        ///
+        /// Comment :
+        /// No comment
+        static var definition_name: String {
+            NSLocalizedString("definition_name", tableName: kStringsFileName, bundle: Bundle.main, value: "This is the english translation", comment: "")
+        }
+        """
+
+        let expectEnUs = """
+        /// Translation in en-us :
+        /// This is the english us translation
+        ///
+        /// Comment :
+        /// No comment
         static var definition_name: String {
             NSLocalizedString("definition_name", tableName: kStringsFileName, bundle: Bundle.main, value: "This is the english us translation", comment: "")
         }
@@ -188,12 +426,18 @@ final class DefinitionTests: XCTestCase {
         let expectFr = """
         /// Translation in fr :
         /// Welcome "%@" !
+        ///
+        /// Comment :
+        /// This is a comment
         var definition_name: String {
-            NSLocalizedString("definition_name", tableName: kStringsFileName, bundle: Bundle.main, value: "Welcome \"%@\" !", comment: "")
+            NSLocalizedString("definition_name", tableName: kStringsFileName, bundle: Bundle.main, value: "Welcome \"%@\" !", comment: "This is a comment")
         }
         
         /// Translation in fr :
         /// Welcome "%@" !
+        ///
+        /// Comment :
+        /// This is a comment
         func definition_name(arg0: String) -> String {
             String(format: self.definition_name, arg0)
         }
@@ -218,12 +462,18 @@ final class DefinitionTests: XCTestCase {
         let expectFr = """
         /// Translation in fr :
         /// Welcome "%@" ! Your age is %d :) Your weight is %f ;-)
+        ///
+        /// Comment :
+        /// This is a comment
         var definition_name: String {
-            NSLocalizedString("definition_name", tableName: kStringsFileName, bundle: Bundle.main, value: "Welcome \"%@\" ! Your age is %d :) Your weight is %f ;-)", comment: "")
+            NSLocalizedString("definition_name", tableName: kStringsFileName, bundle: Bundle.main, value: "Welcome \"%@\" ! Your age is %d :) Your weight is %f ;-)", comment: "This is a comment")
         }
         
         /// Translation in fr :
         /// Welcome "%@" ! Your age is %d :) Your weight is %f ;-)
+        ///
+        /// Comment :
+        /// This is a comment
         func definition_name(arg0: String, arg1: Int, arg2: Double) -> String {
             String(format: self.definition_name, arg0, arg1, arg2)
         }
@@ -249,12 +499,18 @@ final class DefinitionTests: XCTestCase {
         let expectFr = """
         /// Translation in fr :
         /// Vous %%: %1$@ %2$@ Age: %3$d
+        ///
+        /// Comment :
+        /// This is a comment
         var definition_name: String {
-            NSLocalizedString("definition_name", tableName: kStringsFileName, bundle: Bundle.main, value: "Vous %%: %1$@ %2$@ Age: %3$d", comment: "")
+            NSLocalizedString("definition_name", tableName: kStringsFileName, bundle: Bundle.main, value: "Vous %%: %1$@ %2$@ Age: %3$d", comment: "This is a comment")
         }
         
         /// Translation in fr :
         /// Vous %%: %1$@ %2$@ Age: %3$d
+        ///
+        /// Comment :
+        /// This is a comment
         func definition_name(arg0: String, arg1: String, arg2: Int) -> String {
             String(format: self.definition_name, arg0, arg1, arg2)
         }
@@ -263,12 +519,18 @@ final class DefinitionTests: XCTestCase {
         let expectEn = """
         /// Translation in en :
         /// You %%: %2$@ %1$@ Age: %3$d
+        ///
+        /// Comment :
+        /// This is a comment
         var definition_name: String {
-            NSLocalizedString("definition_name", tableName: kStringsFileName, bundle: Bundle.main, value: "You %%: %2$@ %1$@ Age: %3$d", comment: "")
+            NSLocalizedString("definition_name", tableName: kStringsFileName, bundle: Bundle.main, value: "You %%: %2$@ %1$@ Age: %3$d", comment: "This is a comment")
         }
         
         /// Translation in en :
         /// You %%: %2$@ %1$@ Age: %3$d
+        ///
+        /// Comment :
+        /// This is a comment
         func definition_name(arg0: String, arg1: String, arg2: Int) -> String {
             String(format: self.definition_name, arg0, arg1, arg2)
         }
@@ -300,6 +562,9 @@ final class DefinitionTests: XCTestCase {
         let expectFr = """
             /// Translation in fr :
             /// C'est la traduction francaise
+            ///
+            /// Comment :
+            /// This is a comment
             var definition_name: String {
                 "C'est la traduction francaise"
             }
@@ -308,6 +573,9 @@ final class DefinitionTests: XCTestCase {
         let expectEn = """
             /// Translation in en :
             /// This is the english translation
+            ///
+            /// Comment :
+            /// This is a comment
             var definition_name: String {
                 "This is the english translation"
             }
@@ -316,6 +584,9 @@ final class DefinitionTests: XCTestCase {
         let expectEnUs = """
             /// Translation in en-us :
             /// This is the english us translation
+            ///
+            /// Comment :
+            /// This is a comment
             var definition_name: String {
                 "This is the english us translation"
             }
@@ -326,6 +597,117 @@ final class DefinitionTests: XCTestCase {
         XCTAssertEqual(propertyEnUs.adaptForXCTest(), expectEnUs.adaptForXCTest())
     }
 
+    func testGeneratedRawPropertyWithEmptyComment() {
+        // Given
+        let definition = Definition(name: "definition_name")
+        definition.tags = ["ios","iosonly","notranslation"]
+        definition.comment = ""
+        definition.translations = [
+            "fr": "C'est la traduction francaise",
+            "en": "This is the english translation",
+            "en-us": "This is the english us translation"
+        ]
+
+        // When
+        let propertyFr = definition.getProperty(forLang: "fr")
+        let propertyEn = definition.getProperty(forLang: "en")
+        let propertyEnUs = definition.getProperty(forLang: "en-us")
+
+        // Expect
+        let expectFr = """
+            /// Translation in fr :
+            /// C'est la traduction francaise
+            ///
+            /// Comment :
+            /// No comment
+            var definition_name: String {
+                "C'est la traduction francaise"
+            }
+        """
+
+        let expectEn = """
+            /// Translation in en :
+            /// This is the english translation
+            ///
+            /// Comment :
+            /// No comment
+            var definition_name: String {
+                "This is the english translation"
+            }
+        """
+
+        let expectEnUs = """
+            /// Translation in en-us :
+            /// This is the english us translation
+            ///
+            /// Comment :
+            /// No comment
+            var definition_name: String {
+                "This is the english us translation"
+            }
+        """
+
+        XCTAssertEqual(propertyFr.adaptForXCTest(), expectFr.adaptForXCTest())
+        XCTAssertEqual(propertyEn.adaptForXCTest(), expectEn.adaptForXCTest())
+        XCTAssertEqual(propertyEnUs.adaptForXCTest(), expectEnUs.adaptForXCTest())
+    }
+
+    func testGeneratedRawPropertyWithNoComment() {
+        // Given
+        let definition = Definition(name: "definition_name")
+        definition.tags = ["ios","iosonly","notranslation"]
+        definition.translations = [
+            "fr": "C'est la traduction francaise",
+            "en": "This is the english translation",
+            "en-us": "This is the english us translation"
+        ]
+
+        // When
+        let propertyFr = definition.getProperty(forLang: "fr")
+        let propertyEn = definition.getProperty(forLang: "en")
+        let propertyEnUs = definition.getProperty(forLang: "en-us")
+
+        // Expect
+        let expectFr = """
+            /// Translation in fr :
+            /// C'est la traduction francaise
+            ///
+            /// Comment :
+            /// No comment
+            var definition_name: String {
+                "C'est la traduction francaise"
+            }
+        """
+
+        let expectEn = """
+            /// Translation in en :
+            /// This is the english translation
+            ///
+            /// Comment :
+            /// No comment
+            var definition_name: String {
+                "This is the english translation"
+            }
+        """
+
+        let expectEnUs = """
+            /// Translation in en-us :
+            /// This is the english us translation
+            ///
+            /// Comment :
+            /// No comment
+            var definition_name: String {
+                "This is the english us translation"
+            }
+        """
+
+        XCTAssertEqual(propertyFr.adaptForXCTest(), expectFr.adaptForXCTest())
+        XCTAssertEqual(propertyEn.adaptForXCTest(), expectEn.adaptForXCTest())
+        XCTAssertEqual(propertyEnUs.adaptForXCTest(), expectEnUs.adaptForXCTest())
+    }
+
+    // MARK: - Raw static properties
+
     func testGeneratedRawStaticProperty() {
         // Given
         let definition = Definition(name: "definition_name")
@@ -346,6 +728,9 @@ final class DefinitionTests: XCTestCase {
         let expectFr = """
             /// Translation in fr :
             /// C'est la traduction francaise
+            ///
+            /// Comment :
+            /// This is a comment
             static var definition_name: String {
                 "C'est la traduction francaise"
             }
@@ -354,7 +739,10 @@ final class DefinitionTests: XCTestCase {
         let expectEn = """
             /// Translation in en :
             /// This is the english translation
-                        static var definition_name: String {
+            ///
+            /// Comment :
+            /// This is a comment
+            static var definition_name: String {
                 "This is the english translation"
             }
         """
@@ -362,6 +750,118 @@ final class DefinitionTests: XCTestCase {
         let expectEnUs = """
             /// Translation in en-us :
             /// This is the english us translation
+            ///
+            /// Comment :
+            /// This is a comment
+            static var definition_name: String {
+                "This is the english us translation"
+            }
+        """
+        
+        XCTAssertEqual(propertyFr.adaptForXCTest(), expectFr.adaptForXCTest())
+        XCTAssertEqual(propertyEn.adaptForXCTest(), expectEn.adaptForXCTest())
+        XCTAssertEqual(propertyEnUs.adaptForXCTest(), expectEnUs.adaptForXCTest())
+    }
+
+    func testGeneratedRawStaticPropertyWithEmptyComment() {
+        // Given
+        let definition = Definition(name: "definition_name")
+        definition.tags = ["ios","iosonly","notranslation"]
+        definition.comment = ""
+        definition.translations = [
+            "fr": "C'est la traduction francaise",
+            "en": "This is the english translation",
+            "en-us": "This is the english us translation"
+        ]
+
+        // When
+        let propertyFr = definition.getStaticProperty(forLang: "fr")
+        let propertyEn = definition.getStaticProperty(forLang: "en")
+        let propertyEnUs = definition.getStaticProperty(forLang: "en-us")
+
+        // Expect
+        let expectFr = """
+            /// Translation in fr :
+            /// C'est la traduction francaise
+            ///
+            /// Comment :
+            /// No comment
+            static var definition_name: String {
+                "C'est la traduction francaise"
+            }
+        """
+
+        let expectEn = """
+            /// Translation in en :
+            /// This is the english translation
+            ///
+            /// Comment :
+            /// No comment
+            static var definition_name: String {
+                "This is the english translation"
+            }
+        """
+
+        let expectEnUs = """
+            /// Translation in en-us :
+            /// This is the english us translation
+            ///
+            /// Comment :
+            /// No comment
+            static var definition_name: String {
+                "This is the english us translation"
+            }
+        """
+
+        XCTAssertEqual(propertyFr.adaptForXCTest(), expectFr.adaptForXCTest())
+        XCTAssertEqual(propertyEn.adaptForXCTest(), expectEn.adaptForXCTest())
+        XCTAssertEqual(propertyEnUs.adaptForXCTest(), expectEnUs.adaptForXCTest())
+    }
+
+    func testGeneratedRawStaticPropertyWithNoComment() {
+        // Given
+        let definition = Definition(name: "definition_name")
+        definition.tags = ["ios","iosonly","notranslation"]
+        definition.translations = [
+            "fr": "C'est la traduction francaise",
+            "en": "This is the english translation",
+            "en-us": "This is the english us translation"
+        ]
+
+        // When
+        let propertyFr = definition.getStaticProperty(forLang: "fr")
+        let propertyEn = definition.getStaticProperty(forLang: "en")
+        let propertyEnUs = definition.getStaticProperty(forLang: "en-us")
+
+        // Expect
+        let expectFr = """
+            /// Translation in fr :
+            /// C'est la traduction francaise
+            ///
+            /// Comment :
+            /// No comment
+            static var definition_name: String {
+                "C'est la traduction francaise"
+            }
+        """
+
+        let expectEn = """
+            /// Translation in en :
+            /// This is the english translation
+            ///
+            /// Comment :
+            /// No comment
+            static var definition_name: String {
+                "This is the english translation"
+            }
+        """
+
+        let expectEnUs = """
+            /// Translation in en-us :
+            /// This is the english us translation
+            ///
+            /// Comment :
+            /// No comment
             static var definition_name: String {
                 "This is the english us translation"
             }