Skip to content

Provide deprecation messages for PackagePlugin.Path #7677

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 18, 2024
Merged

Provide deprecation messages for PackagePlugin.Path #7677

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d702c1c
Provide deprecation messages for `PackagePlugin.Path`
MaxDesiatov Jun 18, 2024
2c3569d
Update Sources/PackagePlugin/Context.swift
MaxDesiatov Jun 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 20 additions & 22 deletions Sources/PackagePlugin/Command.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2021-2022 Apple Inc. and the Swift project authors
// Copyright (c) 2021-2024 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
Expand All @@ -16,7 +16,6 @@ import Foundation
/// environment variables, initial working directory, etc. All paths should be
/// based on the ones passed to the plugin in the target build context.
public enum Command {

/// Returns a command that runs when any of its output files are needed by
/// the build, but out-of-date.
///
Expand Down Expand Up @@ -86,8 +85,7 @@ public enum Command {
)
}

public extension Command {

extension Command {
/// Returns a command that runs when any of its output files are needed by
/// the build, but out-of-date.
///
Expand All @@ -114,20 +112,20 @@ public extension Command {
/// was generated as if in its source directory; other files are treated
/// as resources as if explicitly listed in `Package.swift` using
/// `.process(...)`.
@available(_PackageDescription, deprecated: 6.0)
static func buildCommand(
@available(_PackageDescription, deprecated: 6.0, message: "Use `URL` type instead of `Path`.")
public static func buildCommand(
displayName: String?,
executable: Path,
arguments: [CustomStringConvertible],
environment: [String: CustomStringConvertible] = [:],
inputFiles: [Path] = [],
outputFiles: [Path] = []
) -> Command {
return buildCommand(
self.buildCommand(
displayName: displayName,
executable: URL(fileURLWithPath: executable.stringValue),
arguments: arguments.map{ $0.description },
environment: environment.mapValues{ $0.description },
arguments: arguments.map(\.description),
environment: environment.mapValues { $0.description },
inputFiles: inputFiles.map { URL(fileURLWithPath: $0.stringValue) },
outputFiles: outputFiles.map { URL(fileURLWithPath: $0.stringValue) }
)
Expand Down Expand Up @@ -160,7 +158,7 @@ public extension Command {
/// as resources as if explicitly listed in `Package.swift` using
/// `.process(...)`.
@available(*, unavailable, message: "specifying the initial working directory for a command is not yet supported")
static func buildCommand(
public static func buildCommand(
displayName: String?,
executable: Path,
arguments: [CustomStringConvertible],
Expand All @@ -169,11 +167,11 @@ public extension Command {
inputFiles: [Path] = [],
outputFiles: [Path] = []
) -> Command {
return buildCommand(
self.buildCommand(
displayName: displayName,
executable: URL(fileURLWithPath: executable.stringValue),
arguments: arguments.map{ $0.description },
environment: environment.mapValues{ $0.description },
arguments: arguments.map(\.description),
environment: environment.mapValues { $0.description },
inputFiles: inputFiles.map { URL(fileURLWithPath: $0.stringValue) },
outputFiles: outputFiles.map { URL(fileURLWithPath: $0.stringValue) }
)
Expand Down Expand Up @@ -204,19 +202,19 @@ public extension Command {
/// this command was generated as if in its source directory; other
/// files are treated as resources as if explicitly listed in
/// `Package.swift` using `.process(...)`.
@available(_PackageDescription, deprecated: 6.0)
static func prebuildCommand(
@available(_PackageDescription, deprecated: 6.0, message: "Use `URL` type instead of `Path`.")
public static func prebuildCommand(
displayName: String?,
executable: Path,
arguments: [CustomStringConvertible],
environment: [String: CustomStringConvertible] = [:],
outputFilesDirectory: Path
) -> Command {
return prebuildCommand(
self.prebuildCommand(
displayName: displayName,
executable: URL(fileURLWithPath: executable.stringValue),
arguments: arguments.map{ $0.description },
environment: environment.mapValues{ $0.description },
arguments: arguments.map(\.description),
environment: environment.mapValues { $0.description },
outputFilesDirectory: URL(fileURLWithPath: outputFilesDirectory.stringValue)
)
}
Expand Down Expand Up @@ -247,19 +245,19 @@ public extension Command {
/// files are treated as resources as if explicitly listed in
/// `Package.swift` using `.process(...)`.
@available(*, unavailable, message: "specifying the initial working directory for a command is not yet supported")
static func prebuildCommand(
public static func prebuildCommand(
displayName: String?,
executable: Path,
arguments: [CustomStringConvertible],
environment: [String: CustomStringConvertible] = [:],
workingDirectory: Path? = .none,
outputFilesDirectory: Path
) -> Command {
return prebuildCommand(
self.prebuildCommand(
displayName: displayName,
executable: URL(fileURLWithPath: executable.stringValue),
arguments: arguments.map{ $0.description },
environment: environment.mapValues{ $0.description },
arguments: arguments.map(\.description),
environment: environment.mapValues { $0.description },
outputFilesDirectory: URL(fileURLWithPath: outputFilesDirectory.stringValue)
)
}
Expand Down
14 changes: 7 additions & 7 deletions Sources/PackagePlugin/Context.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ public struct PluginContext {
/// write its outputs to that directory. The plugin may also create other
/// directories for cache files and other file system content that either
/// it or the command will need.
@available(_PackageDescription, deprecated: 6.0)
@available(_PackageDescription, deprecated: 6.0, renamed: "pluginWorkDirectoryURL")
public let pluginWorkDirectory: Path

/// The path of a writable directory into which the plugin or the build
Expand Down Expand Up @@ -65,12 +65,12 @@ public struct PluginContext {
}
return Tool(name: name, path: Path(url: tool.path), url: tool.path)
} else {
for dir in toolSearchDirectoryURLs {
#if os(Windows)
for dir in self.toolSearchDirectoryURLs {
#if os(Windows)
let hostExecutableSuffix = ".exe"
#else
#else
let hostExecutableSuffix = ""
#endif
#endif
let path = dir.appendingPathComponent(name + hostExecutableSuffix)
if FileManager.default.isExecutableFile(atPath: path.path) {
return Tool(name: name, path: Path(url: path), url: path)
Expand All @@ -86,7 +86,7 @@ public struct PluginContext {

/// The paths of directories of in which to search for tools that aren't in
/// the `toolNamesToPaths` map.
@available(_PackageDescription, deprecated: 6.0)
@available(_PackageDescription, deprecated: 6.0, renamed: "toolSearchDirectoryURLs")
let toolSearchDirectories: [Path]

/// The paths of directories of in which to search for tools that aren't in
Expand All @@ -100,7 +100,7 @@ public struct PluginContext {
public let name: String

/// Full path of the built or provided tool in the file system.
@available(_PackageDescription, deprecated: 6.0)
@available(_PackageDescription, deprecated: 6.0, renamed: "url")
public let path: Path

/// Full path of the built or provided tool in the file system.
Expand Down
Loading