Yehowshua/ZIm
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: More Java extension documentation (#19390)

Browse source 
Follow up of: https://github.com/zed-industries/zed/pull/19113
This commit is contained in:
Peter Tripp 2024-10-17 20:21:45 -04:00 • committed by GitHub
parent 2bcf9fc490
commit 5168fc27a1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 11 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

19
docs/src/languages/java.md
View file

@ -12,10 +12,10 @@ Both use:
## Pre-requisites ## Pre-requisites
You will need to install both a Java runtime (OpenJDK) and Eclipse JDT Language Server (`eclipse.jdt.ls`).
### Install OpenJDK ### Install OpenJDK
You will need to install a Java runtime (OpenJDK).
- MacOS: `brew install openjdk` - MacOS: `brew install openjdk`
- Ubuntu: `sudo add-apt-repository ppa:openjdk-23 && sudo apt-get install openjdk-23` - Ubuntu: `sudo add-apt-repository ppa:openjdk-23 && sudo apt-get install openjdk-23`
- Windows: `choco install openjdk` - Windows: `choco install openjdk`
@ -23,7 +23,11 @@ You will need to install both a Java runtime (OpenJDK) and Eclipse JDT Language
Or manually download and install [OpenJDK 23](https://jdk.java.net/23/). Or manually download and install [OpenJDK 23](https://jdk.java.net/23/).
### Install JDTLS ### (Optional) Install JDTLS
If you are using Java with Eclipse JDTLS, you can skip this section as it will automatically download a binary for you.
If you are using Zed Java you need to install your own copy of Eclipse JDT Language Server (`eclipse.jdt.ls`).
- MacOS: `brew install jdtls` - MacOS: `brew install jdtls`
- Arch: [`jdtls` from AUR](https://aur.archlinux.org/packages/jdtls) - Arch: [`jdtls` from AUR](https://aur.archlinux.org/packages/jdtls)
@ -40,7 +44,7 @@ We recommend you install one or the other and not both.
## Settings / Initialization Options ## Settings / Initialization Options
See [JDTLS Language Server Settings & Capabilities](https://github.com/eclipse-jdtls/eclipse.jdt.ls/wiki/Language-Server-Settings-&-Capabilities) for a complete list of options. See [JDTLS Language Server Settings & Capabilities](https://github.com/eclipse-jdtls/eclipse.jdt.ls/wiki/Language-Server-Settings-&-Capabilities) for a complete list of settings.
Add the following to your Zed Settings by launching {#action zed::OpenSettings}({#kb zed::OpenSettings}). Add the following to your Zed Settings by launching {#action zed::OpenSettings}({#kb zed::OpenSettings}).
@ -52,7 +56,6 @@ Add the following to your Zed Settings by launching {#action zed::OpenSettings}(
"jdtls": { "jdtls": {
"settings": {}, "settings": {},
"initialization_options": {} "initialization_options": {}
}
} }
} }
} }
@ -76,7 +79,7 @@ Add the following to your Zed Settings by launching {#action zed::OpenSettings}(
- [Zed Java Readme](https://github.com/zed-extensions/java) - [Zed Java Readme](https://github.com/zed-extensions/java)
- [Java with Eclipse JDTLS Readme](https://github.com/ABckh/zed-java-eclipse-jdtls) - [Java with Eclipse JDTLS Readme](https://github.com/ABckh/zed-java-eclipse-jdtls)
### Support ## Support
If you have issues with either of these plugins, please open issues on their respective repositories: If you have issues with either of these plugins, please open issues on their respective repositories:
@ -101,7 +104,7 @@ You can optionally configure the class path that JDTLS uses with:
} }
``` ```
#### Zed Java Initialization Options ### Zed Java Initialization Options
There are also many more options you can pass directly to the language server, for example: There are also many more options you can pass directly to the language server, for example:
@ -184,7 +187,7 @@ There are also many more options you can pass directly to the language server, f
} }
``` ```
## Java with Eclipse JTDLS Configuration {#zed-java-eclipse-configuration} ### Java with Eclipse JTDLS Configuration {#zed-java-eclipse-configuration}
Configuration options match those provided in the [redhat-developer/vscode-java extension](https://github.com/redhat-developer/vscode-java#supported-vs-code-settings). Configuration options match those provided in the [redhat-developer/vscode-java extension](https://github.com/redhat-developer/vscode-java#supported-vs-code-settings).