1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2021-2022 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
/// Defines functionality common to all SwiftPM plugins, such as the way to
/// instantiate the plugin.
///
/// A future improvement to SwiftPM would be to allow usage of a plugin to
/// also provide configuration parameters for that plugin. A proposal that
/// adds such a facility should also add initializers to set those values
/// as plugin properties.
public protocol Plugin {
/// Instantiates the plugin. This happens once per invocation of the
/// plugin; there is no facility for keeping in-memory state from one
/// invocation to the next. Most plugins do not need to implement the
/// initializer.
init()
}
/// Defines functionality for all plugins having a `buildTool` capability.
public protocol BuildToolPlugin: Plugin {
/// Invoked by SwiftPM to create build commands for a particular target.
/// The context parameter contains information about the package and its
/// dependencies, as well as other environmental inputs.
///
/// This function should create and return build commands or prebuild
/// commands, configured based on the information in the context. Note
/// that it does not directly run those commands.
func createBuildCommands(
context: PluginContext,
target: Target
) async throws -> [Command]
}
/// Defines functionality for all plugins that have a `command` capability.
public protocol CommandPlugin: Plugin {
/// Invoked by SwiftPM to perform the custom actions of the command.
func performCommand(
/// The context in which the plugin is invoked. This is the same for all
/// kinds of plugins, and provides access to the package graph, to cache
/// directories, etc.
context: PluginContext,
/// Any literal arguments passed after the verb in the command invocation.
arguments: [String]
) async throws
/// A proxy to the Swift Package Manager or IDE hosting the command plugin,
/// through which the plugin can ask for specialized information or actions.
var packageManager: PackageManager { get }
}
extension CommandPlugin {
/// A proxy to the Swift Package Manager or IDE hosting the command plugin,
/// through which the plugin can ask for specialized information or actions.
public var packageManager: PackageManager {
return PackageManager()
}
}
|