dnrops
/
pkl-vscode
mirror of https://github.com/apple/pkl-vscode.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add Java requirement to installation instructions (#46)

This commit is contained in:
Daniel Chao 2025-02-13 13:10:09 -08:00 committed by GitHub
parent 4db5dc2264
commit 05e7e64ba4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/modules/ROOT/pages/installation.adoc
View File

@ -7,3 +7,13 @@ To install the extension,
2. follow https://code.visualstudio.com/docs/editor/extension-gallery#_install-from-a-vsix[Install from a VSIX] in the VS Code docs.
To confirm that the installation succeeded, open a _.pkl_ file and verify that syntax highlighting works.
== Java requirement
The extension currently requires Java 22+ in order to run the xref:lsp:ROOT:index.adoc[Pkl Language Server].
By default, it will look for the Java either in `PATH`, or in `JAVA_HOME`.
The path to the Java executable can also be set via the `pkl.lsp.java.path` setting.
The Java requirement will be removed when the Pkl Language Server is published as a native executable. For more details, see https://github.com/apple/pkl-lsp/issues/60.