openium/resgen.swift
1
0
Fork 0
Code Pull Requests 1 Releases 8 Activity

v1.2 - Architecture generation #3

Merged
t.schmitt merged 6 commits from v1.2 into master 2022-11-24 09:14:34 +01:00
Conversation 0 Commits 6 Files Changed 34 +298 -84
34 changed files with 298 additions and 84 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
.swiftpm/xcode/xcshareddata/xcschemes/ResgenSwift.xcscheme
View File

@ -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"

34
CHANGELOG.md
View File

@ -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`

61
README.md
View File

@ -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

26
SampleFiles/resgenConfiguration.yml
View File

@ -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
#

8
Sources/ResgenSwift/Colors/Colors.swift
View File

@ -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)
}
}

2
Sources/ResgenSwift/Colors/Generator/ColorExtensionGenerator.swift
View File

@ -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)
}
}

4
Sources/ResgenSwift/Colors/Generator/ColorXcassetHelper.swift
View File

@ -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)
}
}

2
Sources/ResgenSwift/Colors/Model/ParsedColor.swift
View File

@ -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)
}

2
Sources/ResgenSwift/Colors/Parser/ColorFileParser.swift
View File

@ -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)
}

4
Sources/ResgenSwift/Fonts/Fonts.swift
View File

@ -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)
}

2
Sources/ResgenSwift/Fonts/FontsToolError.swift
View File

@ -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)"

4
Sources/ResgenSwift/Fonts/FontsToolHelper.swift
View File

@ -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)
}

2
Sources/ResgenSwift/Fonts/Generator/FontToolContentGenerator.swift
View File

@ -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)
}
}

4
Sources/ResgenSwift/Generate/Generate.swift
View File

@ -41,7 +41,9 @@ 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)
}
// Execute commands
configuration.runnableConfigurations

6
Sources/ResgenSwift/Generate/GenerateError.swift
View File

@ -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)"
}
}
}

37
Sources/ResgenSwift/Generate/Generator/ArchitectureGenerator.swift Normal file
View File

@ -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) {
// 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 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)
}
}
}

38
Sources/ResgenSwift/Generate/Model/ConfigurationFile.swift
View File

@ -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 {
"""
}
}

4
Sources/ResgenSwift/Generate/Parser/ConfigurationFileParser.swift
View File

@ -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)
}

8
Sources/ResgenSwift/Images/Extensions/FileManagerExtensions.swift
View File

@ -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)
}
}

2
Sources/ResgenSwift/Images/Generator/ImageExtensionGenerator.swift
View File

@ -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)
}
}

4
Sources/ResgenSwift/Images/Generator/XcassetsGenerator.swift
View File

@ -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)
}
}

6
Sources/ResgenSwift/Images/Images.swift
View File

@ -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)
}
}

2
Sources/ResgenSwift/Images/ImagesError.swift
View File

@ -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)"

6
Sources/ResgenSwift/Strings/Generator/StringsFileGenerator.swift
View File

@ -31,7 +31,7 @@ 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)
}
}
@ -75,7 +75,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)
}
}
@ -101,7 +101,7 @@ 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)
}
}

2
Sources/ResgenSwift/Strings/Generator/TagsGenerator.swift
View File

@ -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)
}
}

8
Sources/ResgenSwift/Strings/Model/Definition.swift
View File

@ -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)
}

6
Sources/ResgenSwift/Strings/Stringium/Stringium.swift
View File

@ -70,20 +70,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)
}

4
Sources/ResgenSwift/Strings/Stringium/StringiumError.swift
View File

@ -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)\""
}

2
Sources/ResgenSwift/Strings/Tag/Tags.swift
View File

@ -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)
}

6
Sources/ResgenSwift/Strings/Twine/Twine.swift
View File

@ -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)
}

2
Sources/ResgenSwift/Strings/Twine/TwineError.swift
View File

@ -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 "

2
Sources/ToolCore/Version.swift
View File

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