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
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2018 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
//
//===----------------------------------------------------------------------===//
extension Package.Dependency {
/// An enum that represents the requirement for a package dependency.
///
/// The dependency requirement can be defined as one of three different
/// version requirements:
///
/// - term A version-based requirement: Decide whether your project accepts
/// updates to a package dependency up to the next major version or up to
/// the next minor version. To be more restrictive, select a specific
/// version range or an exact version. Major versions tend to have more
/// significant changes than minor versions, and may require you to modify
/// your code when they update.
///
/// The version rule requires Swift packages to conform to semantic
/// versioning. To learn more about the semantic versioning standard, visit the
/// [Semantic Versioning 2.0.0](https://semver.org) website.
///
/// Selecting the version requirement is the recommended way to add a
/// package dependency. It allows you to create a balance between
/// restricting changes and obtaining improvements and features. - term A
/// branch-based requirement: Select the name of the branch for your package
/// dependency to follow. Use branch-based dependencies when you're
/// developing multiple packages in tandem or when you don't want to publish
/// versions of your package dependencies.
///
/// Note that packages which use branch-based dependency requirements can't
/// be added as dependencies to packages that use version-based dependency
/// requirements; you should remove branch-based dependency requirements
/// before publishing a version of your package. - term A commit-based
/// requirement: Select the commit hash for your package dependency to
/// follow.
///
/// Choosing this option isn't recommended, and should be limited to
/// exceptional cases. While pinning your package dependency to a specific
/// commit ensures that the package dependency doesn't change and your code
/// remains stable, you don't receive any updates at all. If you worry about
/// the stability of a remote package, consider one of the more restrictive
/// options of the version-based requirement.
///
/// Note that packages which use commit-based dependency requirements can't
/// be added as dependencies to packages that use version-based dependency
/// requirements; you should remove commit-based dependency requirements
/// before publishing a version of your package.
@available(_PackageDescription, deprecated: 5.6)
public enum Requirement {
case exactItem(Version)
case rangeItem(Range<Version>)
case revisionItem(String)
case branchItem(String)
case localPackageItem
var isLocalPackage: Bool {
if case .localPackageItem = self { return true }
return false
}
}
}
@available(_PackageDescription, deprecated: 5.6)
extension Package.Dependency.Requirement {
/// Returns a requirement for the given exact version.
///
/// Specifying exact version requirements are not recommended as they can
/// cause conflicts in your dependency graph when multiple other packages
/// depend on a package. As Swift packages follow the semantic versioning
/// convention, think about specifying a version range instead.
///
/// The following example defines a version requirement that requires
/// version 1.2.3 of a package.
///
/// ```swift
/// .exact(“1.2.3”)
/// ```
///
/// - Parameter version: The exact version of the dependency for this requirement.
@available(_PackageDescription, deprecated: 5.6)
public static func exact(_ version: Version) -> Package.Dependency.Requirement {
return .exactItem(version)
}
/// Returns a requirement for a source control revision such as the hash of
/// a commit.
///
/// Note that packages that use commit-based dependency requirements can't
/// be depended upon by packages that use version-based dependency
/// requirements; you should remove commit-based dependency requirements
/// before publishing a version of your package.
///
/// The following example defines a version requirement for a specific
/// commit hash.
///
///```swift
/// .revision(“e74b07278b926c9ec6f9643455ea00d1ce04a021”)
/// ```
///
/// - Parameter ref: The Git revision, usually a commit hash.
@available(_PackageDescription, deprecated: 5.6)
public static func revision(_ ref: String) -> Package.Dependency.Requirement {
return .revisionItem(ref)
}
/// Returns a requirement for a source control branch.
///
/// Note that packages that use branch-based dependency requirements can't
/// be depended upon by packages that use version-based dependency
/// requirements; you should remove branch-based dependency requirements
/// before publishing a version of your package.
///
/// The following example defines a version requirement that accepts any
/// change in the develop branch.
///
///```swift
/// .branch(“develop”)
/// ```
///
/// - Parameter name: The name of the branch.
@available(_PackageDescription, deprecated: 5.6)
public static func branch(_ name: String) -> Package.Dependency.Requirement {
return .branchItem(name)
}
}
// MARK: - SourceControlRequirement
extension Package.Dependency {
/// An enum that represents the requirement for a package dependency.
///
/// The dependency requirement can be defined as one of three different version requirements:
///
/// **A version-based requirement.**
///
/// Decide whether your project accepts updates to a package dependency up
/// to the next major version or up to the next minor version. To be more
/// restrictive, select a specific version range or an exact version.
/// Major versions tend to have more significant changes than minor
/// versions, and may require you to modify your code when they update.
/// The version rule requires Swift packages to conform to semantic
/// versioning. To learn more about the semantic versioning standard,
/// see the [Semantic Versioning 2.0.0](https://semver.org) website.
///
/// Selecting the version requirement is the recommended way to add a package dependency. It allows you to create a balance between restricting changes and obtaining improvements and features.
///
/// **A branch-based requirement**
///
/// Select the name of the branch for your package dependency to follow.
/// Use branch-based dependencies when you're developing multiple packages
/// in tandem or when you don't want to publish versions of your package dependencies.
///
/// Note that packages which use branch-based dependency requirements
/// can't be added as dependencies to packages that use version-based dependency
/// requirements; you should remove branch-based dependency requirements
/// before publishing a version of your package.
///
/// **A commit-based requirement**
///
/// Select the commit hash for your package dependency to follow.
/// Choosing this option isn't recommended, and should be limited to
/// exceptional cases. While pinning your package dependency to a specific
/// commit ensures that the package dependency doesn't change and your
/// code remains stable, you don't receive any updates at all. If you worry about
/// the stability of a remote package, consider one of the more
/// restrictive options of the version-based requirement.
///
/// Note that packages which use commit-based dependency requirements
/// can't be added as dependencies to packages that use version-based
/// dependency requirements; you should remove commit-based dependency
/// requirements before publishing a version of your package.
@available(_PackageDescription, introduced: 5.6)
public enum SourceControlRequirement {
/// An exact version based requirement.
case exact(Version)
/// A requirement based on a range of versions.
case range(Range<Version>)
/// A commit based requirement.
case revision(String)
/// A branch based requirement.
case branch(String)
}
}
// MARK: - RegistryRequirement
extension Package.Dependency {
/// An enum that represents the requirement for a package dependency.
///
/// Decide whether your project accepts updates to a package dependency up
/// to the next major version or up to the next minor version. To be more
/// restrictive, select a specific version range or an exact version.
/// Major versions tend to have more significant changes than minor
/// versions, and may require you to modify your code when they update.
/// The version rule requires Swift packages to conform to semantic
/// versioning. To learn more about the semantic versioning standard,
/// visit the [Semantic Versioning 2.0.0](https://semver.org) website.
@available(_PackageDescription, introduced: 999)
public enum RegistryRequirement {
/// A requirement based on an exact version.
case exact(Version)
/// A requirement based on a range of versions.
case range(Range<Version>)
}
}
extension Range {
/// Returns a requirement for a version range, starting at the given minimum
/// version and going up to the next major version. This is the recommended version requirement.
///
/// - Parameter version: The minimum version for the version range.
public static func upToNextMajor(from version: Version) -> Range<Bound> where Bound == Version {
return version ..< Version(version.major + 1, 0, 0)
}
/// Returns a requirement for a version range, starting at the given minimum
/// version and going up to the next minor version.
///
/// - Parameter version: The minimum version for the version range.
public static func upToNextMinor(from version: Version) -> Range<Bound> where Bound == Version {
return version ..< Version(version.major, version.minor + 1, 0)
}
}
@available(_PackageDescription, deprecated: 5.6)
extension Package.Dependency.Requirement {
/// A source control requirement bounded to the given version's major version number.
///
/// Returns a requirement for a version range, starting at the given minimum
/// version and going up to but not including the next major version. This is the recommended
/// version requirement.
///
/// - Parameter version: The minimum version for the version range.
///
/// - Returns: A source control requirement instance.
@_disfavoredOverload
public static func upToNextMajor(from version: Version) -> Self {
return .rangeItem(.upToNextMajor(from: version))
}
/// A source control requirement bounded to the given version's minor version number.
///
/// Returns a requirement for a version range, starting at the given minimum
/// version and going up to but not including the next minor version.
///
/// - Parameter version: The minimum version for the version range.
///
/// - Returns: A source control requirement instance.
@_disfavoredOverload
public static func upToNextMinor(from version: Version) -> Self {
return .rangeItem(.upToNextMinor(from: version))
}
}
|
