docs: add Java and Python LSP configuration examples to README #1350
+82
−3
Conversation
This file contains hidden or 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
The LSP section only showed TypeScript configuration. Add examples for Java (jdtls) and Python (pylsp) — two of the most widely used languages on GitHub — including installation instructions, individual configs, and a combined multi-language configuration example.
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the README’s LSP section to provide concrete installation and lsp-config.json examples for additional languages (Java and Python), expanding beyond the previous TypeScript-only guidance and aligning with the goal in #1349 to improve Java/JVM usability.
Changes:
- Added install commands for TypeScript/JavaScript, Java (jdtls), and Python (pylsp).
- Split the LSP configuration example into per-language sections (TypeScript, Java, Python).
- Added a combined multi-language configuration example.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The LSP configuration section currently only shows a TypeScript example. This adds installation and configuration examples for Java (jdtls) and Python (pylsp) — two of the most widely used languages on GitHub.
Changes
Why
The README's LSP section told users to "install the corresponding LSP server and configure it following the same pattern" but only provided a TypeScript example. Java developers using jdtls face a more complex setup than TypeScript, and having a working config example removes friction.
This addresses part of #1349 (Java/JVM ecosystem awareness).
Pattern
Follows the same approach as recently merged docs PRs: