Add --generator flag to executable, optionally configure which generators to run

Author: tomlokhorst

Sources/RswiftCore/CallInformation.swift

@@ -15,6 +15,7 @@ public struct CallInformation {
   let uiTestOutputURL: URL?
   let rswiftIgnoreURL: URL
 
+  let generators: [Generator]
   let accessLevel: AccessLevel
   let imports: [Module]
 
@@ -38,6 +39,7 @@ public struct CallInformation {
     uiTestOutputURL: URL?,
     rswiftIgnoreURL: URL,
 
+    generators: [Generator],
     accessLevel: AccessLevel,
     imports: [Module],
 
@@ -62,6 +64,7 @@ public struct CallInformation {
 
     self.accessLevel = accessLevel
     self.imports = imports
+    self.generators = generators
 
     self.xcodeprojURL = xcodeprojURL
     self.targetName = targetName

Sources/RswiftCore/Generators/Generators.swift

@@ -0,0 +1,39 @@
+//
+//  Generators.swift
+//  Commander
+//
+//  Created by Tom Lokhorst on 2019-09-21.
+//
+
+import Foundation
+
+public enum Generator: String, CaseIterable {
+  case image
+  case color
+  case font
+  case segue
+  case storyboard
+  case nib
+  case reuseIdentifier
+  case file
+  case string
+  case id
+
+  static func parseGenerators(_ string: String) -> ([Generator], [String]) {
+    var generators: [Generator] = []
+    var unknowns: [String] = []
+
+    let parts = string.components(separatedBy: ",")
+      .map { $0.trimmingCharacters(in: CharacterSet.whitespaces) }
+
+    for part in parts {
+      if let generator = Generator(rawValue: part) {
+        generators.append(generator)
+      } else {
+        unknowns.append(part)
+      }
+    }
+
+    return (generators, unknowns)
+  }
+}

Sources/RswiftCore/RswiftCore.swift

@@ -10,6 +10,20 @@
 import Foundation
 import XcodeEdit
 
+public typealias RswiftGenerator = Generator
+public enum Generator: String, CaseIterable {
+  case image
+  case color
+  case font
+  case segue
+  case storyboard
+  case nib
+  case reuseIdentifier
+  case file
+  case string
+  case id
+}
+
 public struct RswiftCore {
   private let callInformation: CallInformation
 
@@ -29,19 +43,40 @@ public struct RswiftCore {
 
       let resources = Resources(resourceURLs: resourceURLs, fileManager: FileManager.default)
 
+      var structGenerators: [StructGenerator] = []
+      if callInformation.generators.contains(.image) {
+        structGenerators.append(ImageStructGenerator(assetFolders: resources.assetFolders, images: resources.images))
+      }
+      if callInformation.generators.contains(.color) {
+        structGenerators.append(ColorStructGenerator(assetFolders: resources.assetFolders))
+      }
+      if callInformation.generators.contains(.font) {
+        structGenerators.append(FontStructGenerator(fonts: resources.fonts))
+      }
+      if callInformation.generators.contains(.segue) {
+        structGenerators.append(SegueStructGenerator(storyboards: resources.storyboards))
+      }
+      if callInformation.generators.contains(.storyboard) {
+        structGenerators.append(StoryboardStructGenerator(storyboards: resources.storyboards))
+      }
+      if callInformation.generators.contains(.nib) {
+        structGenerators.append(NibStructGenerator(nibs: resources.nibs))
+      }
+      if callInformation.generators.contains(.reuseIdentifier) {
+        structGenerators.append(ReuseIdentifierStructGenerator(reusables: resources.reusables))
+      }
+      if callInformation.generators.contains(.file) {
+        structGenerators.append(ResourceFileStructGenerator(resourceFiles: resources.resourceFiles))
+      }
+      if callInformation.generators.contains(.string) {
+        structGenerators.append(StringsStructGenerator(localizableStrings: resources.localizableStrings, developmentLanguage: xcodeproj.developmentLanguage))
+      }
+      if callInformation.generators.contains(.id) {
+        structGenerators.append(AccessibilityIdentifierStructGenerator(nibs: resources.nibs, storyboards: resources.storyboards))
+      }
+
       // Generate regular R file
-      let fileContents = generateRegularFileContents(resources: resources, generators: [
-        ImageStructGenerator(assetFolders: resources.assetFolders, images: resources.images),
-        ColorStructGenerator(assetFolders: resources.assetFolders),
-        FontStructGenerator(fonts: resources.fonts),
-        SegueStructGenerator(storyboards: resources.storyboards),
-        StoryboardStructGenerator(storyboards: resources.storyboards),
-        NibStructGenerator(nibs: resources.nibs),
-        ReuseIdentifierStructGenerator(reusables: resources.reusables),
-        ResourceFileStructGenerator(resourceFiles: resources.resourceFiles),
-        StringsStructGenerator(localizableStrings: resources.localizableStrings, developmentLanguage: xcodeproj.developmentLanguage),
-        AccessibilityIdentifierStructGenerator(nibs: resources.nibs, storyboards: resources.storyboards),
-      ])
+      let fileContents = generateRegularFileContents(resources: resources, generators: structGenerators)
       writeIfChanged(contents: fileContents, toURL: callInformation.outputURL)
 
       // Generate UITest R file

Sources/rswift/main.swift

@@ -65,6 +65,7 @@ struct EnvironmentKeys {
 
 // Options grouped in struct for readability
 struct CommanderOptions {
+  static let generators = Option("generators", default: "", description: "Only run specified generators, comma seperated")
   static let uiTest = Option("generateUITestFile", default: "", description: "Output path for an extra generated file that contains resources commonly used in UI tests such as accessibility identifiers")
   static let importModules = Option("import", default: "", description: "Add extra modules as import in the generated file, comma seperated")
   static let accessLevel = Option("accessLevel", default: AccessLevel.internalLevel, description: "The access level [public|internal] to use for the generated R-file")
@@ -77,15 +78,35 @@ struct CommanderArguments {
   static let outputPath = Argument<String>("outputPath", description: "Output path for the generated file")
 }
 
+func parseGenerators(_ string: String) -> ([RswiftGenerator], [String]) {
+  var generators: [Generator] = []
+  var unknowns: [String] = []
+
+  let parts = string.components(separatedBy: ",")
+    .map { $0.trimmingCharacters(in: CharacterSet.whitespaces) }
+    .filter { !$0.isEmpty }
+
+  for part in parts {
+    if let generator = RswiftGenerator(rawValue: part) {
+      generators.append(generator)
+    } else {
+      unknowns.append(part)
+    }
+  }
+
+  return (generators, unknowns)
+}
+
 let generate = command(
+  CommanderOptions.generators,
   CommanderOptions.uiTest,
   CommanderOptions.importModules,
   CommanderOptions.accessLevel,
   CommanderOptions.rswiftIgnore,
   CommanderOptions.inputOutputFilesValidation,
 
   CommanderArguments.outputPath
-) { uiTestOutputPath, importModules, accessLevel, rswiftIgnore, inputOutputFilesValidation, outputPath in
+) { generatorNames, uiTestOutputPath, importModules, accessLevel, rswiftIgnore, inputOutputFilesValidation, outputPath in
 
   let processInfo = ProcessInfo()
 
@@ -113,6 +134,16 @@ let generate = command(
   let outputURL = URL(fileURLWithPath: outputPath)
   let uiTestOutputURL = uiTestOutputPath.count > 0 ? URL(fileURLWithPath: uiTestOutputPath) : nil
   let rswiftIgnoreURL = URL(fileURLWithPath: sourceRootPath).appendingPathComponent(rswiftIgnore, isDirectory: false)
+
+  let (knownGenerators, unknownGenerators) = parseGenerators(generatorNames)
+  if !unknownGenerators.isEmpty {
+    warn("Unknown generator options: \(unknownGenerators.joined(separator: ", "))")
+    if knownGenerators.isEmpty {
+      warn("No known generators, falling back to all generators")
+    }
+  }
+  let generators = knownGenerators.isEmpty ? RswiftGenerator.allCases : knownGenerators
+
   let modules = importModules
     .components(separatedBy: ",")
     .map { $0.trimmingCharacters(in: CharacterSet.whitespaces) }
@@ -164,6 +195,7 @@ let generate = command(
     uiTestOutputURL: uiTestOutputURL,
     rswiftIgnoreURL: rswiftIgnoreURL,
 
+    generators: generators,
     accessLevel: accessLevel,
     imports: modules,
 
@@ -186,6 +218,7 @@ let generate = command(
   try RswiftCore(callInformation).run()
 }
 
+
 // Start parsing the launch arguments
 let group = Group()
 group.addCommand("generate", "Generates R.generated.swift file", generate)