Add Files Resource Synthesizer

[mollyIV]

Resolves #3583

Short description 📝

This pull request is adding the support for Files Parser to Resource Synthesizer.

.files(extensions: ["html"])

Example of code generated by the bundled template:

public enum Files {
  public enum FrameworkA {
    public enum Resources {
      public static let exampleHtml = File(name: "example", ext: "html", relativePath: "", mimeType: "text/html")
    }
  }
}

I added a few comments to highlight the most important changes and some to ask questions about the implementation 🙏

Checklist ✅

• The code architecture and patterns are consistent with the rest of the codebase.
• The changes have been tested following the documented guidelines.
• The CHANGELOG.md has been updated to reflect the changes. In case of a breaking change, it's been flagged as such.
• In case the PR introduces changes that affect users, the documentation has been updated.

[mollyIV]

Switched to SwiftGen repository instead of a fork. The reason behind using a fork was that PathKit used to be below 1.0.0 in the main repo that has changed.

[mollyIV]

The template is taken from SwiftGen repository: https://github.com/SwiftGen/SwiftGen/blob/stable/Sources/SwiftGenCLI/templates/files/structured-swift5.stencil

[pepicrft]

@mollyIV would you mind adding that link in a documentation comment?

[mollyIV]

These two lines have been modified slightly in order to make the compiler happy:

- let file = name + (ext.flatMap { ".\($0)" } ?? "")
- fatalError("Could not locate file named \(file)")
+ let file = name + (ext.flatMap { "." + $0 } ?? "")
+ fatalError("Could not locate file named" + file)

[danieleformichelli]

Any idea why the other code was not working? 🤔

[mollyIV]

Basically, the compiler is not happy with it when the content is wrapper into """ """:

let string = """
  let name = "a name"
  print("Hello \(name)" // <-- The compiler will complain saying "Cannot find 'name' in scope"
"""

[danieleformichelli]

I think you just need to escape the \ in this case?

let string = """
  let name = "a name"
  print("Hello \\(name)" // <-- The compiler will complain saying "Cannot find 'name' in scope"
"""

[mollyIV]

That's another way of solving the same problem 👍

[mollyIV]

Unfortunately didn't find existing unit tests for parsers, neither acceptance tests. What's the recommended strategy of parsers / resource synthesizer testing then? 🤔

I performed a manual testing and the files parser is working as expected.

ios_app_with_resources.zip

To test the feature:

1. Download an attached demo project.
2. Generate a project via tuist generate.
3. Open FrameworkA/FrameworkA.xcodeproj.
4. Check if a project compile and Files+FrameworkA.swift content.

Accessing the files:

let exampleHTML = Files.FrameworkA.Resources.exampleHtml
let exampleTXT = Files.FrameworkA.Resources.exampleTxt

[danieleformichelli]

Any idea why the other code was not working? 🤔

[ezraberch]

Unfortunately didn't find existing unit tests for parsers, neither acceptance tests. What's the recommended strategy of parsers / resource synthesizer testing then? 🤔

I've created an acceptance test based on your sample project here: 9af9b0d. This will verify that the project generates and builds. It will also run the project's unit tests, so just replace the placeholder in AppTests.swift with whatever you want.