Skip to content

update html log link to relativize the path using user.dir #166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

update html log link to relativize the path using user.dir #166

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions modules/dokkatoo-plugin/src/main/kotlin/formats/DokkatooHtmlPlugin.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,19 @@ constructor(
val indexHtmlFile = generatePublicationTask
.flatMap { it.outputDirectory.file("index.html") }

val indexHtmlPath = indexHtmlFile.map { indexHtml ->
// assume that user.dir is IntelliJ's current project directory
val userDir = providers.systemProperty("user.dir")
.map(::File)

val indexHtmlPath = providers.zip(userDir, indexHtmlFile) { baseDir, indexHtml ->
// IntelliJ built-in webserver needs the path to start with the project dir.
// E.g. If the project is in /user/rachel/my-project/
// the link should start with http://localhost:63342/my-project/<path-to-index.html>
// So, relativize the path to index.html to include the project dir name.
// (Keep composite builds in mind when changing ths property, as the project rootDir might
// not be the current IJ project dir.)
indexHtml.asFile
.relativeTo(project.rootDir.parentFile)
.relativeTo(baseDir.parentFile)
.invariantSeparatorsPath
}

Expand Down