Merge pull request #91 from MercuryTechnologies/kb/public-swift

kylebshr · web-flow · commit 34aaacd253c4 · 2024-11-20T12:42:44.000-08:00
Make swift types public and deprecations prettier
diff --git a/.golden/swiftAdvancedEnumSpec/golden b/.golden/swiftAdvancedEnumSpec/golden
@@ -1,4 +1,4 @@
-enum Enum: CaseIterable, Hashable, Codable {
+public enum Enum: CaseIterable, Hashable, Codable {
     case a
     case b
     case c
diff --git a/.golden/swiftAdvancedEnumWithRawValueSpec/golden b/.golden/swiftAdvancedEnumWithRawValueSpec/golden
@@ -1,4 +1,4 @@
-enum Enum: String, CaseIterable, Hashable, Codable {
+public enum Enum: String, CaseIterable, Hashable, Codable {
     case a
     case b
 }
diff --git a/.golden/swiftAdvancedNewtypeSpec/golden b/.golden/swiftAdvancedNewtypeSpec/golden
@@ -1,4 +1,4 @@
-struct Newtype: CaseIterable, Hashable, Codable {
-    typealias NewtypeTag = Tagged<Newtype, String>
-    let value: NewtypeTag
+public struct Newtype: CaseIterable, Hashable, Codable {
+    public typealias NewtypeTag = Tagged<Newtype, String>
+    public let value: NewtypeTag
 }
diff --git a/.golden/swiftAdvancedNewtypeWithEnumFieldSpec/golden b/.golden/swiftAdvancedNewtypeWithEnumFieldSpec/golden
@@ -1,3 +1,3 @@
-struct Newtype {
-    var newtypeField: Enum
+public struct Newtype {
+    public var newtypeField: Enum
 }
diff --git a/.golden/swiftAdvancedRecordSpec/golden b/.golden/swiftAdvancedRecordSpec/golden
@@ -1,4 +1,4 @@
-struct Data: CaseIterable, Hashable, Codable {
-    var field0: Int
-    var field1: Int?
+public struct Data: CaseIterable, Hashable, Codable {
+    public var field0: Int
+    public var field1: Int?
 }
diff --git a/.golden/swiftBasicDocSpec/golden b/.golden/swiftBasicDocSpec/golden
@@ -27,9 +27,9 @@
 ///         guard n != 0, n != 1 else { return n }
 ///         return fibonacci(n - 1) + fibonacci(n - 2)
 ///     }
-struct Data {
+public struct Data {
     /// First field, it's an Int
-    var first: Int
+    public var first: Int
     /// Second field, it's maybe an Int
-    var second: Int?
+    public var second: Int?
 }
diff --git a/.golden/swiftBasicEnumSpec/golden b/.golden/swiftBasicEnumSpec/golden
@@ -1,4 +1,4 @@
-enum Enum {
+public enum Enum {
     case a
     case b
     case c
diff --git a/.golden/swiftBasicEnumWithRawValueSpec/golden b/.golden/swiftBasicEnumWithRawValueSpec/golden
@@ -1,4 +1,4 @@
-enum Enum {
+public enum Enum {
     case a
     case b
 }
diff --git a/.golden/swiftBasicNewtypeJoinOptionalsSpec/golden b/.golden/swiftBasicNewtypeJoinOptionalsSpec/golden
@@ -1,4 +1,4 @@
-struct Newtype {
-    typealias NewtypeTag = Tagged<Newtype, Int?>
-    let value: NewtypeTag?
+public struct Newtype {
+    public typealias NewtypeTag = Tagged<Newtype, Int?>
+    public let value: NewtypeTag?
 }
diff --git a/.golden/swiftBasicNewtypeSpec/golden b/.golden/swiftBasicNewtypeSpec/golden
@@ -1,4 +1,4 @@
-struct Newtype {
-    typealias NewtypeTag = Tagged<Newtype, String>
-    let value: NewtypeTag
+public struct Newtype {
+    public typealias NewtypeTag = Tagged<Newtype, String>
+    public let value: NewtypeTag
 }
diff --git a/.golden/swiftBasicNewtypeWithConcreteFieldSpec/golden b/.golden/swiftBasicNewtypeWithConcreteFieldSpec/golden
@@ -1,3 +1,3 @@
-struct Newtype {
-    var newtypeField: String
+public struct Newtype {
+    public var newtypeField: String
 }
diff --git a/.golden/swiftBasicNewtypeWithEitherFieldSpec/golden b/.golden/swiftBasicNewtypeWithEitherFieldSpec/golden
@@ -1,3 +1,3 @@
-struct Newtype {
-    var newtypeField: Result<Int, String>
+public struct Newtype {
+    public var newtypeField: Result<Int, String>
 }
diff --git a/.golden/swiftBasicRecordSpec/golden b/.golden/swiftBasicRecordSpec/golden
@@ -1,4 +1,4 @@
-struct Data {
-    var field0: Int
-    var field1: Int?
+public struct Data {
+    public var field0: Int
+    public var field1: Int?
 }
diff --git a/.golden/swiftDataSingleNullarySpec/golden b/.golden/swiftDataSingleNullarySpec/golden
@@ -1 +1 @@
-struct Data: Hashable, Codable {}
+public struct Data: Hashable, Codable {}
diff --git a/.golden/swiftDataSingleNullaryWithTypeVariableSpec/golden b/.golden/swiftDataSingleNullaryWithTypeVariableSpec/golden
@@ -1 +1 @@
-struct Data<A: Hashable & Codable>: Hashable, Codable {}
+public struct Data<A: Hashable & Codable>: Hashable, Codable {}
diff --git a/.golden/swiftDeprecatedFieldSpec/golden b/.golden/swiftDeprecatedFieldSpec/golden
@@ -1,5 +1,5 @@
-struct Data {
-    var field0: Int
-// Deprecated since build 500
-//    var field1: Int?
+public struct Data {
+    public var field0: Int
+    // Deprecated since build 500
+    // public var field1: Int?
 }
diff --git a/.golden/swiftEnumSumOfProductDocSpec/golden b/.golden/swiftEnumSumOfProductDocSpec/golden
@@ -1,16 +1,16 @@
 /// Top-level documentation describing ``Enum``.
-enum Enum: CaseIterable, Hashable, Codable {
+public enum Enum: CaseIterable, Hashable, Codable {
     /// A constructor.
     case dataCons0(Record0)
     /// Another constructor.
     case dataCons1(Record1)
 
-    enum CodingKeys: String, CodingKey {
+    public enum CodingKeys: String, CodingKey {
         case tag
         case contents
     }
 
-    init(from decoder: any Decoder) throws {
+    public init(from decoder: any Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)
         let discriminator = try container.decode(String.self, forKey: .tag)
         switch discriminator {
@@ -26,7 +26,7 @@ enum Enum: CaseIterable, Hashable, Codable {
         }
     }
 
-    func encode(to encoder: any Encoder) throws {
+    public func encode(to encoder: any Encoder) throws {
         var container = encoder.container(keyedBy: CodingKeys.self)
         switch (self) {
             case let .dataCons0(contents):
diff --git a/.golden/swiftEnumSumOfProductSpec/golden b/.golden/swiftEnumSumOfProductSpec/golden
@@ -1,16 +1,16 @@
-enum Enum: Hashable, Codable {
+public enum Enum: Hashable, Codable {
     case dataCons0(_ enumField0: Int, _ enumField1: Int)
     case dataCons1(_ enumField2: String, _ enumField3: String)
 
-    enum CodingKeys: String, CodingKey {
+    public enum CodingKeys: String, CodingKey {
         case tag
         case enumField0
         case enumField1
         case enumField2
         case enumField3
     }
 
-    init(from decoder: any Decoder) throws {
+    public init(from decoder: any Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)
         let discriminator = try container.decode(String.self, forKey: .tag)
         switch discriminator {
@@ -32,7 +32,7 @@ enum Enum: Hashable, Codable {
         }
     }
 
-    func encode(to encoder: any Encoder) throws {
+    public func encode(to encoder: any Encoder) throws {
         var container = encoder.container(keyedBy: CodingKeys.self)
         switch (self) {
             case let .dataCons0:
diff --git a/.golden/swiftEnumSumOfProductWithNameCollisionSpec/golden b/.golden/swiftEnumSumOfProductWithNameCollisionSpec/golden
@@ -1,14 +1,14 @@
-enum Enum: Codable {
+public enum Enum: Codable {
     case record0(Record0)
     case record1(Record1)
     case record2
 
-    enum CodingKeys: String, CodingKey {
+    public enum CodingKeys: String, CodingKey {
         case tag
         case contents
     }
 
-    init(from decoder: any Decoder) throws {
+    public init(from decoder: any Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)
         let discriminator = try container.decode(String.self, forKey: .tag)
         switch discriminator {
@@ -26,7 +26,7 @@ enum Enum: Codable {
         }
     }
 
-    func encode(to encoder: any Encoder) throws {
+    public func encode(to encoder: any Encoder) throws {
         var container = encoder.container(keyedBy: CodingKeys.self)
         switch (self) {
             case let .record0(contents):
diff --git a/.golden/swiftEnumSumOfProductWithTaggedFlatObjectStyleSpec/golden b/.golden/swiftEnumSumOfProductWithTaggedFlatObjectStyleSpec/golden
@@ -1,14 +1,14 @@
-enum Enum: Codable {
+public enum Enum: Codable {
     case dataCons0(Record0)
     case dataCons1(Record1)
     case dataCons2
     case _unknown
 
-    enum CodingKeys: String, CodingKey {
+    public enum CodingKeys: String, CodingKey {
         case tag
     }
 
-    init(from decoder: any Decoder) throws {
+    public init(from decoder: any Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)
         let discriminator = try container.decode(String.self, forKey: .tag)
         switch discriminator {
@@ -23,7 +23,7 @@ enum Enum: Codable {
         }
     }
 
-    func encode(to encoder: any Encoder) throws {
+    public func encode(to encoder: any Encoder) throws {
         var container = encoder.container(keyedBy: CodingKeys.self)
         switch (self) {
             case let .dataCons0(value):
diff --git a/.golden/swiftEnumSumOfProductWithTaggedObjectStyleSpec/golden b/.golden/swiftEnumSumOfProductWithTaggedObjectStyleSpec/golden
@@ -1,14 +1,14 @@
-enum Enum: Codable {
+public enum Enum: Codable {
     case dataCons0(Record0)
     case dataCons1(Record1)
     case dataCons2
 
-    enum CodingKeys: String, CodingKey {
+    public enum CodingKeys: String, CodingKey {
         case tag
         case contents
     }
 
-    init(from decoder: any Decoder) throws {
+    public init(from decoder: any Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)
         let discriminator = try container.decode(String.self, forKey: .tag)
         switch discriminator {
@@ -26,7 +26,7 @@ enum Enum: Codable {
         }
     }
 
-    func encode(to encoder: any Encoder) throws {
+    public func encode(to encoder: any Encoder) throws {
         var container = encoder.container(keyedBy: CodingKeys.self)
         switch (self) {
             case let .dataCons0(contents):
diff --git a/.golden/swiftEnumValueClassDocSpec/golden b/.golden/swiftEnumValueClassDocSpec/golden
@@ -1,5 +1,5 @@
 /// Top-level enum documentation.
-enum EnumAsValueClass: CaseIterable, Hashable, Codable {
+public enum EnumAsValueClass: CaseIterable, Hashable, Codable {
     /// ``First``
     case first
     /// ``Second``
diff --git a/.golden/swiftEnumValueClassSpec/golden b/.golden/swiftEnumValueClassSpec/golden
@@ -1,4 +1,4 @@
-enum EnumAsValueClass: CaseIterable, Hashable, Codable {
+public enum EnumAsValueClass: CaseIterable, Hashable, Codable {
     case first
     case second
     case third
diff --git a/.golden/swiftGenericAliasSpec/golden b/.golden/swiftGenericAliasSpec/golden
@@ -1 +1 @@
-typealias TreeResponse = Tree
+public typealias TreeResponse = Tree
diff --git a/.golden/swiftGenericNewtypeSpec/golden b/.golden/swiftGenericNewtypeSpec/golden
@@ -1,4 +1,4 @@
-struct LTree<A: Hashable & Codable>: Hashable, Codable {
-    typealias LTreeTag = Tagged<LTree, [A]>
-    let value: LTreeTag
+public struct LTree<A: Hashable & Codable>: Hashable, Codable {
+    public typealias LTreeTag = Tagged<LTree, [A]>
+    public let value: LTreeTag
 }
diff --git a/.golden/swiftGenericStructSpec/golden b/.golden/swiftGenericStructSpec/golden
@@ -1,4 +1,4 @@
-struct Tree<A: Hashable & Codable>: Hashable, Codable {
-    var rootLabel: A
-    var subForest: [Tree<A>]
+public struct Tree<A: Hashable & Codable>: Hashable, Codable {
+    public var rootLabel: A
+    public var subForest: [Tree<A>]
 }
diff --git a/.golden/swiftMultipleTypeVariableSpec/golden b/.golden/swiftMultipleTypeVariableSpec/golden
@@ -1,4 +1,4 @@
-struct Data<A: Hashable & Codable, B: Hashable & Codable>: CaseIterable, Hashable, Codable {
-    var field0: A
-    var field1: B
+public struct Data<A: Hashable & Codable, B: Hashable & Codable>: CaseIterable, Hashable, Codable {
+    public var field0: A
+    public var field1: B
 }
diff --git a/.golden/swiftRecord0DuplicateRecordFieldSpec/golden b/.golden/swiftRecord0DuplicateRecordFieldSpec/golden
@@ -1,6 +1,6 @@
 /// Record 0 with duplicate fields
-struct Data0 {
-    var field0: Int
+public struct Data0 {
+    public var field0: Int
     /// not a duplicate
-    var field1: Int?
+    public var field1: Int?
 }
diff --git a/.golden/swiftRecord0SumOfProductDocSpec/golden b/.golden/swiftRecord0SumOfProductDocSpec/golden
@@ -1,7 +1,7 @@
 /// Documentation for ``Record0``.
-struct Record0: CaseIterable, Hashable, Codable {
+public struct Record0: CaseIterable, Hashable, Codable {
     /// The zeroth field of record 0
-    var record0Field0: Int
+    public var record0Field0: Int
     /// The first field of record 0
-    var record0Field1: Int
+    public var record0Field1: Int
 }
diff --git a/.golden/swiftRecord0SumOfProductWithTaggedFlatObjectStyleSpec/golden b/.golden/swiftRecord0SumOfProductWithTaggedFlatObjectStyleSpec/golden
@@ -1,4 +1,4 @@
-struct Record0: Codable {
-    var record0Field0: Int
-    var record0Field1: Int
+public struct Record0: Codable {
+    public var record0Field0: Int
+    public var record0Field1: Int
 }
diff --git a/.golden/swiftRecord0SumOfProductWithTaggedObjectStyleSpec/golden b/.golden/swiftRecord0SumOfProductWithTaggedObjectStyleSpec/golden
@@ -1,4 +1,4 @@
-struct Record0: Codable {
-    var record0Field0: Int
-    var record0Field1: Int
+public struct Record0: Codable {
+    public var record0Field0: Int
+    public var record0Field1: Int
 }
diff --git a/.golden/swiftRecord1DuplicateRecordFieldSpec/golden b/.golden/swiftRecord1DuplicateRecordFieldSpec/golden
@@ -1,6 +1,6 @@
 /// Record 1 with duplicate fields
-struct Data1 {
-    var field0: String
+public struct Data1 {
+    public var field0: String
     /// not a duplicate
-    var field2: String?
+    public var field2: String?
 }
diff --git a/.golden/swiftRecord1SumOfProductDocSpec/golden b/.golden/swiftRecord1SumOfProductDocSpec/golden
@@ -1,7 +1,7 @@
 /// Documentation for ``Record1``.
-struct Record1: CaseIterable, Hashable, Codable {
+public struct Record1: CaseIterable, Hashable, Codable {
     /// The zeroth field of record 1
-    var record1Field0: Int
+    public var record1Field0: Int
     /// The first field of record 1
-    var record1Field1: Int
+    public var record1Field1: Int
 }
diff --git a/.golden/swiftRecord1SumOfProductWithTaggedFlatObjectStyleSpec/golden b/.golden/swiftRecord1SumOfProductWithTaggedFlatObjectStyleSpec/golden
@@ -1,4 +1,4 @@
-struct Record1: Codable {
-    var record1Field0: Int
-    var record1Field1: Int
+public struct Record1: Codable {
+    public var record1Field0: Int
+    public var record1Field1: Int
 }
diff --git a/.golden/swiftRecord1SumOfProductWithTaggedObjectStyleSpec/golden b/.golden/swiftRecord1SumOfProductWithTaggedObjectStyleSpec/golden
@@ -1,4 +1,4 @@
-struct Record1: Codable {
-    var record1Field0: Int
-    var record1Field1: Int
+public struct Record1: Codable {
+    public var record1Field0: Int
+    public var record1Field1: Int
 }
diff --git a/.golden/swiftStrictEnumsSpec-EnumA/golden b/.golden/swiftStrictEnumsSpec-EnumA/golden
@@ -1,3 +1,3 @@
-enum EnumA {
+public enum EnumA {
     case enumFirst
 }
diff --git a/.golden/swiftStrictEnumsSpec-EnumB/golden b/.golden/swiftStrictEnumsSpec-EnumB/golden
diff --git a/.golden/swiftStrictFieldsCheck-RecordA/golden b/.golden/swiftStrictFieldsCheck-RecordA/golden
diff --git a/.golden/swiftStrictFieldsCheck-RecordB/golden b/.golden/swiftStrictFieldsCheck-RecordB/golden
diff --git a/.golden/swiftSumOfProductWithTypeParameterSpec/golden b/.golden/swiftSumOfProductWithTypeParameterSpec/golden
diff --git a/.golden/swiftTypeVariableSpec/golden b/.golden/swiftTypeVariableSpec/golden
diff --git a/flake.lock b/flake.lock
diff --git a/flake.nix b/flake.nix
diff --git a/nix/cmark-gfm-cabal.patch b/nix/cmark-gfm-cabal.patch
diff --git a/src/Moat/Pretty/Kotlin.hs b/src/Moat/Pretty/Kotlin.hs
diff --git a/src/Moat/Pretty/Swift.hs b/src/Moat/Pretty/Swift.hs

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-enum Enum: CaseIterable, Hashable, Codable {`
	`1`	`+public enum Enum: CaseIterable, Hashable, Codable {`
`2`	`2`	`case a`
`3`	`3`	`case b`
`4`	`4`	`case c`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-enum Enum: String, CaseIterable, Hashable, Codable {`
	`1`	`+public enum Enum: String, CaseIterable, Hashable, Codable {`
`2`	`2`	`case a`
`3`	`3`	`case b`
`4`	`4`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-struct Newtype: CaseIterable, Hashable, Codable {`
`2`		`- typealias NewtypeTag = Tagged<Newtype, String>`
`3`		`- let value: NewtypeTag`
	`1`	`+public struct Newtype: CaseIterable, Hashable, Codable {`
	`2`	`+ public typealias NewtypeTag = Tagged<Newtype, String>`
	`3`	`+ public let value: NewtypeTag`
`4`	`4`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`		`-struct Newtype {`
`2`		`- var newtypeField: Enum`
	`1`	`+public struct Newtype {`
	`2`	`+ public var newtypeField: Enum`
`3`	`3`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-struct Data: CaseIterable, Hashable, Codable {`
`2`		`- var field0: Int`
`3`		`- var field1: Int?`
	`1`	`+public struct Data: CaseIterable, Hashable, Codable {`
	`2`	`+ public var field0: Int`
	`3`	`+ public var field1: Int?`
`4`	`4`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-enum Enum {`
	`1`	`+public enum Enum {`
`2`	`2`	`case a`
`3`	`3`	`case b`
`4`	`4`	`case c`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`		`-struct Newtype {`
`2`		`- var newtypeField: String`
	`1`	`+public struct Newtype {`
	`2`	`+ public var newtypeField: String`
`3`	`3`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`		`-struct Newtype {`
`2`		`- var newtypeField: Result<Int, String>`
	`1`	`+public struct Newtype {`
	`2`	`+ public var newtypeField: Result<Int, String>`
`3`	`3`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-struct Data {`
`2`		`- var field0: Int`
`3`		`- var field1: Int?`
	`1`	`+public struct Data {`
	`2`	`+ public var field0: Int`
	`3`	`+ public var field1: Int?`
`4`	`4`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-struct Data: Hashable, Codable {}`
	`1`	`+public struct Data: Hashable, Codable {}`