From 7adb4fa3cc9100d666f996afbd77f201e71b321b Mon Sep 17 00:00:00 2001 From: Kris De Volder Date: Fri, 22 Sep 2017 10:52:44 -0700 Subject: [PATCH] Add a preliminary 'dev env setup' readme --- README-dev-env.txt | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 README-dev-env.txt diff --git a/README-dev-env.txt b/README-dev-env.txt new file mode 100644 index 000000000..c877badc0 --- /dev/null +++ b/README-dev-env.txt @@ -0,0 +1,35 @@ +Setting up dev env: +------------------- + +Meta note: We do not have comprehensive or good notes yet on how to setup dev env. For now I'm just dumping some info in here that +Martin sent around in an email message as its 'the best we have' at the moment. + +The language server project is this one: +https://github.com/spring-projects/sts4/tree/master/headless-services/boot-java-language-server + +It is implemented in the same way as the other ones. If you start it from within Eclipse, you can pass: +-Dstandalone-startup=true +as VM option to the app and it will launch in server mode, waiting for a client to connect to it (rather that the client starting up its own language server). + +The VSCode extension is here: +https://github.com/spring-projects/sts4/tree/master/vscode-extensions/vscode-boot-java + +You can switch the “CONNECT_TO_LS” flag in the Main.ts file to true and the VSCode extension will use the language server that you started from Eclipse (for example in debug mode) via the option mentioned above. + +That gives you a pretty nice environment to run and debug the language server. +I would recommend to install the java language server extension from RedHat into VSCode, too. + + +If you start to work in the Eclipse STS4 client side, I recommend to use a distribution build from here as a target platform: +http://dist.springsource.com/snapshot/STS4/nightly-distributions.html + +The important project for the boot java ls integration is: +https://github.com/spring-projects/sts4/tree/master/eclipse-language-servers/org.springframework.tooling.boot.java.ls + +If you want to run the Eclipse runtime workbench so that it connects to the locally started language server (see above), you can pass these arguments as VM options: +-Dboot-java-ls-host=localhost -Dboot-java-ls-port=5007 +That way the Eclipse runtime workbench will connect to your separate language server process instead of starting up its own. + +I hope this gives you a nice getting started experience… :-) +Please do not hesitate to reach out to me anytime. +