-
Notifications
You must be signed in to change notification settings - Fork 196
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
Monkopedia
wants to merge
1
commit into
fwcd:main
Choose a base branch
from
Monkopedia:KScriptClasspath
base: main
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
39 changes: 39 additions & 0 deletions
39
shared/src/main/kotlin/org/javacs/kt/classpath/KScriptClassPathResolver.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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) } | ||
| .toSet() | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.
//DEPSfeels 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 calledkls-classpathto resolve the dependencies.There was a problem hiding this comment.
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
//DEPSis from kscript (or rather inherited from Jbang), but currently kscript has it deprecated, the currently recommended one would be this.