Added #if availability check to all ApolloCodeGenLib sources to prevent compilation on other platforms. This previously caused an issue that prevented SwiftUI previews on iOS targets from working properly, if that target included Apollo as a dependency.

Tiziano Coroneo · Tiziano Coroneo · commit 9aff8122e0cf · 2020-03-05T14:08:25.000+01:00
diff --git a/Sources/ApolloCodegenLib/ASTEnumValue.swift b/Sources/ApolloCodegenLib/ASTEnumValue.swift
@@ -1,5 +1,8 @@
 import Foundation
 
+// Only available on macOS
+#if os(macOS)
+
 class ASTEnumValue: Codable {
   /// The raw name of the enum value
   let name: String
@@ -10,3 +13,5 @@ class ASTEnumValue: Codable {
   /// If the enum value is deprecated.
   let isDeprecated: Bool
 }
+
+#endif
diff --git a/Sources/ApolloCodegenLib/ASTField.swift b/Sources/ApolloCodegenLib/ASTField.swift
@@ -1,5 +1,8 @@
 import Foundation
 
+// Only available on macOS
+#if os(macOS)
+
 /// A field with data on any item.
 class ASTField: Codable {
   
@@ -45,3 +48,5 @@ class ASTField: Codable {
   /// [optional] Any Fragments defined inline at this level
   let inlineFragments: [ASTInlineFragment]?
 }
+
+#endif
diff --git a/Sources/ApolloCodegenLib/ASTFragment.swift b/Sources/ApolloCodegenLib/ASTFragment.swift
@@ -1,5 +1,8 @@
 import Foundation
 
+// Only available on macOS
+#if os(macOS)
+
 /// A resuable fragment to generate code for
 class ASTFragment: Codable {
   /// The primary type the fragment is defined on
@@ -41,3 +44,5 @@ class ASTInlineFragment: Codable {
   /// The names of any named fragments at this level of the fragment.
   let fragmentSpreads: [String]
 }
+
+#endif
diff --git a/Sources/ApolloCodegenLib/ASTOperation.swift b/Sources/ApolloCodegenLib/ASTOperation.swift
@@ -1,5 +1,8 @@
 import Foundation
 
+// Only available on macOS
+#if os(macOS)
+
 /// The representation of a single operation defined in a .graphql file.
 class ASTOperation: Codable {
   
@@ -55,3 +58,5 @@ class ASTOperation: Codable {
   /// [optional] The calculated ID for the operation. Will only be generated if `operationIDsURL` is passed into `ApolloCodegenOptions`.`
   let operationId: String?
 }
+
+#endif
diff --git a/Sources/ApolloCodegenLib/ASTOutput.swift b/Sources/ApolloCodegenLib/ASTOutput.swift
@@ -1,5 +1,8 @@
 import Foundation
 
+// Only available on macOS
+#if os(macOS)
+
 /// The top-level output of the AST generator
 class ASTOutput: Codable {
   /// An array of all operations to generate code for.
@@ -11,3 +14,5 @@ class ASTOutput: Codable {
   /// An array of "all" types used <-- TODO: Figure out why some are not in here
   let typesUsed: [ASTTypeUsed]
 }
+
+#endif
diff --git a/Sources/ApolloCodegenLib/ASTTypeUsed.swift b/Sources/ApolloCodegenLib/ASTTypeUsed.swift
@@ -1,5 +1,8 @@
 import Foundation
 
+// Only available on macOS
+#if os(macOS)
+
 /// A type to generate code for.
 class ASTTypeUsed: Codable {
   
@@ -32,3 +35,5 @@ class ASTTypeUsed: Codable {
   /// [optional] Any fields used on this type
   let fields: [ASTTypeUsed.Field]?
 }
+
+#endif
diff --git a/Sources/ApolloCodegenLib/ASTVariableType.swift b/Sources/ApolloCodegenLib/ASTVariableType.swift
@@ -1,5 +1,8 @@
 import Foundation
 
+// Only available on macOS
+#if os(macOS)
+
 /// Placeholder typealias while this is getting added to tooling
 typealias ASTVariableType = String
 
@@ -60,3 +63,5 @@ class ASTForthcomingVariableType: Codable {
     }
   }
 }
+
+#endif
diff --git a/Sources/ApolloCodegenLib/ApolloCLI.swift b/Sources/ApolloCodegenLib/ApolloCLI.swift
@@ -1,7 +1,9 @@
 import Foundation
 
+// Only available on macOS
+#if os(macOS)
+
 /// Wrapper for calling the bundled node-based Apollo CLI.
-@available(OSX, message: "Only available on macOS")
 public struct ApolloCLI {
   
   /// Creates an instance of `ApolloCLI`, downloading and extracting if needed
@@ -47,3 +49,5 @@ public struct ApolloCLI {
     return try Basher.run(command: command, from: folder)
   }
 }
+
+#endif
diff --git a/Sources/ApolloCodegenLib/ApolloCodegen.swift b/Sources/ApolloCodegenLib/ApolloCodegen.swift
@@ -1,7 +1,9 @@
 import Foundation
 
+// Only available on macOS
+#if os(macOS)
+
 /// A class to facilitate running code generation
-@available(OSX, message: "Only available on macOS")
 public class ApolloCodegen {
   
   /// Errors which can happen with code generation
@@ -42,3 +44,5 @@ public class ApolloCodegen {
     return try cli.runApollo(with: options.arguments, from: folder)
   }
 }
+
+#endif
diff --git a/Sources/ApolloCodegenLib/ApolloCodegenOptions.swift b/Sources/ApolloCodegenLib/ApolloCodegenOptions.swift
@@ -1,5 +1,8 @@
 import Foundation
 
+// Only available on macOS
+#if os(macOS)
+
 /// An object to hold all the various options for running codegen
 public struct ApolloCodegenOptions {
   
@@ -177,3 +180,5 @@ extension ApolloCodegenOptions: CustomDebugStringConvertible {
     self.arguments.joined(separator: "\n")
   }
 }
+
+#endif
diff --git a/Sources/ApolloCodegenLib/ApolloFilePathHelper.swift b/Sources/ApolloCodegenLib/ApolloFilePathHelper.swift
@@ -1,5 +1,8 @@
 import Foundation
 
+// Only available on macOS
+#if os(macOS)
+
 /// Readability helpers for accessing frequent folders.
 struct ApolloFilePathHelper {
   
@@ -38,3 +41,5 @@ struct ApolloFilePathHelper {
     return apolloFolderURL.appendingPathComponent(".shasum")
   }
 }
+
+#endif
diff --git a/Sources/ApolloCodegenLib/ApolloSchemaDownloader.swift b/Sources/ApolloCodegenLib/ApolloSchemaDownloader.swift
@@ -1,7 +1,9 @@
 import Foundation
 
+// Only available on macOS
+#if os(macOS)
+
 /// A wrapper to facilitate downloading a schema with the Apollo node CLI
-@available(OSX, message: "Only available on macOS")
 public struct ApolloSchemaDownloader {
   
   /// Runs code generation from the given folder with the passed-in options
@@ -19,3 +21,5 @@ public struct ApolloSchemaDownloader {
     return try cli.runApollo(with: options.arguments)
   }
 }
+
+#endif
diff --git a/Sources/ApolloCodegenLib/ApolloSchemaOptions.swift b/Sources/ApolloCodegenLib/ApolloSchemaOptions.swift
@@ -1,5 +1,8 @@
 import Foundation
 
+// Only available on macOS
+#if os(macOS)
+
 /// Options for running the Apollo Schema Downloader.
 public struct ApolloSchemaOptions {
   
@@ -66,3 +69,5 @@ extension ApolloSchemaOptions: CustomDebugStringConvertible {
     self.arguments.joined(separator: "\n")
   }
 }
+
+#endif
diff --git a/Sources/ApolloCodegenLib/Basher.swift b/Sources/ApolloCodegenLib/Basher.swift
@@ -1,7 +1,9 @@
 import Foundation
 
+// Only available on macOS
+#if os(macOS)
+
 /// Bash command runner
-@available(OSX, message: "Only available on macOS")
 public struct Basher {
   
   public enum BashError: Error, LocalizedError {
@@ -65,3 +67,5 @@ public struct Basher {
     return output
   }
 }
+
+#endif
diff --git a/Sources/ApolloCodegenLib/CLIDownloader.swift b/Sources/ApolloCodegenLib/CLIDownloader.swift
@@ -1,7 +1,9 @@
 import Foundation
 
+// Only available on macOS
+#if os(macOS)
+
 /// Helper for downloading the CLI Zip file so we don't have to include it in the repo.
-@available(OSX, message: "Only available on macOS")
 struct CLIDownloader {
   
   enum CLIDownloaderError: Error, LocalizedError {
@@ -118,3 +120,5 @@ struct CLIDownloader {
     }
   }
 }
+
+#endif
diff --git a/Sources/ApolloCodegenLib/CLIExtractor.swift b/Sources/ApolloCodegenLib/CLIExtractor.swift
@@ -1,7 +1,9 @@
 import Foundation
 
+// Only available on macOS
+#if os(macOS)
+
 /// Helper for extracting and validating the node-based Apollo CLI from a zip.
-@available(OSX, message: "Only available on macOS")
 struct CLIExtractor {
   
   // MARK: - Extracting the binary
@@ -122,3 +124,5 @@ struct CLIExtractor {
     }
   }
 }
+
+#endif
diff --git a/Sources/ApolloCodegenLib/CodegenLogger.swift b/Sources/ApolloCodegenLib/CodegenLogger.swift
@@ -1,5 +1,8 @@
 import Foundation
 
+// Only available on macOS
+#if os(macOS)
+
 /// Helper to get logs printing to stdout so they can be read from the command line.
 public struct CodegenLogger {
   public enum LogLevel: Int {
@@ -50,3 +53,5 @@ extension FileHandle: TextOutputStream {
     self.write(data)
   }
 }
+
+#endif
diff --git a/Sources/ApolloCodegenLib/FileFinder.swift b/Sources/ApolloCodegenLib/FileFinder.swift
@@ -1,5 +1,8 @@
 import Foundation
 
+// Only available on macOS
+#if os(macOS)
+
 public struct FileFinder {
     
     public static func findParentFolder(from filePath: StaticString = #file) -> URL {
@@ -11,3 +14,5 @@ public struct FileFinder {
         return url.deletingLastPathComponent()
     }
 }
+
+#endif
diff --git a/Sources/ApolloCodegenLib/FileManager+Apollo.swift b/Sources/ApolloCodegenLib/FileManager+Apollo.swift
@@ -1,6 +1,9 @@
 import Foundation
 import CommonCrypto
 
+// Only available on macOS
+#if os(macOS)
+
 public extension FileManager {
 
   /// Checks if a file exists (and is not a folder) at the given path
@@ -131,3 +134,5 @@ public extension FileManager {
       .joined()
   }
 }
+
+#endif
diff --git a/Sources/ApolloCodegenLib/FlexibleDecoder.swift b/Sources/ApolloCodegenLib/FlexibleDecoder.swift
@@ -1,5 +1,8 @@
 import Foundation
 
+// Only available on macOS
+#if os(macOS)
+
 // Adapted from Combine's `TopLevelDecoder` protocol to allow easy swapping of
 // decoders which decode in similar fashions.
 public protocol FlexibleDecoder {
@@ -28,3 +31,5 @@ extension Decodable {
     return try decoder.decode(Self.self, from: data)
   }
 }
+
+#endif
diff --git a/Sources/ApolloCodegenLib/JSON.swift b/Sources/ApolloCodegenLib/JSON.swift
@@ -1,5 +1,8 @@
 import Foundation
 
+// Only available on macOS
+#if os(macOS)
+
 // MARK: - JSONValue
 
 public enum JSONValue: Codable, Equatable {
@@ -178,3 +181,5 @@ public enum JSONValue: Codable, Equatable {
     }
   }
 }
+
+#endif
diff --git a/Sources/ApolloCodegenLib/OptionalBoolean.swift b/Sources/ApolloCodegenLib/OptionalBoolean.swift
@@ -1,5 +1,8 @@
 import Foundation
 
+// Only available on macOS
+#if os(macOS)
+
 extension Optional where Wrapped == Bool {
   
   var apollo_boolValue: Bool {
@@ -11,3 +14,5 @@ extension Optional where Wrapped == Bool {
     }
   }
 }
+
+#endif
diff --git a/Sources/ApolloCodegenLib/StaticString+Apollo.swift b/Sources/ApolloCodegenLib/StaticString+Apollo.swift
@@ -1,5 +1,8 @@
 import Foundation
 
+// Only available on macOS
+#if os(macOS)
+
 extension StaticString {
   
   var apollo_lastPathComponent: String {
@@ -12,3 +15,5 @@ extension StaticString {
     }
   }
 }
+
+#endif
diff --git a/Sources/ApolloCodegenLib/String+Apollo.swift b/Sources/ApolloCodegenLib/String+Apollo.swift
@@ -1,5 +1,8 @@
 import Foundation
 
+// Only available on macOS
+#if os(macOS)
+
 extension String {
   enum ApolloStringError: Error {
     case expectedSuffixMissing(_ suffix: String)
@@ -13,3 +16,5 @@ extension String {
     return String(self.dropLast(suffix.count))
   }
 }
+
+#endif

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,8 @@`
`1`	`1`	`import Foundation`
`2`	`2`
	`3`	`+// Only available on macOS`
	`4`	`+#if os(macOS)`
	`5`	`+`
`3`	`6`	`/// Placeholder typealias while this is getting added to tooling`
`4`	`7`	`typealias ASTVariableType = String`
`5`	`8`
`@@ -60,3 +63,5 @@ class ASTForthcomingVariableType: Codable {`
`60`	`63`	`}`
`61`	`64`	`}`
`62`	`65`	`}`
	`66`	`+`
	`67`	`+#endif`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,9 @@`
`1`	`1`	`import Foundation`
`2`	`2`
	`3`	`+// Only available on macOS`
	`4`	`+#if os(macOS)`
	`5`	`+`
`3`	`6`	`/// Wrapper for calling the bundled node-based Apollo CLI.`
`4`		`-@available(OSX, message: "Only available on macOS")`
`5`	`7`	`public struct ApolloCLI {`
`6`	`8`
`7`	`9`	/// Creates an instance of `ApolloCLI`, downloading and extracting if needed
`@@ -47,3 +49,5 @@ public struct ApolloCLI {`
`47`	`49`	`return try Basher.run(command: command, from: folder)`
`48`	`50`	`}`
`49`	`51`	`}`
	`52`	`+`
	`53`	`+#endif`