Skip to content
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.

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

Add support for getting classpath from kscript kts #235

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,5 @@ private fun ignoredPathPatterns(path: Path): List<PathMatcher> =
private fun asClassPathProvider(path: Path): ClassPathResolver? =
MavenClassPathResolver.maybeCreate(path)
?: GradleClassPathResolver.maybeCreate(path)
?: KScriptClassPathResolver.maybeCreate(path)
?: ShellClassPathResolver.maybeCreate(path)
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
package org.javacs.kt.classpath

import org.javacs.kt.LOG
import java.nio.file.Path

/** Resolver for reading maven dependencies */
internal class KScriptClassPathResolver private constructor(private val script: Path) : ClassPathResolver {
override val resolverType: String = "KScript"
override val classpath: Set<Path> get() {
val artifacts = readKScriptDependencyList(script)

when {
artifacts.isEmpty() -> LOG.warn("No artifacts found in {}", script)
artifacts.size < 5 -> LOG.info("Found {} in {}", artifacts, script)
else -> LOG.info("Found {} artifacts in {}", artifacts.size, script)
}

return artifacts.mapNotNull { findMavenArtifact(it, false) }.toSet()
}

companion object {
/** Create a maven resolver if a file is a pom. */
fun maybeCreate(file: Path): KScriptClassPathResolver? =
file.takeIf {
it.toString().endsWith("kts") &&
it.toFile().bufferedReader().use { b -> b.readLine().contains("kscript") }
}?.let { KScriptClassPathResolver(file) }
}
}

private val artifactPattern = "^//DEPS .*".toRegex()

private fun readKScriptDependencyList(script: Path): Set<Artifact> =
script.toFile()
.readLines()
.filter { artifactPattern.matches(it) }
.flatMap { it.substring("//DEPS ".length).split(",") }
.map { parseMavenArtifact(it) }
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a bit worried that this resolver is coupled too closely to Maven. What happens if e.g. a user uses Gradle instead? If we want to go this route, we might want to make it more generic, e.g. support different resolvers via //DEPS maven:..., gradle:... or even plain JARs.

Also I would probably go with a different prefix. //DEPS feels both a bit generic and magical at the same time. Perhaps we should mention the language server, i.e. something like

  • // kotlin-language-server: ...
  • // kls-deps: ...
  • // kls-classpath: ...

or similar. The last option would have the advantage of being consistent with our ShellClassPathResolver, which uses a file called kls-classpath to resolve the dependencies.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the same, consider that kscript already resolves the dependencies, so I think kscript should be used to obtain the dependencies, the problem would be that kscript does not yet have an option to return the path of these dependencies, this PR adds this function but is pending merging.

As a test, I created a bash script to generate the kls-classpath file with this new feature of listing dependencies.

Another point would be the syntax of //DEPS is from kscript (or rather inherited from Jbang), but currently kscript has it deprecated, the currently recommended one would be this.

.toSet()
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ private fun readMavenDependencyList(mavenOutput: Path): Set<Artifact> =
.map { parseMavenArtifact(it) }
.toSet()

private fun findMavenArtifact(a: Artifact, source: Boolean): Path? {
internal fun findMavenArtifact(a: Artifact, source: Boolean): Path? {
val result = mavenHome.resolve("repository")
.resolve(a.group.replace('.', File.separatorChar))
.resolve(a.artifact)
Expand Down