diff --git a/Package.swift b/Package.swift index d5ac1ee..79fa745 100644 --- a/Package.swift +++ b/Package.swift @@ -16,6 +16,10 @@ let package = Package( name: "GraphQLGeneratorPlugin", targets: ["GraphQLGeneratorPlugin"] ), + .plugin( + name: "GraphQLGeneratorCommand", + targets: ["GraphQLGeneratorCommand"] + ), .library( name: "GraphQLGeneratorRuntime", targets: ["GraphQLGeneratorRuntime"] @@ -32,12 +36,26 @@ let package = Package( .package(url: "https://github.com/jpsim/Yams.git", "4.0.0"..<"7.0.0"), ], targets: [ - // Build plugin .plugin( name: "GraphQLGeneratorPlugin", capability: .buildTool(), dependencies: ["GraphQLGenerator"] ), + .plugin( + name: "GraphQLGeneratorCommand", + capability: .command( + intent: .custom( + verb: "generate-code-from-graphql", + description: "Generate Swift code from a GraphQL Schema." + ), + permissions: [ + .writeToPackageDirectory( + reason: "To write the generated Swift files back into the source directory of the package." + ) + ] + ), + dependencies: ["GraphQLGenerator"] + ), .executableTarget( name: "GraphQLGenerator", dependencies: [ diff --git a/Plugins/GraphQLGeneratorCommand/PluginsShared b/Plugins/GraphQLGeneratorCommand/PluginsShared new file mode 120000 index 0000000..a667174 --- /dev/null +++ b/Plugins/GraphQLGeneratorCommand/PluginsShared @@ -0,0 +1 @@ +../../Plugins/PluginsShared/ \ No newline at end of file diff --git a/Plugins/GraphQLGeneratorCommand/plugin.swift b/Plugins/GraphQLGeneratorCommand/plugin.swift new file mode 100644 index 0000000..fe618fe --- /dev/null +++ b/Plugins/GraphQLGeneratorCommand/plugin.swift @@ -0,0 +1,83 @@ +import Foundation +import PackagePlugin + +@main +struct GraphQLGeneratorCommand { + func runCommand( + targetWorkingDirectory: URL, + tool: (String) throws -> PluginContext.Tool, + sourceFiles: FileList, + targetName: String + ) throws { + let inputs = try PluginUtils.validateInputs( + pluginWorkDirectory: targetWorkingDirectory, + tool: tool, + sourceFiles: sourceFiles, + sourceDirectory: targetWorkingDirectory, + targetName: targetName, + pluginSource: .command + ) + + let process = Process() + process.executableURL = inputs.tool.url + process.arguments = inputs.arguments + process.environment = [:] + try process.run() + process.waitUntilExit() + guard process.terminationStatus == 0 else { throw PluginError.generatorFailure(targetName: targetName) } + } +} + +extension GraphQLGeneratorCommand: CommandPlugin { + /// Entry point for creating command plugins for targets in Swift packages. + func performCommand(context: PluginContext, arguments: [String]) async throws { + let targetNameArguments = arguments.filter({ $0 != "--target" }) + let targets: [Target] + if targetNameArguments.isEmpty { + targets = context.package.targets + } else { + let matchingTargets = try context.package.targets(named: targetNameArguments) + let packageTargets = Set(context.package.targets.map(\.id)) + let withLocalDependencies = matchingTargets.flatMap { [$0] + $0.recursiveTargetDependencies } + .filter { packageTargets.contains($0.id) } + let enumeratedKeyValues = withLocalDependencies.map(\.id).enumerated() + .map { (key: $0.element, value: $0.offset) } + let indexLookupTable = Dictionary(enumeratedKeyValues, uniquingKeysWith: { l, _ in l }) + let groupedByID = Dictionary(grouping: withLocalDependencies, by: \.id) + let sortedUniqueTargets = groupedByID.map(\.value[0]) + .sorted { indexLookupTable[$0.id, default: 0] < indexLookupTable[$1.id, default: 0] } + targets = sortedUniqueTargets + } + + guard !targets.isEmpty else { throw PluginError.noTargetsMatchingTargetNames(targetNameArguments) } + + var hadASuccessfulRun = false + + for target in targets { + print("Considering target '\(target.name)':") + guard let target = target as? SwiftSourceModuleTarget else { + print("- Not a swift source module. Can't generate GraphQL code.") + continue + } + do { + print("- Trying GraphQL code generation.") + try runCommand( + targetWorkingDirectory: target.directoryURL, + tool: context.tool, + sourceFiles: target.sourceFiles, + targetName: target.name + ) + print("- ✅ GraphQL code generation for target '\(target.name)' successfully completed.") + hadASuccessfulRun = true + } catch PluginError.noSchemaFiles { + print("- No GraphQL schema files found. Skipping.") + continue + } catch { + print("- GraphQL code generation failed with error.") + throw error + } + } + + guard hadASuccessfulRun else { throw PluginError.noTargetsGenerated(targetNames: targets.map(\.name)) } + } +} diff --git a/Plugins/GraphQLGeneratorPlugin/PluginsShared b/Plugins/GraphQLGeneratorPlugin/PluginsShared new file mode 120000 index 0000000..a667174 --- /dev/null +++ b/Plugins/GraphQLGeneratorPlugin/PluginsShared @@ -0,0 +1 @@ +../../Plugins/PluginsShared/ \ No newline at end of file diff --git a/Plugins/GraphQLGeneratorPlugin/plugin.swift b/Plugins/GraphQLGeneratorPlugin/plugin.swift new file mode 100644 index 0000000..79dedba --- /dev/null +++ b/Plugins/GraphQLGeneratorPlugin/plugin.swift @@ -0,0 +1,73 @@ +import Foundation +import PackagePlugin + +@main struct GraphQLGeneratorPlugin { + func createBuildCommands( + pluginWorkDirectory: URL, + tool: (String) throws -> PluginContext.Tool, + sourceFiles: FileList, + sourceDirectory: URL, + targetName: String + ) throws -> [Command] { + let inputs = try PluginUtils.validateInputs( + pluginWorkDirectory: pluginWorkDirectory, + tool: tool, + sourceFiles: sourceFiles, + sourceDirectory: sourceDirectory, + targetName: targetName, + pluginSource: .build + ) + + let outputFiles = OutputFileName.allCases.map { inputs.outputDirectory.appending(component: $0.rawValue) } + var inputFiles = inputs.schemaFiles + if let config = inputs.config { + inputFiles.append(config) + } + return [ + .buildCommand( + displayName: "Generating GraphQL Swift code", + executable: inputs.tool.url, + arguments: inputs.arguments, + environment: [:], + inputFiles: inputFiles, + outputFiles: outputFiles + ) + ] + } +} + +extension GraphQLGeneratorPlugin: BuildToolPlugin { + /// Entry point for creating build commands for targets in Swift packages. + func createBuildCommands(context: PluginContext, target: Target) async throws -> [Command] { + guard let swiftTarget = target as? SwiftSourceModuleTarget else { + throw PluginError.incompatibleTarget(name: target.name) + } + return try createBuildCommands( + pluginWorkDirectory: context.pluginWorkDirectoryURL, + tool: context.tool, + sourceFiles: swiftTarget.sourceFiles, + sourceDirectory: swiftTarget.directoryURL, + targetName: target.name + ) + } +} + +#if canImport(XcodeProjectPlugin) + import XcodeProjectPlugin + + extension GraphQLGeneratorPlugin: XcodeBuildToolPlugin { + /// Entry point for creating build commands for targets in Xcode projects. + func createBuildCommands(context: XcodePluginContext, target: XcodeTarget) throws + -> [Command] + { + return try createBuildCommands( + pluginWorkDirectory: context.pluginWorkDirectoryURL, + tool: context.tool, + sourceFiles: target.inputFiles, + sourceDirectory: context.xcodeProject.directoryURL, + targetName: target.displayName + ) + } + } + +#endif diff --git a/Plugins/PluginsShared/OutputFiles.swift b/Plugins/PluginsShared/OutputFiles.swift new file mode 120000 index 0000000..d8a8a96 --- /dev/null +++ b/Plugins/PluginsShared/OutputFiles.swift @@ -0,0 +1 @@ +../../Sources/GraphQLGeneratorCore/Generator/OutputFiles.swift \ No newline at end of file diff --git a/Plugins/GraphQLGeneratorPlugin.swift b/Plugins/PluginsShared/PluginUtils.swift similarity index 60% rename from Plugins/GraphQLGeneratorPlugin.swift rename to Plugins/PluginsShared/PluginUtils.swift index 52f2472..4a58d7b 100644 --- a/Plugins/GraphQLGeneratorPlugin.swift +++ b/Plugins/PluginsShared/PluginUtils.swift @@ -1,36 +1,34 @@ import Foundation import PackagePlugin -@main -struct GraphQLGeneratorPlugin: BuildToolPlugin { - private static let schemaExtensions: Set = ["graphql", "gql"] - - /// Entry point for creating build commands for targets in Swift packages. - func createBuildCommands(context: PluginContext, target: Target) async throws -> [Command] { - // This plugin only runs for Swift source targets. - guard let target = target as? SwiftSourceModuleTarget else { - return [] - } +enum PluginUtils { + struct ValidatedInputs { + let schemaFiles: [URL] + let config: URL? + let outputDirectory: URL + let arguments: [String] + let tool: PluginContext.Tool + } + /// Validates the inputs and returns the necessary values to run a plugin. + static func validateInputs( + pluginWorkDirectory: URL, + tool: (String) throws -> PluginContext.Tool, + sourceFiles: FileList, + sourceDirectory: URL, + targetName: String, + pluginSource: PluginSource + ) throws -> ValidatedInputs { // Find the config file, if present - let configFile = findConfigFile(in: target.sourceFiles) - - // Find the generator tool - let generatorTool = try context.tool(named: "GraphQLGenerator") + let configFile = findConfigFile(in: sourceFiles) // Create output directory for generated files - let outputDirectory = context.pluginWorkDirectoryURL - - let outputFiles = [ - outputDirectory.appendingPathComponent("BuildGraphQLSchema.swift"), - outputDirectory.appendingPathComponent("GraphQLRawSDL.swift"), - outputDirectory.appendingPathComponent("GraphQLTypes.swift"), - ] + let outputDirectory = pluginWorkDirectory var arguments: [String] = [] // Pass the target's source directory for fallback schema discovery - arguments += ["--source-directory", target.directoryURL.path()] + arguments += ["--source-directory", sourceDirectory.path()] // Pass output directory arguments += ["--output-directory", outputDirectory.path] @@ -41,30 +39,19 @@ struct GraphQLGeneratorPlugin: BuildToolPlugin { } let inputFiles = try commandInputFiles( - in: target.sourceFiles, - sourceDirectory: target.directoryURL, - configFile: configFile + in: sourceFiles, + sourceDirectory: sourceDirectory, + configFile: configFile, + targetName: targetName ) - return [ - .buildCommand( - displayName: "Generating GraphQL Swift code", - executable: generatorTool.url, - arguments: arguments, - inputFiles: inputFiles, - outputFiles: outputFiles - ) - ] - } + let tool = try tool("GraphQLGenerator") - /// Supported config file names in the target's source directory. - private static let supportedConfigFiles: Set = [ - "graphql-generator-config.yaml", - "graphql-generator-config.yml", - ] + return ValidatedInputs(schemaFiles: inputFiles, config: configFile, outputDirectory: outputDirectory, arguments: arguments, tool: tool) + } /// Finds the generator config file in the target's source files, if present. - private func findConfigFile(in sourceFiles: FileList) -> URL? { + private static func findConfigFile(in sourceFiles: FileList) -> URL? { let configs = sourceFiles.map(\.url).filter { Self.supportedConfigFiles.contains($0.lastPathComponent) } @@ -72,10 +59,11 @@ struct GraphQLGeneratorPlugin: BuildToolPlugin { } /// Returns all files whose contents can affect generated output. - private func commandInputFiles( + private static func commandInputFiles( in sourceFiles: FileList, sourceDirectory: URL, - configFile: URL? + configFile: URL?, + targetName: String ) throws -> [URL] { let schemaFiles: [URL] if let configFile, let configuredPaths = try configuredSchemaPaths(in: configFile) { @@ -85,11 +73,20 @@ struct GraphQLGeneratorPlugin: BuildToolPlugin { Self.schemaExtensions.contains($0.pathExtension.lowercased()) } } - return (configFile.map { [$0] } ?? []) + schemaFiles + if schemaFiles.isEmpty { + throw PluginError.noSchemaFiles(targetName: targetName) + } + + var inputFiles = [URL]() + if let configFile { + inputFiles.append(configFile) + } + inputFiles.append(contentsOf: schemaFiles) + return inputFiles } /// Decodes the optional top-level `schemas` YAML sequence used by the generator. - private func configuredSchemaPaths(in configFile: URL) throws -> [String]? { + private static func configuredSchemaPaths(in configFile: URL) throws -> [String]? { let contents = try String(contentsOf: configFile, encoding: .utf8) let lines = contents.split(separator: "\n", omittingEmptySubsequences: false) @@ -133,7 +130,7 @@ struct GraphQLGeneratorPlugin: BuildToolPlugin { return nil } - private func unquote(_ value: String) -> String { + private static func unquote(_ value: String) -> String { guard value.count >= 2, let first = value.first, let last = value.last, @@ -144,7 +141,7 @@ struct GraphQLGeneratorPlugin: BuildToolPlugin { return String(value.dropFirst().dropLast()) } - private func resolveSchemaFiles(_ paths: [String], relativeTo baseURL: URL) throws -> [URL] { + private static func resolveSchemaFiles(_ paths: [String], relativeTo baseURL: URL) throws -> [URL] { let fileManager = FileManager.default var result: Set = [] @@ -178,6 +175,23 @@ struct GraphQLGeneratorPlugin: BuildToolPlugin { return result.sorted { $0.path < $1.path } } + + /// The source of a plugin generator invocation. + enum PluginSource: String, Codable { + /// BuildTool plugin + case build + /// Command plugin. + case command + } + + + /// Supported config file names in the target's source directory. + private static let supportedConfigFiles: Set = [ + "graphql-generator-config.yaml", + "graphql-generator-config.yml", + ] + + private static let schemaExtensions: Set = ["graphql", "gql"] } private enum PluginConfigError: Error, CustomStringConvertible { @@ -194,61 +208,27 @@ private enum PluginConfigError: Error, CustomStringConvertible { } } -#if canImport(XcodeProjectPlugin) - import XcodeProjectPlugin - - extension GraphQLGeneratorPlugin: XcodeBuildToolPlugin { - /// Entry point for creating build commands for targets in Xcode projects. - func createBuildCommands(context: XcodePluginContext, target: XcodeTarget) throws - -> [Command] - { - // Find the config file - let configFile = findConfigFile(in: target.inputFiles) - - // Derive the source directory from the target's input files - let sourceDirectory = context.xcodeProject.directoryURL - - // Find the generator tool - let generatorTool = try context.tool(named: "GraphQLGenerator") +enum PluginError: Swift.Error, Equatable, CustomStringConvertible, LocalizedError { + case incompatibleTarget(name: String) + case generatorFailure(targetName: String) + case noTargetsMatchingTargetNames([String]) + case noTargetsGenerated(targetNames: [String]) + case noSchemaFiles(targetName: String) - // Create output directory for generated files - let outputDirectory = context.pluginWorkDirectoryURL - - let outputFiles = [ - outputDirectory.appendingPathComponent("BuildGraphQLSchema.swift"), - outputDirectory.appendingPathComponent("GraphQLRawSDL.swift"), - outputDirectory.appendingPathComponent("GraphQLTypes.swift"), - ] - - var arguments: [String] = [] - - // Pass the source directory for fallback schema discovery - arguments += ["--source-directory", sourceDirectory.path] - - // Pass output directory - arguments += ["--output-directory", outputDirectory.path] - - // Pass config file if found - if let configURL = configFile { - arguments += ["--config", configURL.path] - } - - let inputFiles = try commandInputFiles( - in: target.inputFiles, - sourceDirectory: sourceDirectory, - configFile: configFile - ) - - return [ - .buildCommand( - displayName: "Generating GraphQL Swift code", - executable: generatorTool.url, - arguments: arguments, - inputFiles: inputFiles, - outputFiles: outputFiles - ) - ] + var description: String { + switch self { + case .incompatibleTarget(let name): + return "Incompatible target called '\(name)'. Only Swift source targets can be used with the GraphQL Generator plugin." + case .generatorFailure(let targetName): + return "The generator failed to generate GraphQL Swift files for target '\(targetName)'." + case .noTargetsMatchingTargetNames(let targetNames): + return "Found no targets with names \(targetNames.joined(separator: ", "))." + case .noSchemaFiles(let targetName): + return "No GraphQL schema files found for target '\(targetName)'." + case .noTargetsGenerated(let targetNames): + return "No targets from inputs \(targetNames.joined(separator: ", ")) were generated." } } -#endif + var errorDescription: String? { description } +} diff --git a/README.md b/README.md index e353393..4cb5555 100644 --- a/README.md +++ b/README.md @@ -150,6 +150,15 @@ You can configure this package by including a `graphql-generator-config.yaml` fi `schemas: [String]?`: Paths to GraphQL schema files or directories containing schema files. These paths are relative to the sources directory, and directories are explored recursively. If not provided, the whole sources directory is searched. +## Command Plugin +You can run code generation directly into your repository without using the build plugin. To do so, run: + +```bash +swift package --allow-writing-to-package-directory generate-code-from-graphql +``` + +When doing this, do not include the `.plugin` in your `Package.swift`, or the code from the Sources and Plugin directories will clash. + ## Design Philosophy This generator is designed with the following guiding principles: diff --git a/Sources/GraphQLGeneratorCore/Generator/CodeGenerator.swift b/Sources/GraphQLGeneratorCore/Generator/CodeGenerator.swift index 5ff74f2..564b2bf 100644 --- a/Sources/GraphQLGeneratorCore/Generator/CodeGenerator.swift +++ b/Sources/GraphQLGeneratorCore/Generator/CodeGenerator.swift @@ -11,11 +11,11 @@ package struct CodeGenerator { let schema = try GraphQL.buildSchema(source: source) var files: [String: String] = [:] - files["BuildGraphQLSchema.swift"] = try BuildGraphQLSchemaGenerator().generate( + files[OutputFileName.buildGraphQLSchema.rawValue] = try BuildGraphQLSchemaGenerator().generate( schema: schema ) - files["GraphQLRawSDL.swift"] = try GraphQLRawSDLGenerator().generate(source: source) - files["GraphQLTypes.swift"] = try GraphQLTypesGenerator().generate(schema: schema) + files[OutputFileName.graphQLRawSDL.rawValue] = try GraphQLRawSDLGenerator().generate(source: source) + files[OutputFileName.graphQLTypes.rawValue] = try GraphQLTypesGenerator().generate(schema: schema) return files } diff --git a/Sources/GraphQLGeneratorCore/Generator/OutputFiles.swift b/Sources/GraphQLGeneratorCore/Generator/OutputFiles.swift new file mode 100644 index 0000000..5aebd59 --- /dev/null +++ b/Sources/GraphQLGeneratorCore/Generator/OutputFiles.swift @@ -0,0 +1,6 @@ +/// The name of a Swift file emitted by the generator. +enum OutputFileName: String, Hashable, CaseIterable, Sendable { + case buildGraphQLSchema = "BuildGraphQLSchema.swift" + case graphQLRawSDL = "GraphQLRawSDL.swift" + case graphQLTypes = "GraphQLTypes.swift" +}