Add deprecation warnings to generated LocalizedStringResource API (#93

) * Emit warnings when using deprecated API * Stop using deprecated API in PluginTests
liamnichols · Jun 9, 2024 · f49794c · f49794c
1 parent 66f8ea2
commit f49794c
Show file tree

Hide file tree

Showing 16 changed files with 66 additions and 322 deletions.
diff --git a/.../LocalizedStringResource/LocalizedStringResourceStringsTableComputedPropertySnippet.swift b/.../LocalizedStringResource/LocalizedStringResourceStringsTableComputedPropertySnippet.swift
@@ -37,11 +37,7 @@ extension LocalizedStringResourceStringsTableComputedPropertySnippet: Snippet {
 
     @AttributeListBuilder
     var attributes: AttributeListSyntax {
-        AttributeSyntax(.identifier("iOS"), deprecated: 100000, message: deprecationMessage)
-        AttributeSyntax(.identifier("macOS"), deprecated: 100000, message: deprecationMessage)
-        AttributeSyntax(.identifier("tvOS"), deprecated: 100000, message: deprecationMessage)
-        AttributeSyntax(.identifier("watchOS"), deprecated: 100000, message: deprecationMessage)
-        AttributeSyntax(.identifier("visionOS"), deprecated: 100000, message: deprecationMessage)
+        AttributeSyntax(.binaryOperator("*"), deprecated: nil, message: deprecationMessage)
     }
 
     @DeclModifierListBuilder

diff --git a/...ingResource/StringsTable/LocalizedStringResourceStringsTableResourceFunctionSnippet.swift b/...ingResource/StringsTable/LocalizedStringResourceStringsTableResourceFunctionSnippet.swift
@@ -35,11 +35,7 @@ struct LocalizedStringResourceStringsTableResourceFunctionSnippet: Snippet {
 
     @AttributeListBuilder
     var attributes: AttributeListSyntax {
-        AttributeSyntax(.identifier("iOS"), deprecated: 100000, message: deprecationMessage)
-        AttributeSyntax(.identifier("macOS"), deprecated: 100000, message: deprecationMessage)
-        AttributeSyntax(.identifier("tvOS"), deprecated: 100000, message: deprecationMessage)
-        AttributeSyntax(.identifier("watchOS"), deprecated: 100000, message: deprecationMessage)
-        AttributeSyntax(.identifier("visionOS"), deprecated: 100000, message: deprecationMessage)
+        AttributeSyntax(.binaryOperator("*"), deprecated: nil, message: deprecationMessage)
     }
 
     @DeclModifierListBuilder

diff --git a/...ingResource/StringsTable/LocalizedStringResourceStringsTableResourceVariableSnippet.swift b/...ingResource/StringsTable/LocalizedStringResourceStringsTableResourceVariableSnippet.swift
@@ -35,11 +35,7 @@ struct LocalizedStringResourceStringsTableResourceVariableSnippet: Snippet {
 
     @AttributeListBuilder
     var attributes: AttributeListSyntax {
-        AttributeSyntax(.identifier("iOS"), deprecated: 100000, message: deprecationMessage)
-        AttributeSyntax(.identifier("macOS"), deprecated: 100000, message: deprecationMessage)
-        AttributeSyntax(.identifier("tvOS"), deprecated: 100000, message: deprecationMessage)
-        AttributeSyntax(.identifier("watchOS"), deprecated: 100000, message: deprecationMessage)
-        AttributeSyntax(.identifier("visionOS"), deprecated: 100000, message: deprecationMessage)
+        AttributeSyntax(.binaryOperator("*"), deprecated: nil, message: deprecationMessage)
     }
 
     @DeclModifierListBuilder

diff --git a/Tests/PluginTests/PluginTests.swift b/Tests/PluginTests/PluginTests.swift
@@ -4,17 +4,13 @@ import XCTest
 
 final class PluginTests: XCTestCase {
     func testPluginGeneratedSources() {
-        XCTAssertEqual(
-            String(localized: .localizable.demoBasic),
-            "A basic string"
-        )
         XCTAssertEqual(
             String(localizable: .demoBasic),
             "A basic string"
         )
 
         XCTAssertEqual(
-            String(localized: .localizable.multiline(2)),
+            String(localized: .localizable(.multiline(2))),
             """
             A string that
             spans 2 lines
@@ -29,7 +25,7 @@ final class PluginTests: XCTestCase {
         )
 
         XCTAssertEqual(
-            String(localized: .featureOne.pluralExample(1)),
+            String(localized: .featureOne(.pluralExample(1))),
             "1 string remaining"
         )
         XCTAssertEqual(
@@ -38,7 +34,7 @@ final class PluginTests: XCTestCase {
         )
 
         XCTAssertEqual(
-            String(localized: .featureOne.pluralExample(10)),
+            String(localized: .featureOne(.pluralExample(10))),
             "10 strings remaining"
         )
         XCTAssertEqual(

diff --git a/Tests/XCStringsToolTests/__Snapshots__/GenerateTests/testGenerate.FormatSpecifiers.swift b/Tests/XCStringsToolTests/__Snapshots__/GenerateTests/testGenerate.FormatSpecifiers.swift
diff --git a/Tests/XCStringsToolTests/__Snapshots__/GenerateTests/testGenerate.Localizable.swift b/Tests/XCStringsToolTests/__Snapshots__/GenerateTests/testGenerate.Localizable.swift
@@ -268,11 +268,7 @@ extension LocalizedStringResource {
         /// ```
         /// Continue
         /// ```
-        @available (iOS, deprecated: 100000, message: "Use `String.Localizable.continue` instead. This property will be removed in the future.")
-        @available (macOS, deprecated: 100000, message: "Use `String.Localizable.continue` instead. This property will be removed in the future.")
-        @available (tvOS, deprecated: 100000, message: "Use `String.Localizable.continue` instead. This property will be removed in the future.")
-        @available (watchOS, deprecated: 100000, message: "Use `String.Localizable.continue` instead. This property will be removed in the future.")
-        @available (visionOS, deprecated: 100000, message: "Use `String.Localizable.continue` instead. This property will be removed in the future.")
+        @available (*, deprecated, message: "Use `String.Localizable.continue` instead. This property will be removed in the future.")
         internal var `continue`: LocalizedStringResource {
             LocalizedStringResource(localizable: .continue)
         }
@@ -284,11 +280,7 @@ extension LocalizedStringResource {
         /// ```
         /// Default Value
         /// ```
-        @available (iOS, deprecated: 100000, message: "Use `String.Localizable.key` instead. This property will be removed in the future.")
-        @available (macOS, deprecated: 100000, message: "Use `String.Localizable.key` instead. This property will be removed in the future.")
-        @available (tvOS, deprecated: 100000, message: "Use `String.Localizable.key` instead. This property will be removed in the future.")
-        @available (watchOS, deprecated: 100000, message: "Use `String.Localizable.key` instead. This property will be removed in the future.")
-        @available (visionOS, deprecated: 100000, message: "Use `String.Localizable.key` instead. This property will be removed in the future.")
+        @available (*, deprecated, message: "Use `String.Localizable.key` instead. This property will be removed in the future.")
         internal var key: LocalizedStringResource {
             LocalizedStringResource(localizable: .key)
         }
@@ -298,11 +290,7 @@ extension LocalizedStringResource {
         /// ```
         /// Multiplatform Original
         /// ```
-        @available (iOS, deprecated: 100000, message: "Use `String.Localizable.myDeviceVariant` instead. This property will be removed in the future.")
-        @available (macOS, deprecated: 100000, message: "Use `String.Localizable.myDeviceVariant` instead. This property will be removed in the future.")
-        @available (tvOS, deprecated: 100000, message: "Use `String.Localizable.myDeviceVariant` instead. This property will be removed in the future.")
-        @available (watchOS, deprecated: 100000, message: "Use `String.Localizable.myDeviceVariant` instead. This property will be removed in the future.")
-        @available (visionOS, deprecated: 100000, message: "Use `String.Localizable.myDeviceVariant` instead. This property will be removed in the future.")
+        @available (*, deprecated, message: "Use `String.Localizable.myDeviceVariant` instead. This property will be removed in the future.")
         internal var myDeviceVariant: LocalizedStringResource {
             LocalizedStringResource(localizable: .myDeviceVariant)
         }
@@ -312,11 +300,7 @@ extension LocalizedStringResource {
         /// ```
         /// I have %lld plurals
         /// ```
-        @available (iOS, deprecated: 100000, message: "Use `String.Localizable.myPlural(_:)` instead. This method will be removed in the future.")
-        @available (macOS, deprecated: 100000, message: "Use `String.Localizable.myPlural(_:)` instead. This method will be removed in the future.")
-        @available (tvOS, deprecated: 100000, message: "Use `String.Localizable.myPlural(_:)` instead. This method will be removed in the future.")
-        @available (watchOS, deprecated: 100000, message: "Use `String.Localizable.myPlural(_:)` instead. This method will be removed in the future.")
-        @available (visionOS, deprecated: 100000, message: "Use `String.Localizable.myPlural(_:)` instead. This method will be removed in the future.")
+        @available (*, deprecated, message: "Use `String.Localizable.myPlural(_:)` instead. This method will be removed in the future.")
         internal func myPlural(_ arg1: Int) -> LocalizedStringResource {
             LocalizedStringResource(localizable: .myPlural(arg1))
         }
@@ -326,21 +310,13 @@ extension LocalizedStringResource {
         /// ```
         /// %lld: People liked %lld posts
         /// ```
-        @available (iOS, deprecated: 100000, message: "Use `String.Localizable.mySubstitute(_:count:)` instead. This method will be removed in the future.")
-        @available (macOS, deprecated: 100000, message: "Use `String.Localizable.mySubstitute(_:count:)` instead. This method will be removed in the future.")
-        @available (tvOS, deprecated: 100000, message: "Use `String.Localizable.mySubstitute(_:count:)` instead. This method will be removed in the future.")
-        @available (watchOS, deprecated: 100000, message: "Use `String.Localizable.mySubstitute(_:count:)` instead. This method will be removed in the future.")
-        @available (visionOS, deprecated: 100000, message: "Use `String.Localizable.mySubstitute(_:count:)` instead. This method will be removed in the future.")
+        @available (*, deprecated, message: "Use `String.Localizable.mySubstitute(_:count:)` instead. This method will be removed in the future.")
         internal func mySubstitute(_ arg1: Int, count arg2: Int) -> LocalizedStringResource {
             LocalizedStringResource(localizable: .mySubstitute(arg1, count: arg2))
         }
     }
 
-    @available (iOS, deprecated: 100000, message: "Use the `localizable(_:)` static method instead. This property will be removed in the future.")
-    @available (macOS, deprecated: 100000, message: "Use the `localizable(_:)` static method instead. This property will be removed in the future.")
-    @available (tvOS, deprecated: 100000, message: "Use the `localizable(_:)` static method instead. This property will be removed in the future.")
-    @available (watchOS, deprecated: 100000, message: "Use the `localizable(_:)` static method instead. This property will be removed in the future.")
-    @available (visionOS, deprecated: 100000, message: "Use the `localizable(_:)` static method instead. This property will be removed in the future.") internal static let localizable = Localizable()
+    @available (*, deprecated, message: "Use the `localizable(_:)` static method instead. This property will be removed in the future.") internal static let localizable = Localizable()
 
     internal init(localizable: String.Localizable) {
         self.init(

diff --git a/Tests/XCStringsToolTests/__Snapshots__/GenerateTests/testGenerate.Multiline.swift b/Tests/XCStringsToolTests/__Snapshots__/GenerateTests/testGenerate.Multiline.swift
@@ -215,21 +215,13 @@ extension LocalizedStringResource {
         /// - Two
         /// - Three
         /// ```
-        @available (iOS, deprecated: 100000, message: "Use `String.Multiline.multiline` instead. This property will be removed in the future.")
-        @available (macOS, deprecated: 100000, message: "Use `String.Multiline.multiline` instead. This property will be removed in the future.")
-        @available (tvOS, deprecated: 100000, message: "Use `String.Multiline.multiline` instead. This property will be removed in the future.")
-        @available (watchOS, deprecated: 100000, message: "Use `String.Multiline.multiline` instead. This property will be removed in the future.")
-        @available (visionOS, deprecated: 100000, message: "Use `String.Multiline.multiline` instead. This property will be removed in the future.")
+        @available (*, deprecated, message: "Use `String.Multiline.multiline` instead. This property will be removed in the future.")
         internal var multiline: LocalizedStringResource {
             LocalizedStringResource(multiline: .multiline)
         }
     }
 
-    @available (iOS, deprecated: 100000, message: "Use the `multiline(_:)` static method instead. This property will be removed in the future.")
-    @available (macOS, deprecated: 100000, message: "Use the `multiline(_:)` static method instead. This property will be removed in the future.")
-    @available (tvOS, deprecated: 100000, message: "Use the `multiline(_:)` static method instead. This property will be removed in the future.")
-    @available (watchOS, deprecated: 100000, message: "Use the `multiline(_:)` static method instead. This property will be removed in the future.")
-    @available (visionOS, deprecated: 100000, message: "Use the `multiline(_:)` static method instead. This property will be removed in the future.") internal static let multiline = Multiline()
+    @available (*, deprecated, message: "Use the `multiline(_:)` static method instead. This property will be removed in the future.") internal static let multiline = Multiline()
 
     internal init(multiline: String.Multiline) {
         self.init(

diff --git a/Tests/XCStringsToolTests/__Snapshots__/GenerateTests/testGenerate.Positional.swift b/Tests/XCStringsToolTests/__Snapshots__/GenerateTests/testGenerate.Positional.swift
@@ -244,11 +244,7 @@ extension LocalizedStringResource {
         /// ```
         /// Second: %2$@ - First: %1$lld
         /// ```
-        @available (iOS, deprecated: 100000, message: "Use `String.Positional.reorder(_:_:)` instead. This method will be removed in the future.")
-        @available (macOS, deprecated: 100000, message: "Use `String.Positional.reorder(_:_:)` instead. This method will be removed in the future.")
-        @available (tvOS, deprecated: 100000, message: "Use `String.Positional.reorder(_:_:)` instead. This method will be removed in the future.")
-        @available (watchOS, deprecated: 100000, message: "Use `String.Positional.reorder(_:_:)` instead. This method will be removed in the future.")
-        @available (visionOS, deprecated: 100000, message: "Use `String.Positional.reorder(_:_:)` instead. This method will be removed in the future.")
+        @available (*, deprecated, message: "Use `String.Positional.reorder(_:_:)` instead. This method will be removed in the future.")
         internal func reorder(_ arg1: Int, _ arg2: String) -> LocalizedStringResource {
             LocalizedStringResource(positional: .reorder(arg1, arg2))
         }
@@ -260,11 +256,7 @@ extension LocalizedStringResource {
         /// ```
         /// %1$lld, I repeat: %1$lld
         /// ```
-        @available (iOS, deprecated: 100000, message: "Use `String.Positional.repeatExplicit(_:)` instead. This method will be removed in the future.")
-        @available (macOS, deprecated: 100000, message: "Use `String.Positional.repeatExplicit(_:)` instead. This method will be removed in the future.")
-        @available (tvOS, deprecated: 100000, message: "Use `String.Positional.repeatExplicit(_:)` instead. This method will be removed in the future.")
-        @available (watchOS, deprecated: 100000, message: "Use `String.Positional.repeatExplicit(_:)` instead. This method will be removed in the future.")
-        @available (visionOS, deprecated: 100000, message: "Use `String.Positional.repeatExplicit(_:)` instead. This method will be removed in the future.")
+        @available (*, deprecated, message: "Use `String.Positional.repeatExplicit(_:)` instead. This method will be removed in the future.")
         internal func repeatExplicit(_ arg1: Int) -> LocalizedStringResource {
             LocalizedStringResource(positional: .repeatExplicit(arg1))
         }
@@ -276,21 +268,13 @@ extension LocalizedStringResource {
         /// ```
         /// %@, are you there? %1$@?
         /// ```
-        @available (iOS, deprecated: 100000, message: "Use `String.Positional.repeatImplicit(_:)` instead. This method will be removed in the future.")
-        @available (macOS, deprecated: 100000, message: "Use `String.Positional.repeatImplicit(_:)` instead. This method will be removed in the future.")
-        @available (tvOS, deprecated: 100000, message: "Use `String.Positional.repeatImplicit(_:)` instead. This method will be removed in the future.")
-        @available (watchOS, deprecated: 100000, message: "Use `String.Positional.repeatImplicit(_:)` instead. This method will be removed in the future.")
-        @available (visionOS, deprecated: 100000, message: "Use `String.Positional.repeatImplicit(_:)` instead. This method will be removed in the future.")
+        @available (*, deprecated, message: "Use `String.Positional.repeatImplicit(_:)` instead. This method will be removed in the future.")
         internal func repeatImplicit(_ arg1: String) -> LocalizedStringResource {
             LocalizedStringResource(positional: .repeatImplicit(arg1))
         }
     }
 
-    @available (iOS, deprecated: 100000, message: "Use the `positional(_:)` static method instead. This property will be removed in the future.")
-    @available (macOS, deprecated: 100000, message: "Use the `positional(_:)` static method instead. This property will be removed in the future.")
-    @available (tvOS, deprecated: 100000, message: "Use the `positional(_:)` static method instead. This property will be removed in the future.")
-    @available (watchOS, deprecated: 100000, message: "Use the `positional(_:)` static method instead. This property will be removed in the future.")
-    @available (visionOS, deprecated: 100000, message: "Use the `positional(_:)` static method instead. This property will be removed in the future.") internal static let positional = Positional()
+    @available (*, deprecated, message: "Use the `positional(_:)` static method instead. This property will be removed in the future.") internal static let positional = Positional()
 
     internal init(positional: String.Positional) {
         self.init(

diff --git a/Tests/XCStringsToolTests/__Snapshots__/GenerateTests/testGenerate.Simple.swift b/Tests/XCStringsToolTests/__Snapshots__/GenerateTests/testGenerate.Simple.swift
@@ -205,21 +205,13 @@ extension LocalizedStringResource {
         /// ```
         /// My Value
         /// ```
-        @available (iOS, deprecated: 100000, message: "Use `String.Simple.simpleKey` instead. This property will be removed in the future.")
-        @available (macOS, deprecated: 100000, message: "Use `String.Simple.simpleKey` instead. This property will be removed in the future.")
-        @available (tvOS, deprecated: 100000, message: "Use `String.Simple.simpleKey` instead. This property will be removed in the future.")
-        @available (watchOS, deprecated: 100000, message: "Use `String.Simple.simpleKey` instead. This property will be removed in the future.")
-        @available (visionOS, deprecated: 100000, message: "Use `String.Simple.simpleKey` instead. This property will be removed in the future.")
+        @available (*, deprecated, message: "Use `String.Simple.simpleKey` instead. This property will be removed in the future.")
         internal var simpleKey: LocalizedStringResource {
             LocalizedStringResource(simple: .simpleKey)
         }
     }
 
-    @available (iOS, deprecated: 100000, message: "Use the `simple(_:)` static method instead. This property will be removed in the future.")
-    @available (macOS, deprecated: 100000, message: "Use the `simple(_:)` static method instead. This property will be removed in the future.")
-    @available (tvOS, deprecated: 100000, message: "Use the `simple(_:)` static method instead. This property will be removed in the future.")
-    @available (watchOS, deprecated: 100000, message: "Use the `simple(_:)` static method instead. This property will be removed in the future.")
-    @available (visionOS, deprecated: 100000, message: "Use the `simple(_:)` static method instead. This property will be removed in the future.") internal static let simple = Simple()
+    @available (*, deprecated, message: "Use the `simple(_:)` static method instead. This property will be removed in the future.") internal static let simple = Simple()
 
     internal init(simple: String.Simple) {
         self.init(