Added support the existential `any` to `StoryboardType` and `CVarArg` for Swift 5.6 or later. #1056

treastrain · 2023-04-11T16:43:15Z

I've started my branch from the develop branch (gitflow)
- And I've selected develop as the "base" branch for this Pull Request I'm about to create
I've added an entry in the CHANGELOG.md file to explain my changes and credit myself
(or added #trivial to the PR title if I think it doesn't warrant a mention in the CHANGELOG)
- Add the entry in the appropriate section (Bug Fix / New Feature / Breaking Change / Internal Change)
- Add a period and 2 spaces at the end of your short entry description
- Add links to your GitHub profile to credit yourself and to the related PR and issue after your description

Hello, I propose to give StoryboardType and CVarArg the SE-0335 "Introduce existential any" implemented since Swift 5.6.

This avoids the problem with SE-0362 "Piecemeal adoption of upcoming language improvements" implemented since Swift 5.8, where code generated by SwiftGen causes build errors when SE-0335 upcoming feature flag is enabled.

treastrain · 2023-04-11T16:47:42Z

This pull request is for StoryboardType, and it is not necessary to support Images and Colors.

(Thanks @kntkymt! https://twitter.com/kntkymt/status/1645785310377426944)

treastrain · 2023-06-08T18:09:35Z

I found @uhooi's tweet (https://twitter.com/the_uhooi/status/1666836221459595264) and added existential any support for CVarArg to this pull request.

treastrain · 2023-06-08T18:19:02Z

@diogot @djbe @fortmarek @marcelofabri @phatblat
Would you please run the workflow for this pull request and review it?

uhooi · 2023-06-08T23:58:01Z

Plz review and release :)

Amnell · 2023-07-18T10:21:41Z

Close to one year since an accepted PR to the develop branch. Is SwiftGen to be considered dead? :(

treastrain · 2023-08-17T03:13:13Z

@chipp @diogot @djbe @fortmarek @Liquidsoul @marcelofabri @phatblat

Would you please run the checks? Or could you please grant me those permissions?

chipp · 2023-09-01T09:11:15Z

@chipp @diogot @djbe @fortmarek @Liquidsoul @marcelofabri @phatblat

Would you please run the checks? Or could you please grant me those permissions?

I will check later what needs to be done to fix Danger.

chipp · 2023-09-01T09:17:47Z

@AliSoftware Danger needs a bot user, can you create it for the organization, please?

treastrain · 2023-09-05T18:57:50Z

I have made a release of support-existential-any in the repository I forked: https://github.com/treastrain/SwiftGen/releases/tag/support-existential-any

And I pushed my fork on SwiftGenPlugin as well: https://github.com/treastrain/SwiftGenPlugin/tree/support-existential-any

This allows us to use it via the Swift Package Manager plugin as follows:

// swift-tools-version: 5.6

import PackageDescription

let package = Package(
    // ...
    dependencies: [
        // ...
        .package(url: "https://github.com/treastrain/SwiftGenPlugin", branch: "support-existential-any"),
    ],
    targets: [
        // ...
        .executableTarget(
            // ...
            plugins: [
                .plugin(name: "SwiftGenPlugin", package: "SwiftGenPlugin"),
            ]
        ),
    ],
    // ...
)

treastrain · 2023-09-05T19:01:28Z

Those of you with the appropriate authority can quickly review this pull request and make any workarounds I have in place unnecessary by making a new release.

Amnell · 2023-09-12T11:43:21Z

Before we start our move away from SwiftGen due to it obviously being abandoned we've implemented the following in our projects build phase script to mitigate this issue:

sed -i '' 's/args: CVarArg/args: any CVarArg/g' Strings+Generated.swift

It will replace args: CVarArg with args: any CVarArg in supplied files.

This won't cover all use cases of SwiftGen, but it helps with our :)

Liquidsoul

These changes look good to me. I have just a question about some large scope of the #if that may be smaller to reduce the duplicated code in the stencil?

I've updated some env variables that should hopefully fix danger but I could not relaunch the jobs to check that 🤷

As a sidenote, all this work is for all the embedded stencils all this can be fixed by providing your own stencils without doing some ugly sed command in your script while enforcing the format of the generating code in your project.

Thank you all for your work and your patience, I will try to do the best I can to address some blocking issues in the following weeks.

Liquidsoul · 2023-10-25T14:23:25Z

Sources/SwiftGenCLI/templates/strings/flat-swift5.stencil

+  #if swift(>=5.6)
+  private static func tr(_ table: String, _ key: String, _ args: any CVarArg..., fallback value: String) -> String {
+    {% if param.lookupFunction %}
+    let format = {{ param.lookupFunction }}(key, table, value)
+    {% else %}
+    let format = {{param.bundle|default:"BundleToken.bundle"}}.localizedString(forKey: key, value: value, table: table)
+    {% endif %}
+    return String(format: format, locale: Locale.current, arguments: args)
+  }
+  #else


Is it not creating a bit too much duplicated code to maintain here?

Cannot we just limit the #if to the func line?

Something more like this?

Suggested change

#if swift(>=5.6)

private static func tr(_ table: String, _ key: String, _ args: any CVarArg..., fallback value: String) -> String {

{% if param.lookupFunction %}

let format = {{ param.lookupFunction }}(key, table, value)

{% else %}

let format = {{param.bundle|default:"BundleToken.bundle"}}.localizedString(forKey: key, value: value, table: table)

{% endif %}

return String(format: format, locale: Locale.current, arguments: args)

}

#else

#if swift(>=5.6)

private static func tr(_ table: String, _ key: String, _ args: any CVarArg..., fallback value: String) -> String {

#else

private static func tr(_ table: String, _ key: String, _ args: CVarArg..., fallback value: String) -> String {

#endif

I agree with you that there is some strain on its maintenance. However, such a syntax is invalid in Swift.

Liquidsoul · 2023-10-25T14:24:43Z

Sources/SwiftGenCLI/templates/strings/structured-swift5.stencil

+  #if swift(>=5.6)
+  private static func tr(_ table: String, _ key: String, _ args: any CVarArg..., fallback value: String) -> String {
+    {% if param.lookupFunction %}
+    let format = {{ param.lookupFunction }}(key, table, value)
+    {% else %}
+    let format = {{param.bundle|default:"BundleToken.bundle"}}.localizedString(forKey: key, value: value, table: table)
+    {% endif %}
+    return String(format: format, locale: Locale.current, arguments: args)
+  }
+  #else


Same #if scope question here.

Suggested change

#if swift(>=5.6)

private static func tr(_ table: String, _ key: String, _ args: any CVarArg..., fallback value: String) -> String {

{% if param.lookupFunction %}

let format = {{ param.lookupFunction }}(key, table, value)

{% else %}

let format = {{param.bundle|default:"BundleToken.bundle"}}.localizedString(forKey: key, value: value, table: table)

{% endif %}

return String(format: format, locale: Locale.current, arguments: args)

}

#else

#if swift(>=5.6)

private static func tr(_ table: String, _ key: String, _ args: any CVarArg..., fallback value: String) -> String {

#else

private static func tr(_ table: String, _ key: String, _ args: CVarArg..., fallback val

#endif

#1056 (comment)

treastrain

@Liquidsoul I apologize that my reply is very late. Thank you for reviewing!

treastrain · 2024-01-31T08:47:53Z

Sources/SwiftGenCLI/templates/strings/flat-swift5.stencil

+  #if swift(>=5.6)
+  private static func tr(_ table: String, _ key: String, _ args: any CVarArg..., fallback value: String) -> String {
+    {% if param.lookupFunction %}
+    let format = {{ param.lookupFunction }}(key, table, value)
+    {% else %}
+    let format = {{param.bundle|default:"BundleToken.bundle"}}.localizedString(forKey: key, value: value, table: table)
+    {% endif %}
+    return String(format: format, locale: Locale.current, arguments: args)
+  }
+  #else


I agree with you that there is some strain on its maintenance. However, such a syntax is invalid in Swift.

Add the any keyword to StoryboardType for Swift 5.6 or later

8809bab

Add support the existential any to CVarArg for Swift 5.6 or later

a32378a

treastrain changed the title ~~Add support the existential any to StoryboardType for Swift 5.6 or later~~ Added support the existential any to StoryboardType and CVarArg for Swift 5.6 or later. Jun 8, 2023

chipp closed this Sep 1, 2023

chipp reopened this Sep 1, 2023

uhooi mentioned this pull request Sep 5, 2023

Bump Xcode from 14.3.1 to 15.0 RC uhooi/Loki#159

Merged

Liquidsoul reviewed Oct 25, 2023

View reviewed changes

treastrain commented Jan 31, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added support the existential `any` to `StoryboardType` and `CVarArg` for Swift 5.6 or later. #1056

Added support the existential `any` to `StoryboardType` and `CVarArg` for Swift 5.6 or later. #1056

treastrain commented Apr 11, 2023 •

edited

treastrain commented Apr 11, 2023

treastrain commented Jun 8, 2023

treastrain commented Jun 8, 2023

uhooi commented Jun 8, 2023

Amnell commented Jul 18, 2023

treastrain commented Aug 17, 2023

chipp commented Sep 1, 2023

chipp commented Sep 1, 2023

treastrain commented Sep 5, 2023

treastrain commented Sep 5, 2023

Amnell commented Sep 12, 2023

Liquidsoul left a comment

Liquidsoul Oct 25, 2023

treastrain Jan 31, 2024

Liquidsoul Oct 25, 2023

treastrain Jan 31, 2024

treastrain left a comment

treastrain Jan 31, 2024

Added support the existential any to StoryboardType and CVarArg for Swift 5.6 or later. #1056

Are you sure you want to change the base?

Added support the existential any to StoryboardType and CVarArg for Swift 5.6 or later. #1056

Conversation

treastrain commented Apr 11, 2023 • edited

treastrain commented Apr 11, 2023

treastrain commented Jun 8, 2023

treastrain commented Jun 8, 2023

uhooi commented Jun 8, 2023

Amnell commented Jul 18, 2023

treastrain commented Aug 17, 2023

chipp commented Sep 1, 2023

chipp commented Sep 1, 2023

treastrain commented Sep 5, 2023

treastrain commented Sep 5, 2023

Amnell commented Sep 12, 2023

Liquidsoul left a comment

Choose a reason for hiding this comment

Liquidsoul Oct 25, 2023

Choose a reason for hiding this comment

treastrain Jan 31, 2024

Choose a reason for hiding this comment

Liquidsoul Oct 25, 2023

Choose a reason for hiding this comment

treastrain Jan 31, 2024

Choose a reason for hiding this comment

treastrain left a comment

Choose a reason for hiding this comment

treastrain Jan 31, 2024

Choose a reason for hiding this comment

Added support the existential `any` to `StoryboardType` and `CVarArg` for Swift 5.6 or later. #1056

Added support the existential `any` to `StoryboardType` and `CVarArg` for Swift 5.6 or later. #1056

treastrain commented Apr 11, 2023 •

edited