It is necessary to have installed:
It is recommended to build using JDK 8.
$ git clone https://github.com/apache/netbeans.git $ cd netbeans/
To build the VS Code extension invoke:
netbeans$ ant build netbeans$ cd java/java.lsp.server java.lsp.server$ ant build-vscode-ext
The resulting extension is then in the build
directory, with the .vsix
extension.
-Dvsix.version=x.y.z
can be used to set release version. E.g. set this option to 12.3.0
to get proper NetBeans release version for extension.-D3rdparty.modules=
property can be set to different value than .*nbjavac.*
to not inlcude nb-javac which allows extension to run out of the box on JDK8.The build of NetBeans VSCode extension with nb-javac included, for version 12.6.0 then looks like this:
netbeans$ ant build netbeans$ cd java/java.lsp.server java.lsp.server$ ant build-vscode-ext -Dvsix.version=12.6.0
If you want to develop the extension, use these steps for building instead:
netbeans$ cd java/java.lsp.server java.lsp.server$ ant build-lsp-server java.lsp.server$ cd vscode vscode$ npm install vscode$ npm run watch
This target is faster than building the .vsix
file. Find the instructions for running and debugging below.
Often it is also important to properly clean everything. Use:
java.lsp.server$ ant clean-vscode-ext java.lsp.server$ cd ../.. netbeans$ ant clean
The java.lsp.server
module has classical (as other NetBeans modules) tests. The most important one is ServerTest which simulates LSP communication and checks expected replies. In addition to that there are VS Code integration tests - those launch VS Code with the VSNetBeans extension and check behavior of the TypeScript integration code:
java.lsp.server$ ant build-vscode-ext # first and then java.lsp.server$ ant test-vscode-ext
In case you are behind a proxy, you may want to run the tests with
java.lsp.server$ npm_config_https_proxy=http://your.proxy.com:port ant test-vscode-ext
when executing the tests for the first time. That shall overcome the proxy and download an instance of code
execute the tests on.
Using the application yourself is the best way of testing! If you want to edit/compile/debug Apache NetBeans sources, there is a way. After building the project, execute:
vscode$ npm run apisupport
the system connects to associated autoupdate center and downloads, installs and enables org.netbeans.modules.apisupport.ant
module. With such module installed one can open Apache NetBeans projects and work with them directly from VSCode.
Have a sample Maven project, open it in NetBeans first and select the main file for both the Run and Debug actions.
To use the extension created for developement you can run VS Code with following parameter:
vscode$ code --extensionDevelopmentPath=`pwd` path_to_the_maven_project
Or you can open the vscode
folder in code
directly and use F5 to debug the extension's typescript code.
To debug the Java code, launch the NetBeans part of the VS Code system first and specify suitable debug arguments:
vscode$ npm run nbcode -- --jdkhome /jdk-14/ -J-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=8000
Connect to the process with Java debugger, setup all breakpoints. Then launch and connect from the VS Code extension:
vscode$ code --extensionDevelopmentPath=`pwd` path_to_the_maven_project