Merge pull request 'v1.2.2' (#5) from v1.2.2 into master

Reviewed-on: #5

.swiftpm/xcode/xcshareddata/xcschemes/ResgenSwift.xcscheme

@@ -102,6 +102,20 @@
             ReferencedContainer = "container:">
          </BuildableReference>
       </BuildableProductRunnable>
+      <CommandLineArguments>
+         <CommandLineArgument
+            argument = "generate"
+            isEnabled = "YES">
+         </CommandLineArgument>
+         <CommandLineArgument
+            argument = "&quot;$(PROJECT_DIR)/../SampleFiles/resgenConfiguration.yml&quot;"
+            isEnabled = "YES">
+         </CommandLineArgument>
+         <CommandLineArgument
+            argument = "--project-directory &quot;$(PROJECT_DIR)&quot;"
+            isEnabled = "YES">
+         </CommandLineArgument>
+      </CommandLineArguments>
    </LaunchAction>
    <ProfileAction
       buildConfiguration = "Release"

CHANGELOG.md

@@ -0,0 +1,34 @@
+# v1.2 - Architecture generation
+
+## New
+- New section in configuration file: `architecture`. Define your ressources accessors achitecture and let ResgenSwift generate it for you. Check out Readme to know more.
+
+## Fixes
+- Errors and Warnings are now shown in Xcode Issue Navigator
+
+---
+# v1.1 - SwiftUI compatibility
+
+## New
+- Update plist `UIAppFonts` when generated fonts (use plistBuddy)
+	- New parameter: `infoPlistPaths`
+- Generate SwiftUI extensions for colors, fonts and images
+	- New parameter: `extensionNameSwiftUI`
+- Adding Makefile to install, unsintall and create man page.
+
+## Fixes
+Fix SwiftLint rule `trailing_newline`
+
+---
+# v1.0 - Configuration file
+
+## Major
+- A new command has been added: `generate`. Instead of runnning every single command, it will run all necessary command based on a `yaml` configuration file. Check out Readme to know more.
+
+## Minors
+- Code refactoring
+- Huge performance improvements
+- Readme.md update
+- Add option to generate static properties/methods (`staticMembers`)
+- Add option to specify the project directory (`--project-directory`). It allows to run ResgenSwift from anywhere
+- Add `install.sh` script to install ResgenSwift in `/usr/local/bin`

Jenkinsfile

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

README.md

@@ -261,6 +261,67 @@ tags: []
 ...
 ```
 
+### File architecture
+
+ResgenSwift generate extension of classes. Those classes must exists in your project. You can create them yourself OR you can let ResgenSwift create them by specifying what you want. Do as follow: 
+
+```
+architecture:
+  property: R *(required but not used)*
+  classname: R
+  path: ./path/to/generate
+  children:
+    - property: images
+      classname: R2Image
+    - property: strings
+      classname: R2String
+    - property: fonts
+      classname: R2Font
+    - property: images
+      classname: R2Image
+    - property: uikit
+      classname: R2UI
+      children:
+        - property: images
+          classname: R2UIImage
+        - property: fonts
+          classname: R2UIFont
+        - property: images
+          classname: R2UIImage
+```
+
+This will generate a file named as the architecture classname: `R.swift`. Based on the previous architecture, it will generate:
+```
+class R {
+    static let images = R2Image()
+    static let strings = R2String()
+    static let fonts = R2Font()
+    static let images = R2Image()
+    static let uikit = R2UI()
+}
+
+class R2Image {}
+
+class R2String {}
+
+class R2Font {}
+
+class R2Image {}
+
+class R2UI {
+    let images = R2UIImage()
+    let fonts = R2UIFont()
+    let images = R2UIImage()
+}
+
+class R2UIImage {}
+
+class R2UIFont {}
+
+class R2UIImage {}
+```
+
+          
 ### Usage
 
 ```sh

SampleFiles/Colors/Generated/ColorYolo+GenAllScript.swift

@@ -1,4 +1,4 @@
-// Generated by ResgenSwift.Color 1.0
+// Generated by ResgenSwift.Color 1.2
 
 import SwiftUI
 

SampleFiles/Colors/Generated/UIColorYolo+GenAllScript.swift

@@ -1,4 +1,4 @@
-// Generated by ResgenSwift.Color 1.0
+// Generated by ResgenSwift.Color 1.2
 
 import UIKit
 

SampleFiles/Fonts/Generated/FontYolo+GenAllScript.swift

@@ -1,4 +1,4 @@
-// Generated by ResgenSwift.Fonts 1.0
+// Generated by ResgenSwift.Fonts 1.2
 
 import SwiftUI
 

SampleFiles/Fonts/Generated/UIFontYolo+GenAllScript.swift

@@ -1,4 +1,4 @@
-// Generated by ResgenSwift.Fonts 1.0
+// Generated by ResgenSwift.Fonts 1.2
 
 import UIKit
 

SampleFiles/Images/Generated/ImageYolo+GenAllScript.swift

@@ -1,4 +1,4 @@
-// Generated by ResgenSwift.Images 1.0
+// Generated by ResgenSwift.Images 1.2
 // Images from sampleImages
 
 import SwiftUI

SampleFiles/Images/Generated/UIImage+GenAllScript.swift

@@ -1,4 +1,4 @@
-// Generated by ResgenSwift.Images 1.0
+// Generated by ResgenSwift.Images 1.2
 // Images from sampleImages
 
 import UIKit

SampleFiles/Strings/Generated/String+GenAllScript.swift

@@ -1,4 +1,4 @@
-// Generated by ResgenSwift.Strings.Stringium 1.0
+// Generated by ResgenSwift.Strings.Stringium 1.2
 
 import UIKit
 
@@ -6,6 +6,26 @@ fileprivate let kStringsFileName = "sampleStrings"
 
 extension String {
 
+    enum KeyGenAllScript: String {
+        case param_lang = "param_lang"
+        case generic_back = "generic_back"
+        case generic_loading_data = "generic_loading_data"
+        case generic_welcome_firstname_format = "generic_welcome_firstname_format"
+        case test_equal_symbol = "test_equal_symbol"
+        case placeholders_test_one = "placeholders_test_one"
+
+        var keyPath: KeyPath<String, String> {
+            switch self {
+            case .param_lang: return \String.param_lang
+            case .generic_back: return \String.generic_back
+            case .generic_loading_data: return \String.generic_loading_data
+            case .generic_welcome_firstname_format: return \String.generic_welcome_firstname_format
+            case .test_equal_symbol: return \String.test_equal_symbol
+            case .placeholders_test_one: return \String.placeholders_test_one
+            }
+        }
+    }
+
     // MARK: - Webservice
 
     /// Translation in en :

SampleFiles/Strings/Generated/en-us.lproj/sampleStrings.strings

@@ -1,6 +1,6 @@
 /**
  * Apple Strings File
- * Generated by ResgenSwift 1.0
+ * Generated by ResgenSwift 1.2
  * Language: en-us
  */
 

SampleFiles/Strings/Generated/en.lproj/sampleStrings.strings

@@ -1,6 +1,6 @@
 /**
  * Apple Strings File
- * Generated by ResgenSwift 1.0
+ * Generated by ResgenSwift 1.2
  * Language: en
  */
 

SampleFiles/Strings/Generated/fr.lproj/sampleStrings.strings

@@ -1,6 +1,6 @@
 /**
  * Apple Strings File
- * Generated by ResgenSwift 1.0
+ * Generated by ResgenSwift 1.2
  * Language: fr
  */
 

SampleFiles/Tags/Generated/Tags+GenAllScript.swift

@@ -1,4 +1,4 @@
-// Generated by ResgenSwift.Strings.Tags 1.0
+// Generated by ResgenSwift.Strings.Tags 1.2
 
 import UIKit
 

SampleFiles/genAllRessources.sh

@@ -2,33 +2,33 @@
 
 FORCE_FLAG="$1"
 
-# Font
-swift run -c release ResgenSwift fonts $FORCE_FLAG "./Fonts/sampleFontsAll.txt" \
- --extension-output-path "./Fonts/Generated" \
- --extension-name "UIFontYolo" \
- --extension-name-swift-ui "FontYolo" \
- --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 "UIColorYolo" \
- --extension-name-swift-ui "ColorYolo" \
- --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"
+## Font
+#swift run -c release ResgenSwift fonts $FORCE_FLAG "./Fonts/sampleFontsAll.txt" \
+# --extension-output-path "./Fonts/Generated" \
+# --extension-name "UIFontYolo" \
+# --extension-name-swift-ui "FontYolo" \
+# --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 "UIColorYolo" \
+# --extension-name-swift-ui "ColorYolo" \
+# --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"
 
@@ -43,19 +43,19 @@ swift run -c release ResgenSwift strings stringium $FORCE_FLAG "./Strings/sample
 
 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"
-
-# Images
-swift run -c release ResgenSwift images $FORCE_FLAG "./Images/sampleImages.txt" \
- --xcassets-path "./Images/imagium.xcassets" \
- --extension-output-path "./Images/Generated" \
- --extension-name "UIImage" \
- --extension-name-swift-ui "ImageYolo" \
- --extension-suffix "GenAllScript"
+## 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"
+#
+## Images
+#swift run -c release ResgenSwift images $FORCE_FLAG "./Images/sampleImages.txt" \
+# --xcassets-path "./Images/imagium.xcassets" \
+# --extension-output-path "./Images/Generated" \
+# --extension-name "UIImage" \
+# --extension-name-swift-ui "ImageYolo" \
+# --extension-suffix "GenAllScript"

SampleFiles/resgenConfiguration.yml

@@ -1,4 +1,30 @@
 ---
+#
+# Class architecture
+#
+architecture:
+  property: R
+  classname: R
+  path: ./Tags
+  children:
+    - property: images
+      classname: R2Image
+    - property: strings
+      classname: R2String
+    - property: fonts
+      classname: R2Font
+    - property: images
+      classname: R2Image
+    - property: ui
+      classname: R2UI
+      children:
+        - property: images
+          classname: R2UIImage
+        - property: fonts
+          classname: R2UIFont
+        - property: images
+          classname: R2UIImage
+          
 #
 # Strings
 #

Sources/ResgenSwift/Colors/Colors.swift

@@ -77,21 +77,21 @@ struct Colors: ParsableCommand {
         // Check if input file exists
         guard fileManager.fileExists(atPath: options.inputFile) else {
             let error = ColorsToolError.fileNotExists(options.inputFile)
-            print(error.localizedDescription)
+            print(error.description)
             Colors.exit(withError: error)
         }
         
         // Check if xcassets file exists
         guard fileManager.fileExists(atPath: options.xcassetsPath) else {
             let error = ColorsToolError.fileNotExists(options.xcassetsPath)
-            print(error.localizedDescription)
+            print(error.description)
             Colors.exit(withError: error)
         }
         
         // Extension for UIKit and SwiftUI should have different name
         guard options.extensionName != options.extensionNameSwiftUI else {
             let error = ColorsToolError.extensionNamesCollision(options.extensionName)
-            print(error.localizedDescription)
+            print(error.description)
             Colors.exit(withError: error)
         }
         
@@ -117,7 +117,7 @@ struct Colors: ParsableCommand {
                 try fileManager.removeItem(atPath: assetsColorPath)
             } catch {
                 let error = ColorsToolError.deleteExistingColors("\(options.xcassetsPath)/Colors")
-                print(error.localizedDescription)
+                print(error.description)
                 Colors.exit(withError: error)
             }
         }

Sources/ResgenSwift/Colors/Generator/ColorExtensionGenerator.swift

@@ -32,7 +32,7 @@ struct ColorExtensionGenerator {
             try extensionContent.write(to: extensionFilePathURL, atomically: false, encoding: .utf8)
         } catch (let error) {
             let error = ColorsToolError.writeExtension(extensionFilePath, error.localizedDescription)
-            print(error.localizedDescription)
+            print(error.description)
             Colors.exit(withError: error)
         }
     }

Sources/ResgenSwift/Colors/Generator/ColorXcassetHelper.swift

@@ -29,7 +29,7 @@ struct ColorXcassetHelper {
                                             withIntermediateDirectories: true)
             } catch {
                 let error = ColorsToolError.createAssetFolder(colorSetPath)
-                print(error.localizedDescription)
+                print(error.description)
                 Colors.exit(withError: error)
             }
         }
