starred/pkl
1
0
Fork 0
mirror of https://github.com/apple/pkl.git synced 2026-04-20 23:41:27 +02:00
Code Issues 198 Packages Projects Releases 10 Wiki Activity

Fix doc dependency link (#1078)

Browse Source
This commit is contained in:
Islon Scherer
2025-05-28 18:08:38 +02:00
committed by GitHub
parent 021f43bec4
commit a19e6bf684
13 changed files with 44 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
pkl-commons-test/src/main/files/packages/birds@0.5.0/birds@0.5.0.json vendored
View File

@@ -7,7 +7,7 @@
"fruities": { "fruities": {
"uri": "package://localhost:0/fruit@1.0.5", "uri": "package://localhost:0/fruit@1.0.5",
"checksums": { "checksums": {
"sha256": "34a15b02346e6acb85da5bd71d8b0738a79008b38a7fc805e5869d9129ad27d2" "sha256": "8ff80e5ac882650e817f261c8af024bf0db9b07888c9d18c20017457e04ffe06"
} }
} }
}, },

1
pkl-commons-test/src/main/files/packages/fruit@1.0.5/fruit@1.0.5.json vendored
View File

@@ -9,7 +9,6 @@
"sha256": "$computedChecksum" "sha256": "$computedChecksum"
}, },
"sourceCode": "https://example.com/fruit", "sourceCode": "https://example.com/fruit",
"documentation": "https://example.com/fruit-docs",
"license": "UNLICENSED", "license": "UNLICENSED",
"authors": [ "authors": [
"apple-1@example.com", "apple-1@example.com",

4
pkl-commons-test/src/main/kotlin/org/pkl/commons/test/PackageServer.kt
View File

@@ -44,8 +44,8 @@ import kotlin.io.path.*
@OptIn(ExperimentalPathApi::class) @OptIn(ExperimentalPathApi::class)
class PackageServer : AutoCloseable { class PackageServer : AutoCloseable {
companion object { companion object {
const val BIRDS_SHA = "6f18af649b47986530cd6dc39abe17888db2701bc5381c385fb86a32fda2685e" const val BIRDS_SHA = "b27206b80f4f227752b6f02143887f3ea41e554542cec38f7b572b987566c4de"
const val FRUIT_SHA = "34a15b02346e6acb85da5bd71d8b0738a79008b38a7fc805e5869d9129ad27d2" const val FRUIT_SHA = "8ff80e5ac882650e817f261c8af024bf0db9b07888c9d18c20017457e04ffe06"
const val FRUIT_1_1_SHA = "8d982761d182f2185e4180c82190791d9a60c721cb3393bb2e946fab90131e8c" const val FRUIT_1_1_SHA = "8d982761d182f2185e4180c82190791d9a60c721cb3393bb2e946fab90131e8c"
fun populateCacheDir(cacheDir: Path) { fun populateCacheDir(cacheDir: Path) {

2
pkl-core/src/test/files/LanguageSnippetTests/input/packages/packages1.pkl vendored
View File

@@ -16,7 +16,7 @@ examples {
import("package://localhost:0/birds@0.5.0#/catalog/Ostrich.pkl") import("package://localhost:0/birds@0.5.0#/catalog/Ostrich.pkl")
} }
["importing while specifying checksum"] { ["importing while specifying checksum"] {
import("package://localhost:0/birds@0.5.0::sha256:6f18af649b47986530cd6dc39abe17888db2701bc5381c385fb86a32fda2685e#/catalog/Swallow.pkl") import("package://localhost:0/birds@0.5.0::sha256:b27206b80f4f227752b6f02143887f3ea41e554542cec38f7b572b987566c4de#/catalog/Swallow.pkl")
} }
["reads"] { ["reads"] {
read("package://localhost:0/birds@0.5.0#/Bird.pkl") read("package://localhost:0/birds@0.5.0#/Bird.pkl")

2
pkl-core/src/test/files/LanguageSnippetTests/input/packages/packages2.pkl vendored
View File

@@ -20,6 +20,6 @@ examples {
import("package://localhost:0/birds@0.5.0#/allFruit.pkl").fruitFiles import("package://localhost:0/birds@0.5.0#/allFruit.pkl").fruitFiles
} }
["glob import while specifying checksum"] { ["glob import while specifying checksum"] {
import*("package://localhost:0/birds@0.5.0::sha256:6f18af649b47986530cd6dc39abe17888db2701bc5381c385fb86a32fda2685e#/catalog/*.pkl") import*("package://localhost:0/birds@0.5.0::sha256:b27206b80f4f227752b6f02143887f3ea41e554542cec38f7b572b987566c4de#/catalog/*.pkl")
} }
} }

2
pkl-core/src/test/files/LanguageSnippetTests/input/projects/project4/PklProject.deps.json vendored
View File

@@ -5,7 +5,7 @@
"type": "remote", "type": "remote",
"uri": "projectpackage://localhost:0/fruit@1.0.5", "uri": "projectpackage://localhost:0/fruit@1.0.5",
"checksums": { "checksums": {
"sha256": "34a15b02346e6acb85da5bd71d8b0738a79008b38a7fc805e5869d9129ad27d2" "sha256": "8ff80e5ac882650e817f261c8af024bf0db9b07888c9d18c20017457e04ffe06"
} }
} }
} }

4
pkl-core/src/test/files/LanguageSnippetTests/output/packages/packages2.pcf vendored
View File

@@ -118,13 +118,13 @@ examples {
} }
["glob import while specifying checksum"] { ["glob import while specifying checksum"] {
new { new {
["package://localhost:0/birds@0.5.0::sha256:6f18af649b47986530cd6dc39abe17888db2701bc5381c385fb86a32fda2685e#/catalog/Ostrich.pkl"] { ["package://localhost:0/birds@0.5.0::sha256:b27206b80f4f227752b6f02143887f3ea41e554542cec38f7b572b987566c4de#/catalog/Ostrich.pkl"] {
name = "Ostrich" name = "Ostrich"
favoriteFruit { favoriteFruit {
name = "Orange" name = "Orange"
} }
} }
["package://localhost:0/birds@0.5.0::sha256:6f18af649b47986530cd6dc39abe17888db2701bc5381c385fb86a32fda2685e#/catalog/Swallow.pkl"] { ["package://localhost:0/birds@0.5.0::sha256:b27206b80f4f227752b6f02143887f3ea41e554542cec38f7b572b987566c4de#/catalog/Swallow.pkl"] {
name = "Swallow" name = "Swallow"
favoriteFruit { favoriteFruit {
name = "Apple" name = "Apple"

7
pkl-doc/src/main/kotlin/org/pkl/doc/DocPackageInfo.kt
View File

@@ -23,6 +23,7 @@ import org.pkl.core.Member.SourceLocation
import org.pkl.core.PModule import org.pkl.core.PModule
import org.pkl.core.PObject import org.pkl.core.PObject
import org.pkl.core.TypeAlias import org.pkl.core.TypeAlias
import org.pkl.core.packages.PackageUri
/** API equivalent of standard library module `pkl.DocPackageInfo`. */ /** API equivalent of standard library module `pkl.DocPackageInfo`. */
data class DocPackageInfo( data class DocPackageInfo(
@@ -198,6 +199,12 @@ data class DocPackageInfo(
) { ) {
internal val prefix = "$name." internal val prefix = "$name."
val qualifiedName: String =
if (uri != null) {
val packageUri = PackageUri(uri)
"${uri.authority}${packageUri.pathWithoutVersion}"
} else name
/** Note: Returns an absolute URI, or an URI relative to the current site. */ /** Note: Returns an absolute URI, or an URI relative to the current site. */
internal fun getModuleDocUrl(moduleName: String): URI? = internal fun getModuleDocUrl(moduleName: String): URI? =
when { when {

9
pkl-doc/src/main/kotlin/org/pkl/doc/DocScope.kt
View File

@@ -35,7 +35,7 @@ internal sealed class DocScope {
abstract val parent: DocScope? abstract val parent: DocScope?
private val siteScope: SiteScope? by lazy { val siteScope: SiteScope? by lazy {
var scope = this var scope = this
while (scope !is SiteScope) { while (scope !is SiteScope) {
scope = scope.parent ?: return@lazy null scope = scope.parent ?: return@lazy null
@@ -122,7 +122,7 @@ internal abstract class PageScope : DocScope() {
// equality is identity // equality is identity
internal class SiteScope( internal class SiteScope(
docPackages: List<DocPackage>, val docPackages: List<DocPackage>,
private val overviewImports: Map<String, URI>, private val overviewImports: Map<String, URI>,
private val importResolver: (URI) -> ModuleSchema, private val importResolver: (URI) -> ModuleSchema,
outputDir: Path, outputDir: Path,
@@ -259,6 +259,11 @@ internal class PackageScope(
override val url: URI by lazy { parent.url.resolve("./${name.pathEncoded}/$version/index.html") } override val url: URI by lazy { parent.url.resolve("./${name.pathEncoded}/$version/index.html") }
fun urlForVersionRelativeTo(scope: DocScope, version: String): URI {
val myVersion = parent.url.resolve("./${name.pathEncoded}/$version/index.html")
return IoUtils.relativize(myVersion, scope.url)
}
override val dataUrl: URI by lazy { override val dataUrl: URI by lazy {
parent.url.resolve("./data/${name.pathEncoded}/$version/index.js") parent.url.resolve("./data/${name.pathEncoded}/$version/index.js")
} }

27
pkl-doc/src/main/kotlin/org/pkl/doc/PageGenerator.kt
View File

@@ -525,15 +525,16 @@ internal abstract class PageGenerator<out S>(
var first = true var first = true
for (dep in dependencies) { for (dep in dependencies) {
if (first) first = false else +", " if (first) first = false else +", "
a { val link = getDependencyLink(dep)
href = if (link != null) {
dep.documentation?.toString() a {
?: pageScope.relativeSiteUrl href = link
.resolve("${dep.name}/${dep.version}/index.html") +dep.name
.toString() +":"
+dep.name +dep.version
+":" }
+dep.version } else {
span { +"${dep.name}:${dep.version}" }
} }
} }
} }
@@ -556,6 +557,14 @@ internal abstract class PageGenerator<out S>(
return result return result
} }
private fun getDependencyLink(dep: DocPackageInfo.PackageDependency): String? {
val siteScope = pageScope.siteScope ?: return null
return siteScope.packageScopes.values
.find { it.name == dep.qualifiedName }
?.urlForVersionRelativeTo(pageScope, dep.version)
?.toString()
}
protected class MemberInfoKey(val name: String, val classes: Set<String> = setOf()) protected class MemberInfoKey(val name: String, val classes: Set<String> = setOf())
protected fun collectMemberInfo( protected fun collectMemberInfo(

2
pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/index.html vendored
View File

@@ -39,7 +39,7 @@
<dt class="">Issue tracker:</dt> <dt class="">Issue tracker:</dt>
<dd><a href="https://issues.apple.com/package1/">https://issues.apple.com/package1/</a></dd> <dd><a href="https://issues.apple.com/package1/">https://issues.apple.com/package1/</a></dd>
<dt class="">Dependencies:</dt> <dt class="">Dependencies:</dt>
<dd><a href="../../com.package2/4.5.6/index.html">com.package2:4.5.6</a>, <a href="https://example.com/docs/externalpackage/">com.externalpackage:7.8.9</a></dd> <dd><a href="../../com.package2/4.5.6/index.html">com.package2:4.5.6</a>, <span>com.externalpackage:7.8.9</span></dd>
<dt class="runtime-data hidden">Known usages:</dt> <dt class="runtime-data hidden">Known usages:</dt>
<dd id="known-usages" class="runtime-data hidden"></dd> <dd id="known-usages" class="runtime-data hidden"></dd>
<dt class="runtime-data hidden">All versions:</dt> <dt class="runtime-data hidden">All versions:</dt>

2
pkl-doc/src/test/files/DocGeneratorTest/output/localhost(3a)0/birds/0.5.0/Bird/index.html vendored
View File

@@ -74,7 +74,7 @@
<div class="member-modifiers"></div> <div class="member-modifiers"></div>
</div> </div>
<div class="member-main"> <div class="member-main">
<div class="member-signature"><span class="name-decl">favoriteFruit</span>: <a href="https://example.com/Fruit/index.html" class="name-ref">Fruit</a><a class="member-source-link" href="https://example.com/birds/v0.5.0/blob/Bird.pkl#L123-L456">Source</a></div> <div class="member-signature"><span class="name-decl">favoriteFruit</span>: <a href="../../../../fruit/1.0.5/Fruit/index.html" class="name-ref">Fruit</a><a class="member-source-link" href="https://example.com/birds/v0.5.0/blob/Bird.pkl#L123-L456">Source</a></div>
</div> </div>
</div> </div>
</li> </li>

4
pkl-doc/src/test/files/DocGeneratorTest/output/localhost(3a)0/birds/0.5.0/index.html vendored
View File

@@ -37,9 +37,9 @@
<dt class="">Issue tracker:</dt> <dt class="">Issue tracker:</dt>
<dd><a href="https://example.com/birds/issues">https://example.com/birds/issues</a></dd> <dd><a href="https://example.com/birds/issues">https://example.com/birds/issues</a></dd>
<dt class="">Dependencies:</dt> <dt class="">Dependencies:</dt>
<dd><a href="https://example.com/fruit-docs">fruit:1.0.5</a></dd> <dd><a href="../../fruit/1.0.5/index.html">fruit:1.0.5</a></dd>
<dt class="">Checksum:</dt> <dt class="">Checksum:</dt>
<dd>6f18af649b47986530cd6dc39abe17888db2701bc5381c385fb86a32fda2685e</dd> <dd>b27206b80f4f227752b6f02143887f3ea41e554542cec38f7b572b987566c4de</dd>
<dt class="runtime-data hidden">Known usages:</dt> <dt class="runtime-data hidden">Known usages:</dt>
<dd id="known-usages" class="runtime-data hidden"></dd> <dd id="known-usages" class="runtime-data hidden"></dd>
<dt class="runtime-data hidden">All versions:</dt> <dt class="runtime-data hidden">All versions:</dt>