Skip to content

Commit 388c331

Browse files
tayloraswifttayloraswift
committed
first attempt at building docs for modules that are not libraries
1 parent 1332572 commit 388c331

31 files changed

+205
-160
lines changed

‎Sources/PackageMetadata/Manifests/DigraphExplorer.Nodes (ext).swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ extension DigraphExplorer<TargetNode>.Nodes
55
{
66
/// Returns *all* targets in the index that are included, directly or indirectly,
77
/// by the given product.
8-
func included(by product:PackageManifest.Product,
8+
func included(by product:SPM.Manifest.Product,
99
on platform:SymbolGraphMetadata.Platform) throws -> Set<String>
1010
{
1111
var explorer:DigraphExplorer<TargetNode> = .init(nodes: self)
@@ -26,12 +26,12 @@ extension DigraphExplorer<TargetNode>.Nodes
2626
/// by at least one of the given products. The targets are canonically ordered by
2727
/// their internal dependency relationships; targets that appear later in the list
2828
/// depend only on targets that appear before them in the list.
29-
func included(by products:[PackageManifest.Product],
29+
func included(by products:[SPM.Manifest.Product],
3030
on platform:SymbolGraphMetadata.Platform) throws -> [TargetNode]
3131
{
3232
var explorer:DigraphExplorer<TargetNode> = .init(nodes: self)
3333

34-
for product:PackageManifest.Product in products
34+
for product:SPM.Manifest.Product in products
3535
{
3636
for name:String in product.targets
3737
{

‎Sources/PackageMetadata/Manifests/PackageNode (ext).swift

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,18 @@ import Symbols
55
extension PackageNode
66
{
77
public static
8-
func libraries(as id:consuming Symbol.Package,
9-
flattening manifest:borrowing PackageManifest,
10-
platform:borrowing SymbolGraphMetadata.Platform) throws -> Self
8+
func all(flattening manifest:borrowing SPM.Manifest,
9+
on platform:borrowing SymbolGraphMetadata.Platform,
10+
as id:consuming Symbol.Package) throws -> Self
1111
{
12-
try .init(as: id, flattening: manifest, platform: platform)
13-
{
14-
switch $0
15-
{
16-
case .library: true
17-
case _: false
18-
}
19-
}
12+
try .init(as: id, flattening: manifest, platform: platform) { _ in true }
2013
}
21-
public
14+
}
15+
extension PackageNode
16+
{
17+
private
2218
init(as id:Symbol.Package,
23-
flattening manifest:borrowing PackageManifest,
19+
flattening manifest:borrowing SPM.Manifest,
2420
platform:borrowing SymbolGraphMetadata.Platform,
2521
filter predicate:(SymbolGraphMetadata.ProductType) throws -> Bool) throws
2622
{
@@ -33,9 +29,9 @@ extension PackageNode
3329
}
3430
private
3531
init(id:Symbol.Package,
36-
predecessors:[PackageManifest.Dependency],
32+
predecessors:[SPM.Manifest.Dependency],
3733
platform:borrowing SymbolGraphMetadata.Platform,
38-
products:borrowing [PackageManifest.Product],
34+
products:borrowing [SPM.Manifest.Product],
3935
targets:borrowing DigraphExplorer<TargetNode>.Nodes,
4036
root:Symbol.FileBase) throws
4137
{

‎Sources/PackageMetadata/Manifests/PackageManifest.Dependency.Filesystem.swift renamed to ‎Sources/PackageMetadata/Manifests/SPM.Manifest.Dependency.Filesystem.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import JSON
22
import PackageGraphs
33
import Symbols
44

5-
extension PackageManifest.Dependency
5+
extension SPM.Manifest.Dependency
66
{
77
@frozen public
88
struct Filesystem:Equatable, Sendable
@@ -20,7 +20,7 @@ extension PackageManifest.Dependency
2020
}
2121
}
2222
}
23-
extension PackageManifest.Dependency.Filesystem:JSONObjectDecodable
23+
extension SPM.Manifest.Dependency.Filesystem:JSONObjectDecodable
2424
{
2525
public
2626
enum CodingKey:String, Sendable

‎Sources/PackageMetadata/Manifests/PackageManifest.Dependency.Resolvable.swift renamed to ‎Sources/PackageMetadata/Manifests/SPM.Manifest.Dependency.Resolvable.swift

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,30 @@ import SemanticVersions
44
import SHA1
55
import Symbols
66

7-
extension PackageManifest.Dependency
7+
extension SPM.Manifest.Dependency
88
{
99
@frozen public
1010
struct Resolvable:Equatable, Sendable
1111
{
1212
public
1313
let id:Symbol.Package
1414
public
15-
let requirement:PackageManifest.DependencyRequirement
15+
let requirement:SPM.Manifest.DependencyRequirement
1616
public
17-
let location:PackageManifest.DependencyLocation
17+
let location:SPM.DependencyLocation
1818

1919
@inlinable public
2020
init(id:Symbol.Package,
21-
requirement:PackageManifest.DependencyRequirement,
22-
location:PackageManifest.DependencyLocation)
21+
requirement:SPM.Manifest.DependencyRequirement,
22+
location:SPM.DependencyLocation)
2323
{
2424
self.id = id
2525
self.requirement = requirement
2626
self.location = location
2727
}
2828
}
2929
}
30-
extension PackageManifest.Dependency.Resolvable:JSONObjectDecodable
30+
extension SPM.Manifest.Dependency.Resolvable:JSONObjectDecodable
3131
{
3232
public
3333
enum CodingKey:String, Sendable

‎Sources/PackageMetadata/Manifests/PackageManifest.Dependency.swift renamed to ‎Sources/PackageMetadata/Manifests/SPM.Manifest.Dependency.swift

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import JSON
22
import PackageGraphs
33
import Symbols
44

5-
extension PackageManifest
5+
extension SPM.Manifest
66
{
77
@frozen public
88
enum Dependency:Equatable, Sendable
@@ -11,7 +11,7 @@ extension PackageManifest
1111
case resolvable(Resolvable)
1212
}
1313
}
14-
extension PackageManifest.Dependency:Identifiable
14+
extension SPM.Manifest.Dependency:Identifiable
1515
{
1616
@inlinable public
1717
var id:Symbol.Package
@@ -23,10 +23,10 @@ extension PackageManifest.Dependency:Identifiable
2323
}
2424
}
2525
}
26-
extension PackageManifest.Dependency
26+
extension SPM.Manifest.Dependency
2727
{
2828
@inlinable public
29-
var requirement:PackageManifest.DependencyRequirement?
29+
var requirement:SPM.Manifest.DependencyRequirement?
3030
{
3131
if case .resolvable(let dependency) = self
3232
{
@@ -38,7 +38,7 @@ extension PackageManifest.Dependency
3838
}
3939
}
4040
}
41-
extension PackageManifest.Dependency:JSONObjectDecodable
41+
extension SPM.Manifest.Dependency:JSONObjectDecodable
4242
{
4343
public
4444
enum CodingKey:String, Sendable

‎Sources/PackageMetadata/Manifests/PackageManifest.DependencyRequirement.swift renamed to ‎Sources/PackageMetadata/Manifests/SPM.Manifest.DependencyRequirement.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import SHA1
22
import SymbolGraphs
33

4-
extension PackageManifest
4+
extension SPM.Manifest
55
{
66
@frozen public
77
enum DependencyRequirement:Hashable, Equatable, Sendable
@@ -11,7 +11,7 @@ extension PackageManifest
1111
case stable (SymbolGraphMetadata.DependencyRequirement)
1212
}
1313
}
14-
extension PackageManifest.DependencyRequirement
14+
extension SPM.Manifest.DependencyRequirement
1515
{
1616
@inlinable public
1717
var stable:SymbolGraphMetadata.DependencyRequirement?

‎Sources/PackageMetadata/Manifests/PackageManifest.Product.swift renamed to ‎Sources/PackageMetadata/Manifests/SPM.Manifest.Product.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import JSON
22
import SymbolGraphs
33

4-
extension PackageManifest
4+
extension SPM.Manifest
55
{
66
@frozen public
77
struct Product:Equatable, Sendable
@@ -22,7 +22,7 @@ extension PackageManifest
2222
}
2323
}
2424
}
25-
extension PackageManifest.Product:JSONObjectDecodable
25+
extension SPM.Manifest.Product:JSONObjectDecodable
2626
{
2727
public
2828
enum CodingKey:String, Sendable

‎Sources/PackageMetadata/PackageManifest.swift renamed to ‎Sources/PackageMetadata/Manifests/SPM.Manifest.swift

Lines changed: 44 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -4,47 +4,55 @@ import SemanticVersions
44
import SymbolGraphs
55
import Symbols
66

7+
@available(*, deprecated, renamed: "SPM.Manifest")
78
public
8-
struct PackageManifest:Equatable, Sendable
9-
{
10-
/// The name of the package. This is *not* always the same as the package’s
11-
/// identity, but often is. Some packages use this field to store a “marketing
12-
/// name” for the package, such as `Swift Argument Parser`.
13-
public
14-
let name:String
15-
public
16-
let root:Symbol.FileBase
17-
public
18-
let requirements:[SymbolGraphMetadata.PlatformRequirement]
19-
public
20-
let dependencies:[Dependency]
21-
public
22-
let products:[Product]
23-
public
24-
let targets:[TargetNode]
25-
/// The `swift-tools-version` format of this manifest.
26-
public
27-
let format:PatchVersion
9+
typealias PackageManifest = SPM.Manifest
2810

29-
@inlinable public
30-
init(name:String,
31-
root:Symbol.FileBase,
32-
requirements:[SymbolGraphMetadata.PlatformRequirement] = [],
33-
dependencies:[Dependency] = [],
34-
products:[Product] = [],
35-
targets:[TargetNode] = [],
36-
format:PatchVersion)
11+
extension SPM
12+
{
13+
/// Manifest ur destiny ✨
14+
@frozen public
15+
struct Manifest:Equatable, Sendable
3716
{
38-
self.name = name
39-
self.root = root
40-
self.requirements = requirements
41-
self.dependencies = dependencies
42-
self.products = products
43-
self.targets = targets
44-
self.format = format
17+
/// The name of the package. This is *not* always the same as the package’s
18+
/// identity, but often is. Some packages use this field to store a “marketing
19+
/// name” for the package, such as `Swift Argument Parser`.
20+
public
21+
let name:String
22+
public
23+
let root:Symbol.FileBase
24+
public
25+
let requirements:[SymbolGraphMetadata.PlatformRequirement]
26+
public
27+
let dependencies:[Dependency]
28+
public
29+
let products:[Product]
30+
public
31+
let targets:[TargetNode]
32+
/// The `swift-tools-version` format of this manifest.
33+
public
34+
let format:PatchVersion
35+
36+
@inlinable public
37+
init(name:String,
38+
root:Symbol.FileBase,
39+
requirements:[SymbolGraphMetadata.PlatformRequirement] = [],
40+
dependencies:[Dependency] = [],
41+
products:[Product] = [],
42+
targets:[TargetNode] = [],
43+
format:PatchVersion)
44+
{
45+
self.name = name
46+
self.root = root
47+
self.requirements = requirements
48+
self.dependencies = dependencies
49+
self.products = products
50+
self.targets = targets
51+
self.format = format
52+
}
4553
}
4654
}
47-
extension PackageManifest:JSONObjectDecodable
55+
extension SPM.Manifest:JSONObjectDecodable
4856
{
4957
public
5058
enum CodingKey:String, Sendable

‎Sources/PackageMetadata/Resolutions/PackageManifest.DependencyPin.V1.swift renamed to ‎Sources/PackageMetadata/Resolutions/SPM.DependencyPin.V1.swift

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
import JSON
22

3-
extension PackageManifest.DependencyPin
3+
extension SPM.DependencyPin
44
{
55
struct V1
66
{
7-
let value:PackageManifest.DependencyPin
7+
let value:SPM.DependencyPin
88

99
private
10-
init(value:PackageManifest.DependencyPin)
10+
init(value:SPM.DependencyPin)
1111
{
1212
self.value = value
1313
}
1414
}
1515
}
1616

17-
extension PackageManifest.DependencyPin.V1:JSONObjectDecodable
17+
extension SPM.DependencyPin.V1:JSONObjectDecodable
1818
{
1919
public
2020
enum CodingKey:String, Sendable
@@ -28,7 +28,7 @@ extension PackageManifest.DependencyPin.V1:JSONObjectDecodable
2828
public
2929
init(json:JSON.ObjectDecoder<CodingKey>) throws
3030
{
31-
let location:PackageManifest.DependencyLocation = .init(
31+
let location:SPM.DependencyLocation = .init(
3232
location: try json[.location].decode())
3333

3434
self.init(value: .init(id: .init(location.name),

‎Sources/PackageMetadata/Resolutions/PackageManifest.DependencyPin.V2.swift renamed to ‎Sources/PackageMetadata/Resolutions/SPM.DependencyPin.V2.swift

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
import JSON
22

3-
extension PackageManifest.DependencyPin
3+
extension SPM.DependencyPin
44
{
55
struct V2
66
{
7-
let value:PackageManifest.DependencyPin
7+
let value:SPM.DependencyPin
88

99
private
10-
init(value:PackageManifest.DependencyPin)
10+
init(value:SPM.DependencyPin)
1111
{
1212
self.value = value
1313
}
1414
}
1515
}
1616

17-
extension PackageManifest.DependencyPin.V2:JSONObjectDecodable
17+
extension SPM.DependencyPin.V2:JSONObjectDecodable
1818
{
1919
public
2020
enum CodingKey:String, Sendable
@@ -27,8 +27,8 @@ extension PackageManifest.DependencyPin.V2:JSONObjectDecodable
2727
public
2828
init(json:JSON.ObjectDecoder<CodingKey>) throws
2929
{
30-
let location:PackageManifest.DependencyLocation
31-
switch try json[.type].decode(to: PackageManifest.DependencyPinType.self)
30+
let location:SPM.DependencyLocation
31+
switch try json[.type].decode(to: SPM.DependencyPinType.self)
3232
{
3333
case .localSourceControl:
3434
location = .local(root: try json[.location].decode())

0 commit comments

Comments
 (0)