Google Git
Sign in
apache/netbeans/refs/heads/release125/./java/java.lsp.server/vscode
tree: 015af249811efee89f343ccadafcc8cb9f874b2e
  1. .vscode/
  2. images/
  3. src/
  4. syntaxes/
  5. .eslintrc.json
  6. .gitignore
  7. .vscodeignore
  8. BUILD.md
  9. CHANGELOG.md
  10. package-lock.json
  11. package.json
  12. README.md
  13. 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! Runs on JDK8[*] and all newer versions.

Apache NetBeans Language Server brings full featured Java development (edit-compile-debug & test cycle) for Maven and Gradle projects to VSCode. As well as other features.

Getting Started

  1. Set JDK in VSCode | Preferences | Settings ... Netbeans: Jdkhome setting to point to JDK which Language Server will run on and projects will be compiled with. More below in section Selecting the JDK

  2. Use Java: New Project... " command to start creating new project, or

  3. Open the folder with existing pom.xml for Maven or Gradle project files (build.gradle, gradle.properties).

    • Language Server opens the project, performs priming build and might ask for Resolving problems, usually related to opening subprojects etc.

  4. Or simply create a new Java class file with public static void main(String[] args) method in opened folder and start coding, compiling, debugging. Works on JDK 8 and newer.

Supported Actions

  • Java: New Project... allows creation of new Maven or Gradle project
  • Java: New from Template... add various files to currently selected open project. Files are:
    • Java - broad selection of various predefined Java classes
    • Unit tests - JUnit and TestNB templates for test suites and test cases
    • HTML5/JavaScript - Templates for JS, HTML, CSS,... files
    • Other - various templates for JSON, YAML, properties, ... files
  • Java: Compile Workspace - invoke Maven or Gradle build
  • Debugger Java 8+... - start main class or test on JDK8+. More in Debugger section
  • 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.
  • Maven and Gradle support including multi-project projects, subprojects opening and Gradle priming builds.

Debugger and Launch Configurations

Language Server Java 8+ ... launch configuration supports debugging and running Java applications using JDK8 or newer.

  1. The launch configuration (debugger) is invoked when Run main | Debug main code lense is selected in the code.
  2. Or Java 8+... is selected in Run and Debug activity panel. Debug configurations

Launch Configurations

  • Launch Java 8+ App - Debug or Run current Java project
  • Launch Java: Continuous Mode - Runs Micronaut project and reloads it when source code has been changed.
  • Attach to Port & Attach to Process - Attach debugger actions. Available when Java 8+ ... at the bottom of drop down list is selected.
    • Select this configuration, then click the Run
    • Select either from available process or enter the port to connect to JVM running with JDWP.
    • Attach to Shared Memory is available on Windows in addtion to above mentioned Attach...

Default launch configurations provided by Language Server can modified in launch.json file using intellisense for available options.

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.