Google Git
Sign in
apache / netbeans / refs/tags/12.4 / . / java / java.lsp.server / vscode
tree: 830422ed026bd1a7d91a9734cd1f35c23900f181 [path history] [tgz]
  1. .vscode/
  2. images/
  3. src/
  4. .eslintrc.json
  5. .gitignore
  6. .vscodeignore
  7. BUILD.md
  8. CHANGELOG.md
  9. package-lock.json
  10. package.json
  11. README.md
  12. tsconfig.json
java/java.lsp.server/vscode/README.md

Apache NetBeans Language Server Extension for VS Code

This is a technology preview of Apache NetBeans based extension for VS Code. Use it to get all the goodies of NetBeans via the VS Code user interface! Run on JDK8*, JDK11, JDK15, etc.

Invoke “Open Folder” action to open project directories with pom.xml or build.gradle build scripts. Edit, compile and debug (with the Java 8+ debugger configuration) the .java application and test files in such projects. Debug not only Java code, but JavaScript, Python, Ruby polyglot programs at once.

Getting Started

Follow the online instructions to set your environment up to support typical development use-cases.

Supported Actions

  • Java: Compile Workspace - invoke Maven or Gradle build
  • GraalVM: Pause in Script - place a breakpoint into first executed polyglot script
  • Debugger Java 8+ - start test or main class on JDK8+ in polyglot mode
  • Progress shown for long running operations with cancel support for selected types
  • Native Image Debugger is a new Run configuration added which allows Java style debugging of Ahead of Time compiled native-images, produced by GraalVM. It is experimental feature which works with GDB on Linux. GDB 7.11 or GDB 10.1+ is required due to known issue #26139 in GDB 8 and 9.
  • Micronaut and Spring support especially for YAML configuration files with code completion and source code navigation to Java.
  • Test Explorer for Java tests results visualization and execution including editor code Lenses.
  • Improved Maven and Gradle support including multi-project projects, subprojects opening and Gradle priming builds.

Supported Refactorings

Class level refactorings as well as variable refactorings are supported in VSCode via Apache NetBeans extension. See following screenshots:

Class Source Actions Introduce ... refactoring

Some refactorings are two steps with like Override method ... where method to be overriden is selected in 2nd step:

Override refactoring

Test Explorer

NetBeans Language Server provides Test Explorer view which allows to run all tests in a project, examine the results, go to source code and run particular test. Test Explorer

Native Image Debugger

Experimental Support

NetBeans Language Server allows Java like debugging of native images produced by GraalVM EE native-image tool. It is provided using GDB and via new Run configuration named Launch Native Image. This experimental feature works now only on Linux with certain version of GDB, see above. GraalVM Enterprise Edition is needed as it produces full debug information for native images, at this time.

In order to debug native image applications it is necessary to build such native image with debug information available. It can be done by providing following switches for native-image tool:

  • -g -O0 or
  • -H:Debug=2 -H:Optimize=0.

Using Native Image Maven Plugin

It is possible to use Native-Image Maven Plugin to run native-image builds for Maven projects. In this case add following <buildArgs> into plugin <configuration>:

<buildArgs>
  <buildArg>-g</buildArg>
  <buildArg>-O0</buildArg>
</buildArgs>

Setting project's Maven pom.xml to skip native-image build everytime when project is being built is a good practice.

When native image is built, including debug info then add Launch Native Image configuration to launch.json. Select it in Run & Debug activity window and press F5 to debug Java source code on native image.

Supported Options

  • netbeans.jdkhome - path to the JDK, see dedicated section below
  • netbeans.verbose - enables verbose extension logging
  • netbeans.conflict.check - avoid conflicts with other Java extensions, see below

Selecting the JDK

The user projects are built, run and debugged using the same JDK which runs the Apache NetBeans Language Server. The JDK is being searched in following locations:

  • netbeans.jdkhome setting (workspace then user settings)
  • java.home setting (workspace then user settings)
  • JDK_HOME environment variable
  • JAVA_HOME environment variable
  • current system path

As soon as one of the settings is changed, the Language Server is restarted.

Conflicts with other Java Extensions

Apache NetBeans Language Server extension isn't the only Java supporting extension. To avoid duplicated code completion and other misleading clashes the extension disables certain functionality known to cause problems, this is done per Workspace.

This behavior can be disabled by setting netbeans.conflict.check setting to false.

Contributing

Read building instructions to help Apache community to improve the extension.