Skip to content

IDE Support

MattiDragon edited this page Jun 28, 2024 · 1 revision

IDE Support

As of language version 1.0.0, JsonPatcher comes with a language server that can be used to add integration into various code editors. Currently, there's only a VSCode Extension, but other integrations could be added in the future.

Setting up the VSCode Extension

The JsonPatcher extension requires an installation of Java 21 or later in order to work properly. If you don't already have it installed, you can download it from https://adoptium.net/. When installing make sure to select the option to set the JAVA_HOME environment variable.

If you don't set JAVA_HOME, the extension won't be able to automatically detect the java installation, but you can still manually set it in the settings. The extension should provide you with helpful error messages if something is incorrect.

You the server ever breaks or if you otherwise need to restart it, you can use the JsonPatcher: Restart JsonPatcher language server action to do so.

Developing Support for Other Editors

If you have the technical skills and time, you're free and encouraged to implement the language server in other editors. The server is available in the GitHub releases of the lang repo. You'll want to use the JsonPatcher-Lang-Server-X.Y.Z-all.jar file.

When run using Java 21 or later, the server will listen for tcp connections on port 18092. A custom port can be specified using the --socket= command line option (name is based on vscode convention). The server only supports a single connection at a time and must be restarted if ever disconnected.

If you have any questions, please contact me on discord so that we can discuss.

Clone this wiki locally