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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2014-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
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
import ArgumentParser
import Basics
import CoreCommands
import PackageModel
import PackageModelSyntax
import SwiftParser
import SwiftSyntax
import TSCBasic
import TSCUtility
import Workspace
extension SwiftPackageCommand {
struct AddDependency: SwiftCommand {
package static let configuration = CommandConfiguration(
abstract: "Add a package dependency to the manifest"
)
@Argument(help: "The URL or directory of the package to add")
var dependency: String
@OptionGroup(visibility: .hidden)
var globalOptions: GlobalOptions
@Option(help: "The exact package version to depend on")
var exact: Version?
@Option(help: "The specific package revision to depend on")
var revision: String?
@Option(help: "The branch of the package to depend on")
var branch: String?
@Option(help: "The package version to depend on (up to the next major version)")
var from: Version?
@Option(help: "The package version to depend on (up to the next minor version)")
var upToNextMinorFrom: Version?
@Option(help: "Specify upper bound on the package version range (exclusive)")
var to: Version?
@Option(help: "Specify dependency type")
var type: DependencyType = .url
enum DependencyType: String, Codable, CaseIterable, ExpressibleByArgument {
case url
case path
case registry
}
func run(_ swiftCommandState: SwiftCommandState) throws {
let workspace = try swiftCommandState.getActiveWorkspace()
guard let packagePath = try swiftCommandState.getWorkspaceRoot().packages.first else {
throw StringError("unknown package")
}
switch type {
case .url:
try self.createSourceControlPackage(
packagePath: packagePath,
workspace: workspace,
url: dependency
)
case .path:
try self.createFileSystemPackage(
packagePath: packagePath,
workspace: workspace,
directory: dependency
)
case .registry:
try self.createRegistryPackage(
packagePath: packagePath,
workspace: workspace,
id: dependency
)
}
}
private func createSourceControlPackage(
packagePath: Basics.AbsolutePath,
workspace: Workspace,
url: String
) throws {
let identity = PackageIdentity(url: .init(url))
// Collect all of the possible version requirements.
var requirements: [PackageDependency.SourceControl.Requirement] = []
if let exact {
requirements.append(.exact(exact))
}
if let branch {
requirements.append(.branch(branch))
}
if let revision {
requirements.append(.revision(revision))
}
if let from {
requirements.append(.range(.upToNextMajor(from: from)))
}
if let upToNextMinorFrom {
requirements.append(.range(.upToNextMinor(from: upToNextMinorFrom)))
}
if requirements.count > 1 {
throw StringError(
"must specify at most one of --exact, --branch, --revision, --from, or --up-to-next-minor-from"
)
}
guard let firstRequirement = requirements.first else {
throw StringError(
"must specify one of --exact, --branch, --revision, --from, or --up-to-next-minor-from"
)
}
let requirement: PackageDependency.SourceControl.Requirement
if case .range(let range) = firstRequirement {
if let to {
requirement = .range(range.lowerBound ..< to)
} else {
requirement = .range(range)
}
} else {
requirement = firstRequirement
if self.to != nil {
throw StringError("--to can only be specified with --from or --up-to-next-minor-from")
}
}
let packageDependency: PackageDependency = .sourceControl(
identity: identity,
nameForTargetDependencyResolutionOnly: nil,
location: .remote(.init(url)),
requirement: requirement,
productFilter: .everything,
traits: []
)
try applyEdits(
packagePath: packagePath,
workspace: workspace,
packageDependency: packageDependency
)
}
private func createRegistryPackage(
packagePath: Basics.AbsolutePath,
workspace: Workspace,
id: String
) throws {
let identity: PackageIdentity = .plain(id)
// Collect all of the possible version requirements.
var requirements: [PackageDependency.Registry.Requirement] = []
if let exact {
requirements.append(.exact(exact))
}
if let from {
requirements.append(.range(.upToNextMajor(from: from)))
}
if let upToNextMinorFrom {
requirements.append(.range(.upToNextMinor(from: upToNextMinorFrom)))
}
if requirements.count > 1 {
throw StringError(
"must specify at most one of --exact, --from, or --up-to-next-minor-from"
)
}
guard let firstRequirement = requirements.first else {
throw StringError(
"must specify one of --exact, --from, or --up-to-next-minor-from"
)
}
let requirement: PackageDependency.Registry.Requirement
if case .range(let range) = firstRequirement {
if let to {
requirement = .range(range.lowerBound ..< to)
} else {
requirement = .range(range)
}
} else {
requirement = firstRequirement
if self.to != nil {
throw StringError("--to can only be specified with --from or --up-to-next-minor-from")
}
}
let packageDependency: PackageDependency = .registry(
identity: identity,
requirement: requirement,
productFilter: .everything,
traits: []
)
try applyEdits(
packagePath: packagePath,
workspace: workspace,
packageDependency: packageDependency
)
}
private func createFileSystemPackage(
packagePath: Basics.AbsolutePath,
workspace: Workspace,
directory: String
) throws {
guard let path = try? Basics.AbsolutePath(validating: directory) else {
throw StringError("Package path not found")
}
let identity = PackageIdentity(path: path)
let packageDependency: PackageDependency = .fileSystem(
identity: identity,
nameForTargetDependencyResolutionOnly: nil,
path: path,
productFilter: .everything,
traits: []
)
try applyEdits(
packagePath: packagePath,
workspace: workspace,
packageDependency: packageDependency
)
}
private func applyEdits(
packagePath: Basics.AbsolutePath,
workspace: Workspace,
packageDependency: PackageDependency
) throws {
// Load the manifest file
let fileSystem = workspace.fileSystem
let manifestPath = packagePath.appending(component: Manifest.filename)
let manifestContents: ByteString
do {
manifestContents = try fileSystem.readFileContents(manifestPath)
} catch {
throw StringError("cannot find package manifest in \(manifestPath)")
}
// Parse the manifest.
let manifestSyntax = manifestContents.withData { data in
data.withUnsafeBytes { buffer in
buffer.withMemoryRebound(to: UInt8.self) { buffer in
Parser.parse(source: buffer)
}
}
}
let editResult = try AddPackageDependency.addPackageDependency(
packageDependency,
to: manifestSyntax
)
try editResult.applyEdits(
to: fileSystem,
manifest: manifestSyntax,
manifestPath: manifestPath,
verbose: !self.globalOptions.logging.quiet
)
}
}
}
|
