How to use a custom resource synthesizer template file

hisaac · March 25, 2025, 12:49pm

I have a custom template file that I’d like to use for generating Swift from the .strings files in my project. I see in the Tuist code here that there’s reference to an initializer that takes a templatePath argument:

github.com/tuist/tuist

Sources/ProjectDescription/ResourceSynthesizer.swift

a52cb4b78


      
          /// A resource synthesizer for given file extensions.
          ///
          /// For example to synthesize resource accessors for strings, you can use:
          /// - `.strings()` for tuist's default
          /// - `.strings(parserOptions: ["separator": "/"])` to use strings template with SwiftGen Parser Options
          /// - `.strings(plugin: "MyPlugin")` to use strings template from a plugin
          /// - `.strings(templatePath: "Templates/Strings.stencil")` to use strings template at a given path
          public struct ResourceSynthesizer: Codable, Equatable, Sendable { // swiftlint:disable:this type_body_length
              /// Templates can be of multiple types
              public var templateType: TemplateType
              public var parser: Parser
              public var parserOptions: [String: Parser.Option]
              public var extensions: Set<String>
          
              /// Templates can be either a local template file, from a plugin, or a default template from tuist
              public enum TemplateType: Codable, Equatable, Sendable {
                  /// Plugin template file

It doesn’t appear that that initializer exists though. Is there another way to provide a path to a template to use for code generation?

marekfort · March 28, 2025, 10:28am

Hey

Yeah, as it seems, the API for that is, indeed, missing. What you can do is to reference a local plugin like this fixture: tuist/fixtures/app_with_plugins/Tuist/Config.swift at 4a56368a98662814b56054da986ddb5a9d275eec · tuist/tuist · GitHub

However, I agree adding support for this would make sense. We’d need to resolve the path here and update the ProjectDescription definition if you feel like contributing to this one.