@@ -40,7 +40,7 @@ struct ColorXcassetHelper {
             try color.contentsJSON().write(to: contentsJsonPathURL, atomically: false, encoding: .utf8)
         } catch (let error) {
             let error = ColorsToolError.writeAsset(error.localizedDescription)
-            print(error.localizedDescription)
+            print(error.description)
             Colors.exit(withError: error)
         }
     }

Sources/ResgenSwift/Colors/Model/ParsedColor.swift

@@ -26,7 +26,7 @@ struct ParsedColor {
         
         guard allComponents.contains(true) == false else {
             let error = ColorsToolError.badColorDefinition(light, dark)
-            print(error.localizedDescription)
+            print(error.description)
             Colors.exit(withError: error)
         }
         

Sources/ResgenSwift/Colors/Parser/ColorFileParser.swift

@@ -37,7 +37,7 @@ class ColorFileParser {
                 
                 guard colorContent.count >= 2 else {
                     let error = ColorsToolError.badFormat(colorLine)
-                    print(error.localizedDescription)
+                    print(error.description)
                     Colors.exit(withError: error)
                 }
                 

Sources/ResgenSwift/Fonts/Fonts.swift

@@ -74,14 +74,14 @@ struct Fonts: ParsableCommand {
         // Check input file exists
         guard fileManager.fileExists(atPath: options.inputFile) else {
             let error = FontsToolError.fileNotExists(options.inputFile)
-            print(error.localizedDescription)
+            print(error.description)
             Fonts.exit(withError: error)
         }
         
         // Extension for UIKit and SwiftUI should have different name
         guard options.extensionName != options.extensionNameSwiftUI else {
             let error = FontsToolError.extensionNamesCollision(options.extensionName)
-            print(error.localizedDescription)
+            print(error.description)
             Fonts.exit(withError: error)
         }
         

Sources/ResgenSwift/Fonts/FontsToolError.swift

@@ -14,7 +14,7 @@ enum FontsToolError: Error {
     case fileNotExists(String)
     case writeExtension(String, String)
     
-    var localizedDescription: String {
+    var description: String {
         switch self {
         case .extensionNamesCollision(let extensionName):
             return "error: [\(Fonts.toolName)] Error on extension names, extension name and SwiftUI extension name should be different (\(extensionName) is used on both)"

Sources/ResgenSwift/Fonts/FontsToolHelper.swift

@@ -39,7 +39,7 @@ class FontsToolHelper {
         let fileManager = FileManager()
         guard fileManager.fileExists(atPath: inputFolder) else {
             let error = FontsToolError.inputFolderNotFound(inputFolder)
-            print(error.localizedDescription)
+            print(error.description)
             Fonts.exit(withError: error)
         }
         
@@ -64,7 +64,7 @@ class FontsToolHelper {
         
         guard let fontName = task.output, task.terminationStatus == 0 else {
             let error = FontsToolError.fcScan(path, task.terminationStatus, task.output)
-            print(error.localizedDescription)
+            print(error.description)
             Fonts.exit(withError: error)
         }
         

Sources/ResgenSwift/Fonts/Generator/FontToolContentGenerator.swift

@@ -38,7 +38,7 @@ class FontExtensionGenerator {
             try extensionContent.write(to: extensionFilePathURL, atomically: false, encoding: .utf8)
         } catch (let error) {
             let error = FontsToolError.writeExtension(extensionFilePath, error.localizedDescription)
-            print(error.localizedDescription)
+            print(error.description)
             Fonts.exit(withError: error)
         }
     }

Sources/ResgenSwift/Generate/Generate.swift

@@ -41,7 +41,10 @@ struct Generate: ParsableCommand {
         print("  - \(configuration.tags.count) tags configuration(s)")
         print()
         
-        print("Input file: \(configuration.colors.first?.inputFile ?? "no input file")")
+        if let architecture = configuration.architecture {
+            ArchitectureGenerator.writeArchitecture(architecture,
+                                                    projectDirectory: options.projectDirectory)
+        }
         
         // Execute commands
         configuration.runnableConfigurations

Sources/ResgenSwift/Generate/GenerateError.swift

@@ -11,8 +11,9 @@ enum GenerateError: Error {
     case fileNotExists(String)
     case invalidConfigurationFile(String)
     case commandError([String], String)
+    case writeFile(String, String)
     
-    var localizedDescription: String {
+    var description: String {
         switch self {
         case .fileNotExists(let filename):
             return "error: [\(Generate.toolName)] File \(filename) does not exists"
@@ -25,6 +26,9 @@ enum GenerateError: Error {
                 .map { $0 }
                 .joined(separator: " ")
             return "error: [\(Generate.toolName)] An error occured while running command '\(readableCommand)'. Command terminate with status code: \(terminationStatus)"
+            
+        case .writeFile(let filename, let info):
+            return "error: [\(Generate.toolName)] An error occured while writing file in \(filename): \(info)"
         }
     }
 }

Sources/ResgenSwift/Generate/Generator/ArchitectureGenerator.swift

@@ -0,0 +1,37 @@
+//
+//  ArchitectureGenerator.swift
+//  
+//
+//  Created by Thibaut Schmitt on 18/11/2022.
+//
+
+import ToolCore
+import Foundation
+
+struct ArchitectureGenerator {
+    static func writeArchitecture(_ architecture: ConfigurationArchitecture, projectDirectory: String) {
+        // Create extension content
+        let architectureContent = [
+            "// Generated by ResgenSwift.\(Generate.toolName) \(ResgenSwiftVersion)",
+            architecture.getClass()
+        ]
+            .joined(separator: "\n\n")
+        
+        let filename = "\(architecture.classname).swift"
+        guard let filePath = architecture.path?.prependIfRelativePath(projectDirectory) else {
+            let error = GenerateError.writeFile(filename, "Path of file is not defined.")
+            print(error.description)
+            Generate.exit(withError: error)
+        }
+        
+        // Write content
+        let architectureFilePathURL = URL(fileURLWithPath: "\(filePath)/\(filename)")
+        do {
+            try architectureContent.write(to: architectureFilePathURL, atomically: false, encoding: .utf8)
+        } catch (let error) {
+            let error = GenerateError.writeFile(filename, error.localizedDescription)
+            print(error.description)
+            Generate.exit(withError: error)
+        }
+    }
+}

Sources/ResgenSwift/Generate/Model/ConfigurationFile.swift

@@ -8,6 +8,7 @@
 import Foundation
 
 struct ConfigurationFile: Codable, CustomDebugStringConvertible {
+    var architecture: ConfigurationArchitecture?
     var colors: [ColorsConfiguration]
     var fonts: [FontsConfiguration]
     var images: [ImagesConfiguration]
@@ -38,6 +39,42 @@ struct ConfigurationFile: Codable, CustomDebugStringConvertible {
     }
 }
 
+struct ConfigurationArchitecture: Codable {
+    let property: String
+    let classname: String
+    let path: String?
+    let children: [ConfigurationArchitecture]?
+    
+    func getProperty(isStatic: Bool) -> String {
+        "    \(isStatic ? "static " : "")let \(property) = \(classname)()"
+    }
+    
+    func getClass(generateStaticProperty: Bool = true) -> String {
+        guard children?.isEmpty == false else {
+            return "class \(classname) {}"
+        }
+        
+        let classDefinition = [
+            "class \(classname) {",
+            children?.map { $0.getProperty(isStatic: generateStaticProperty) }.joined(separator: "\n"),
+            "}"
+        ]
+            .compactMap { $0 }
+            .joined(separator: "\n")
+        
+        return [classDefinition, "", getSubclass()]
+            .compactMap { $0 }
+            .joined(separator: "\n")
+    }
+    
+    func getSubclass() -> String? {
+        guard let children else { return nil }
+        return children.compactMap { arch in
+            arch.getClass(generateStaticProperty: false)
+        }
+        .joined(separator: "\n\n")
+    }
+}
 
 struct ColorsConfiguration: Codable, CustomDebugStringConvertible {
     let inputFile: String
@@ -267,4 +304,3 @@ struct TagsConfiguration: Codable, CustomDebugStringConvertible {
         """
     }
 }
-

Sources/ResgenSwift/Generate/Parser/ConfigurationFileParser.swift

@@ -12,13 +12,13 @@ class ConfigurationFileParser {
     static func parse(_ configurationFile: String) -> ConfigurationFile {
         guard let data = FileManager().contents(atPath: configurationFile) else {
             let error = GenerateError.fileNotExists(configurationFile)
-            print(error.localizedDescription)
+            print(error.description)
             Generate.exit(withError: error)
         }
         
         guard let configuration = try? YAMLDecoder().decode(ConfigurationFile.self, from: data) else {
             let error = GenerateError.invalidConfigurationFile(configurationFile)
-            print(error.localizedDescription)
+            print(error.description)
             Generate.exit(withError: error)
         }
         

Sources/ResgenSwift/Images/Extensions/FileManagerExtensions.swift

@@ -12,7 +12,7 @@ extension FileManager {
         var files = [String]()
         guard let enumerator = self.enumerator(at: URL(string: directory)!, includingPropertiesForKeys: [.isRegularFileKey], options: [.skipsHiddenFiles, .skipsPackageDescendants]) else {
             let error = ImagesError.unknown("Cannot enumerate file in \(directory)")
-            print(error.localizedDescription)
+            print(error.description)
             Images.exit(withError: error)
         }
         
@@ -24,7 +24,7 @@ extension FileManager {
                 }
             } catch {
                 let error = ImagesError.getFileAttributed(fileURL.relativePath, error.localizedDescription)
-                print(error.localizedDescription)
+                print(error.description)
                 Images.exit(withError: error)
             }
         }
@@ -35,7 +35,7 @@ extension FileManager {
         var files = [String]()
         guard let enumerator = self.enumerator(at: URL(string: directory)!, includingPropertiesForKeys: [.isDirectoryKey], options: [.skipsHiddenFiles, .skipsPackageDescendants]) else {
             let error = ImagesError.unknown("Cannot enumerate imageset directory in \(directory)")
-            print(error.localizedDescription)
+            print(error.description)
             Images.exit(withError: error)
         }
         
@@ -47,7 +47,7 @@ extension FileManager {
                 }
             } catch {
                 let error = ImagesError.getFileAttributed(fileURL.relativePath, error.localizedDescription)
-                print(error.localizedDescription)
+                print(error.description)
                 Images.exit(withError: error)
             }
         }

Sources/ResgenSwift/Images/Generator/ImageExtensionGenerator.swift

@@ -31,7 +31,7 @@ class ImageExtensionGenerator {
             try extensionContent.write(to: extensionFilePathURL, atomically: false, encoding: .utf8)
         } catch (let error) {
             let error = ImagesError.writeFile(extensionFilePath, error.localizedDescription)
-            print(error.localizedDescription)
+            print(error.description)
             Images.exit(withError: error)
         }
     }

Sources/ResgenSwift/Images/Generator/XcassetsGenerator.swift

@@ -48,7 +48,7 @@ class XcassetsGenerator {
                     }
                 }
                 let error = ImagesError.unknownImageExtension(parsedImage.name)
-                print(error.localizedDescription)
+                print(error.description)
                 Images.exit(withError: error)
             }()
             
@@ -77,7 +77,7 @@ class XcassetsGenerator {
                                                     withIntermediateDirectories: true)
                 } catch {
                     let error = ImagesError.createAssetFolder(imagesetPath)
-                    print(error.localizedDescription)
+                    print(error.description)
                     Images.exit(withError: error)
                 }
             }

Sources/ResgenSwift/Images/Images.swift

@@ -82,7 +82,7 @@ struct Images: ParsableCommand {
         // Input file
         guard fileManager.fileExists(atPath: options.inputFile) else {
             let error = ImagesError.fileNotExists(options.inputFile)
-            print(error.localizedDescription)
+            print(error.description)
             Images.exit(withError: error)
         }
 
@@ -92,7 +92,7 @@ struct Images: ParsableCommand {
         // Extension for UIKit and SwiftUI should have different name
         guard options.extensionName != options.extensionNameSwiftUI else {
             let error = ImagesError.extensionNamesCollision(options.extensionName)
-            print(error.localizedDescription)
+            print(error.description)
             Images.exit(withError: error)
         }
         
@@ -117,7 +117,7 @@ struct Images: ParsableCommand {
         }
         
         let error = ImagesError.rsvgConvertNotFound
-        print(error.localizedDescription)
+        print(error.description)
         Images.exit(withError: error)
     }
 }

Sources/ResgenSwift/Images/ImagesError.swift

@@ -18,7 +18,7 @@ enum ImagesError: Error {
     case createAssetFolder(String)
     case unknown(String)
     
-    var localizedDescription: String {
+    var description: String {
         switch self {
         case .extensionNamesCollision(let extensionName):
             return "error: [\(Fonts.toolName)] Error on extension names, extension name and SwiftUI extension name should be different (\(extensionName) is used on both)"

Sources/ResgenSwift/Strings/Generator/StringsFileGenerator.swift

@@ -12,7 +12,12 @@ class StringsFileGenerator {
     
     // MARK: - Strings Files
     
-    static func writeStringsFiles(sections: [Section], langs: [String], defaultLang: String, tags: [String], outputPath: String, inputFilenameWithoutExt: String) {
+    static func writeStringsFiles(sections: [Section],
+                                  langs: [String],
+                                  defaultLang: String,
+                                  tags: [String],
+                                  outputPath: String,
+                                  inputFilenameWithoutExt: String) {
         var stringsFilesContent = [String: String]()
         for lang in langs {
             stringsFilesContent[lang] = Self.generateStringsFileContent(lang: lang,
@@ -31,13 +36,16 @@ class StringsFileGenerator {
                 try fileContent.write(to: stringsFilePathURL, atomically: false, encoding: .utf8)
             } catch (let error) {
                 let error = StringiumError.writeFile(error.localizedDescription, stringsFilePath)
-                print(error.localizedDescription)
+                print(error.description)
                 Stringium.exit(withError: error)
             }
         }
     }
     
-    static func generateStringsFileContent(lang: String, defaultLang: String, tags inputTags: [String], sections: [Section]) -> String {
+    static func generateStringsFileContent(lang: String,
+                                           defaultLang: String,
+                                           tags inputTags: [String],
+                                           sections: [Section]) -> String {
         var stringsFileContent = """
         /**
          * Apple Strings File
@@ -75,7 +83,7 @@ class StringsFileGenerator {
                     stringsFileContent += "\"\(definition.name)\" = \"\(translation)\";\n\n"
                 } else if skipDefinition == false {
                     let error = StringiumError.langNotDefined(lang, definition.name, definition.reference != nil)
-                    print(error.localizedDescription)
+                    print(error.description)
                     Stringium.exit(withError: error)
                 }
             }
@@ -86,14 +94,22 @@ class StringsFileGenerator {
     
     // MARK: - Extension file
     
-    static func writeExtensionFiles(sections: [Section], defaultLang lang: String, tags: [String], staticVar: Bool, inputFilename: String, extensionName: String, extensionFilePath: String) {
+    static func writeExtensionFiles(sections: [Section],
+                                    defaultLang lang: String,
+                                    tags: [String],
+                                    staticVar: Bool,
+                                    inputFilename: String,
+                                    extensionName: String,
+                                    extensionFilePath: String,
+                                    extensionSuffix: String) {
         // Get extension content
         let extensionFileContent = Self.getExtensionContent(sections: sections,
                                                             defaultLang: lang,
                                                             tags: tags,
                                                             staticVar: staticVar,
                                                             inputFilename: inputFilename,
-                                                            extensionName: extensionName)
+                                                            extensionName: extensionName,
+                                                            extensionSuffix: extensionSuffix)
         
         // Write content
         let extensionFilePathURL = URL(fileURLWithPath: extensionFilePath)
@@ -101,16 +117,23 @@ class StringsFileGenerator {
             try extensionFileContent.write(to: extensionFilePathURL, atomically: false, encoding: .utf8)
         } catch (let error) {
             let error = StringiumError.writeFile(extensionFilePath, error.localizedDescription)
-            print(error.localizedDescription)
+            print(error.description)
             Stringium.exit(withError: error)
         }
     }
     
     // MARK: - Extension content
     
-    static func getExtensionContent(sections: [Section], defaultLang lang: String, tags: [String], staticVar: Bool, inputFilename: String, extensionName: String) -> String {
+    static func getExtensionContent(sections: [Section],
+                                    defaultLang lang: String,
+                                    tags: [String],
+                                    staticVar: Bool,
+                                    inputFilename: String,
+                                    extensionName: String,
+                                    extensionSuffix: String) -> String {
         [
             Self.getHeader(stringsFilename: inputFilename, extensionClassname: extensionName),
+            Self.getEnumKey(sections: sections, tags: tags, extensionClassname: extensionName, extensionSuffix: extensionSuffix),
             Self.getProperties(sections: sections, defaultLang: lang, tags: tags, staticVar: staticVar),
             Self.getFooter()
         ]
@@ -131,6 +154,50 @@ class StringsFileGenerator {
         """
     }
     
+    private static func getEnumKey(sections: [Section], tags: [String], extensionClassname: String, extensionSuffix: String) -> String {
+        var enumDefinition = "\n    enum Key\(extensionSuffix.uppercasedFirst()): String {\n"
+        
+        // Enum
+        sections.forEach { section in
+            // Check that at least one string will be generated
+            guard section.hasOneOrMoreMatchingTags(tags: tags) else {
+                return // Go to next section
+            }
+            
+            section.definitions.forEach { definition in
+                guard definition.hasOneOrMoreMatchingTags(inputTags: tags) == true else {
+                    return // Go to next definition
+                }
+                debugPrint("Found definition")
+                enumDefinition += "        case \(definition.name) = \"\(definition.name)\"\n"
+            }
+        }
+        
+        // KeyPath accessors
+        enumDefinition += "\n"
+        enumDefinition += "        var keyPath: KeyPath<\(extensionClassname), String> {\n"
+        enumDefinition += "            switch self {\n"
+        sections.forEach { section in
+            // Check that at least one string will be generated
+            guard section.hasOneOrMoreMatchingTags(tags: tags) else {
+                return // Go to next section
+            }
+            
+            section.definitions.forEach { definition in
+                guard definition.hasOneOrMoreMatchingTags(inputTags: tags) == true else {
+                    return // Go to next definition
+                }
+                debugPrint("Found definition")
+                enumDefinition += "            case .\(definition.name): return \\\(extensionClassname).\(definition.name)\n"
+            }
+        }
+        enumDefinition += "            }\n" // Switch
+        enumDefinition += "        }\n" // var keyPath
+        enumDefinition += "    }" // Enum
+        
+        return enumDefinition
+    }
+    
     private static func getProperties(sections: [Section], defaultLang lang: String, tags: [String], staticVar: Bool) -> String {
         sections.compactMap { section in
             // Check that at least one string will be generated

Sources/ResgenSwift/Strings/Generator/TagsGenerator.swift

@@ -24,7 +24,7 @@ class TagsGenerator {
             try extensionFileContent.write(to: extensionFilePathURL, atomically: false, encoding: .utf8)
         } catch (let error) {
             let error = StringiumError.writeFile(extensionFilePath, error.localizedDescription)
-            print(error.localizedDescription)
+            print(error.description)
             Stringium.exit(withError: error)
         }
     }

Sources/ResgenSwift/Strings/Model/Definition.swift

@@ -109,7 +109,7 @@ class Definition {
     func getNSLocalizedStringProperty(forLang lang: String) -> String {
         guard let translation = translations[lang] else {
             let error = StringiumError.langNotDefined(lang, name, reference != nil)
-            print(error.localizedDescription)
+            print(error.description)
             Stringium.exit(withError: error)
         }
 
@@ -132,7 +132,7 @@ class Definition {
     func getNSLocalizedStringStaticProperty(forLang lang: String) -> String {
         guard let translation = translations[lang] else {
             let error = StringiumError.langNotDefined(lang, name, reference != nil)
-            print(error.localizedDescription)
+            print(error.description)
             Stringium.exit(withError: error)
         }
         
@@ -157,7 +157,7 @@ class Definition {
     func getProperty(forLang lang: String) -> String {
         guard let translation = translations[lang] else {
             let error = StringiumError.langNotDefined(lang, name, reference != nil)
-            print(error.localizedDescription)
+            print(error.description)
             Stringium.exit(withError: error)
         }
         
@@ -173,7 +173,7 @@ class Definition {
     func getStaticProperty(forLang lang: String) -> String {
         guard let translation = translations[lang] else {
             let error = StringiumError.langNotDefined(lang, name, reference != nil)
-            print(error.localizedDescription)
+            print(error.description)
             Stringium.exit(withError: error)
         }
         

Sources/ResgenSwift/Strings/Stringium/Stringium.swift

@@ -57,7 +57,8 @@ struct Stringium: ParsableCommand {
                                                  staticVar: options.staticMembers,
                                                  inputFilename: options.inputFilenameWithoutExt,
                                                  extensionName: options.extensionName,
-                                                 extensionFilePath: options.extensionFilePath)
+                                                 extensionFilePath: options.extensionFilePath,
+                                                 extensionSuffix: options.extensionSuffix)
         
         print("[\(Self.toolName)] Strings generated")
     }
@@ -70,20 +71,20 @@ struct Stringium: ParsableCommand {
         // Input file
         guard fileManager.fileExists(atPath: options.inputFile) else {
             let error = StringiumError.fileNotExists(options.inputFile)
-            print(error.localizedDescription)
+            print(error.description)
             Stringium.exit(withError: error)
         }
         
         // Langs
         guard options.langs.isEmpty == false else {
             let error = StringiumError.langsListEmpty
-            print(error.localizedDescription)
+            print(error.description)
             Stringium.exit(withError: error)
         }
         
         guard options.langs.contains(options.defaultLang) else {
             let error = StringiumError.defaultLangsNotInLangs
-            print(error.localizedDescription)
+            print(error.description)
             Stringium.exit(withError: error)
         }
         

Sources/ResgenSwift/Strings/Stringium/StringiumError.swift

@@ -14,7 +14,7 @@ enum StringiumError: Error {
     case writeFile(String, String)
     case langNotDefined(String, String, Bool)
     
-    var localizedDescription: String {
+    var description: String {
         switch self {
         case .fileNotExists(let filename):
             return "error: [\(Stringium.toolName)] File \(filename) does not exists "
@@ -30,7 +30,7 @@ enum StringiumError: Error {
             
         case .langNotDefined(let lang, let definitionName, let isReference):
             if isReference {
-                return " error:[\(Stringium.toolName)] Reference are handled only by TwineTool. Please use it or remove reference from you strings file."
+                return "error: [\(Stringium.toolName)] Reference are handled only by Twine. Please use it or remove reference from you strings file."
             }
             return "error: [\(Stringium.toolName)] Lang \"\(lang)\" not found for \"\(definitionName)\""
         }

Sources/ResgenSwift/Strings/Stringium/StringiumOptions.swift

@@ -36,8 +36,8 @@ struct StringiumOptions: ParsableArguments {
     @Option(help: "Extension name. If not specified, it will generate an String extension.")
     var extensionName: String = Stringium.defaultExtensionName
     
-    @Option(help: "Extension suffix. Ex: MyApp, it will generate {extensionName}+{extensionSuffix}.swift")
-    var extensionSuffix: String?
+    @Option(help: "Extension suffix: {extensionName}+{extensionSuffix}.swift")
+    var extensionSuffix: String
 }
 
 // MARK: - Private var getter
@@ -68,10 +68,7 @@ extension StringiumOptions {
 
 extension StringiumOptions {
     var extensionFileName: String {
-        if let extensionSuffix = extensionSuffix {
-            return "\(extensionName)+\(extensionSuffix).swift"
-        }
-        return "\(extensionName).swift"
+        "\(extensionName)+\(extensionSuffix).swift"
     }
     
     var extensionFilePath: String {

Sources/ResgenSwift/Strings/Tag/Tags.swift

@@ -62,7 +62,7 @@ struct Tags: ParsableCommand {
         // Input file
         guard fileManager.fileExists(atPath: options.inputFile) else {
             let error = StringiumError.fileNotExists(options.inputFile)
-            print(error.localizedDescription)
+            print(error.description)
             Stringium.exit(withError: error)
         }
         

Sources/ResgenSwift/Strings/Twine/Twine.swift

@@ -66,20 +66,20 @@ struct Twine: ParsableCommand {
         // Input file
         guard fileManager.fileExists(atPath: options.inputFile) else {
             let error = TwineError.fileNotExists(options.inputFile)
-            print(error.localizedDescription)
+            print(error.description)
             Twine.exit(withError: error)
         }
         
         // Langs
         guard options.langs.isEmpty == false else {
             let error = TwineError.langsListEmpty
-            print(error.localizedDescription)
+            print(error.description)
             Twine.exit(withError: error)
         }
         
         guard options.langs.contains(options.defaultLang) else {
             let error = TwineError.defaultLangsNotInLangs
-            print(error.localizedDescription)
+            print(error.description)
             Twine.exit(withError: error)
         }
         

Sources/ResgenSwift/Strings/Twine/TwineError.swift

@@ -12,7 +12,7 @@ enum TwineError: Error {
     case langsListEmpty
     case defaultLangsNotInLangs
     
-    var localizedDescription: String {
+    var description: String {
         switch self {
         case .fileNotExists(let filename):
             return "error: [\(Twine.toolName)] File \(filename) does not exists "

Sources/ToolCore/StringExtensions.swift

@@ -85,4 +85,8 @@ public extension String {
         blue = String(colorClean.prefix(2))
         return (alpha: alpha, red: red, green: green, blue: blue)
     }
+    
+    func uppercasedFirst() -> String {
+        prefix(1).uppercased() + dropFirst()
+    }
 }

Sources/ToolCore/Version.swift

@@ -7,4 +7,4 @@
 
 import Foundation
 
-public let ResgenSwiftVersion = "1.1"
+public let ResgenSwiftVersion = "1.2"

Tests/ResgenSwiftTests/Strings/StringsFileGeneratorTests.swift

@@ -131,7 +131,8 @@ final class StringsFileGeneratorTests: XCTestCase {
                                                                         tags: ["ios", "iosonly", "notranslation"],
                                                                         staticVar: false,
                                                                         inputFilename: "myInputFilename",
-                                                                        extensionName: "GenStrings")
+                                                                        extensionName: "GenStrings",
+                                                                        extensionSuffix: "strings")
         
         // Expect
         let expect = """
@@ -207,7 +208,8 @@ final class StringsFileGeneratorTests: XCTestCase {
                                                                         tags: ["ios", "iosonly", "notranslation"],
                                                                         staticVar: true,
                                                                         inputFilename: "myInputFilename",
-                                                                        extensionName: "GenStrings")
+                                                                        extensionName: "GenStrings",
+                                                                        extensionSuffix: "strings")
         
         // Expect
         let expect = """