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
|
#!/bin/bash
#
# This source file is part of the Swift.org open source project
#
# Copyright (c) 2021 Apple Inc. and the Swift project authors
# Licensed under Apache License v2.0 with Runtime Library Exception
#
# See https://swift.org/LICENSE.txt for license information
# See https://swift.org/CONTRIBUTORS.txt for Swift project authors
#
# This is a test external resolver that always returns the same resolved information for every request.
# It can be used in local development to test how Swift-DocC interacts with information from an external source.
#
# To set this up, set the `DOCC_LINK_RESOLVER_EXECUTABLE` environmental variable to the path of this script.
#
# Swift-DocC will call this executable for unresolved symbol references in the processed symbol graph files and for
# absolute documentation links with the "com.test.bundle" identifier. For example: <doc://com.test.bundle/something>
RESPONSE='{
"resolvedInformation" : {
"abstract" : "Resolved abstract.",
"availableLanguages" : [
{
"id" : "swift",
"name" : "Language Name",
"idAliases" : [],
"linkDisambiguationID": "swift"
},
{
"id" : "occ",
"name" : "Variant Language Name",
"idAliases" : [
"objective-c",
"c"
],
"linkDisambiguationID" : "c"
}
],
"declarationFragments" : [
{
"kind" : "text",
"spelling" : "declaration fragment"
}
],
"kind" : {
"id" : "com.test.kind.id",
"isSymbol" : true,
"name" : "Kind Name"
},
"language" : {
"id" : "swift",
"name" : "Language Name",
"idAliases" : [],
"linkDisambiguationID": "swift"
},
"platforms" : [
{
"beta" : false,
"introducedAt" : "1.0.0",
"name" : "Platform Name"
}
],
"topicImages": [
{
"type": "card",
"identifier": "some-external-card-image-identifier"
}
],
"references": [
{
"type": "image",
"identifier": "some-external-card-image-identifier",
"variants": [
{
"url": "http:\/\/example.com\/some-image-1x.jpg",
"traits": [
"1x"
]
},
{
"url": "http:\/\/example.com\/some-image-1x-dark.jpg",
"traits": [
"1x", "dark"
]
},
{
"url": "http:\/\/example.com\/some-image-2x.jpg",
"traits": [
"2x"
]
}
]
}
],
"title" : "Resolved Title",
"url" : "doc:\/\/com.test.bundle\/resolved/path\/",
"variants" : [
{
"abstract" : "Resolved variant abstract for this topic.",
"declarationFragments" : [
{
"kind" : "text",
"spelling" : "variant declaration fragment"
}
],
"kind" : {
"id" : "com.test.other-kind.id",
"isSymbol" : true,
"name" : "Variant Kind Name"
},
"language" : {
"id" : "occ",
"name" : "Variant Language Name",
"idAliases" : [
"objective-c",
"c"
],
"linkDisambiguationID" : "c"
},
"title" : "Resolved Variant Title",
"traits" : [
{
"interfaceLanguage" : "occ"
}
]
}
]
}
}'
# Write this resolver's bundle identifier
echo '{"bundleIdentifier":"com.test.bundle"}'
# Forever, wait for DocC to send a request and respond the resolved information
while true
do
# Wait for a request
read
# Respond the resolved information
echo -e $RESPONSE
done
|
