BuildPlan

Conformances

• protocol BuildPlan

Types

• enum Error
• enum Input

  Return value of inputs()

Type members

• init(destinationBuildParameters: BuildParameters, toolsBuildParameters: BuildParameters, graph: ModulesGraph, additionalFileRules: [FileRuleDescription], buildToolPluginInvocationResults: [ResolvedModule.ID : [BuildToolPluginInvocationResult]], prebuildCommandResults: [ResolvedModule.ID : [PrebuildCommandResult]], disableSandbox: Bool, fileSystem: any FileSystem, observabilityScope: ObservabilityScope) throws

  Create a build plan with a package graph and explicitly distinct build parameters for destination platform and tools platform.

Instance members

• var buildProducts: AnySequence<SPMBuildCore.ProductBuildDescription>

  The products in this plan.

• let buildToolPluginInvocationResults: [ResolvedModule.ID : [BuildToolPluginInvocationResult]]

  The results of invoking any build tool plugins used by targets in this build.

• let destinationBuildParameters: BuildParameters

  Build parameters used for products.

• let graph: ModulesGraph

  The package graph.

• var inputs: [Input]

  Returns the files and directories that affect the build process of this build plan.

• let pluginDescriptions: [PluginBuildDescription]

  The plugin descriptions. Plugins are represented in the package graph as targets, but they are not directly included in the build graph.

• let prebuildCommandResults: [ResolvedModule.ID : [PrebuildCommandResult]]

  The results of running any prebuild commands for the targets in this build. This includes any derived source files as well as directories to which any changes should cause us to reevaluate the build plan.

• let productMap: [ResolvedProduct.ID : ProductBuildDescription]

  The product build description map.

• let targetMap: [ResolvedModule.ID : ModuleBuildDescription]

  The target build description map.

• var targets: AnySequence<ModuleBuildDescription>

  The build targets.

• let toolsBuildParameters: BuildParameters

  Build parameters used for tools.

• func createAPIToolCommonArgs(includeLibrarySearchPaths: Bool) throws -> [String]
• func createREPLArguments() throws -> [String]

  Creates arguments required to launch the Swift REPL that will allow importing the modules in the package graph.

• func symbolGraphExtractArguments(for: ResolvedModule) throws -> [String]