Skip to content

Latest commit

 

History

History
105 lines (68 loc) · 5.77 KB

eclipseSetup.adoc

File metadata and controls

105 lines (68 loc) · 5.77 KB

Eclipse Setup

System Requirements

In all cases, Java 11 is required to be installed on your system. Node.js version 10+ is also required, and for some tests you need Yarn to be globally installed.

Contribute

Eclipse developers who want to develop N4JS itself should use the Oomph Eclipse installer. The N4JS project is listed under "Eclipse Projects/N4JS" This setup installs the correct Eclipse version, creates a new workspace and clones all projects into it (for details see below).

Eclipse Installer

The recommended way to install the Eclipse IDE and set up the workspace is to use the Eclipse Installer. This installer is to be downloaded from https://wiki.eclipse.org/Eclipse_Installer

Run the installer and apply the following steps:

  1. change to "Advance Mode" via the menu (upper-right corner) (no need to move the installer)

  2. select a product, e.g. "Eclipse IDE for Eclipse Committers" with product version "2019-06". Hint: Do not select "latest" because this will cause automatic updates which may lead to weird errors later on.

  3. double-click the entry Eclipse Projects/N4JS so that it is shown in the catalog view below

  4. on the next page, configure paths accordingly. You only have to configure the installation and workspace folder. You may want to use git with https instead of ssh.

  5. start installation

The installer will then guide you through the rest of the installation. All plug-ins are downloaded and configured automatically, so is the workspace including downloading the git repository and setting up the workspace.

The workspace is configured automatically. This includes fetching the necessary git repository. If you have selected git with SSH you may run into problems. In this case you can re-run the scripts and select HTTPS instead, this should work in any case.

Eventually the installer scripts are done, that means the git repository has been cloned and the workspace has been configured (including the project set setup). Now the automatic build kicks in as you can see in the status bar.

The build will show a lot of errors while still working. Eventually the whole project should have been compiled without any errors. Unfortunately, due to a known issue, two problems exists. Please have a look at the linked issue on how to fix that (it is quite easy).

Changing the Setup Script

The setup scripts is stored at

n4js/releng/org.eclipse.n4js.targetplatform/N4JS.setup

Details about Oomph-Setup scripts can be found at

Manual IDE Configuration

Warning
 Manual IDE configuration is not recommended!

For a manual install, clone the code and import all top-level projects from the docs, features, plugins, releng, testhelpers, and tests folders. Activate the targetplatform contained in the releng/org.eclipse.n4js.targetplatform/ project.

The N4JS IDE is developed with Eclipse 2019-06 or better since the system is based on Eclipse anyway. It is almost impossible to use another IDE to develop Eclipse plugins. The list of required plugins includes:

It is important to use the latest version of Xtext and the corresponding service release of Xcore. You will find the latest version numbers and plugins used in the target platform definition at https://github.com/eclipse/n4js/blob/master/releng/org.eclipse.n4js.targetplatform/org.eclipse.n4js.targetplatform.target

You may need to adjust some settings in Eclipse, most importantly

  • Text file encoding to Other: UTF-8 and

  • New text file line delimiter to Unix .

LSP and Visual Studio Code

To use the LSP server in combination with VS Code, the N4JS VSCode extension is necessary. Usually, this can be installed via VS Code marketplace and/or distributable package. For development purposes, a third why of installing the N4JS VSCode extension is recommended.

Setup N4JS VSCode Extension

Follow these steps to setup the N4JS VSCode Extension for development purposes: * Create a symlink folder from the extension directory of VSCode ~/.vscode/extensions/ to the implementation inside the n4js git clone git/n4js/lsp-clients/n4js-vscode-extension. * Run npm install inside the n4js-vscode-extension. * Restart/reload VSCode * Check VSCode output called N4JS LSP Server for output messages.

This extension will download several dependencies such as n4js-cli which contains n4jsc.jar that is used to start the lsp server. In case a locally started lsp server should be used instead, e.g. for debugging purposes, start an lsp server before starting VSCode on port 5007.

Local Changes on N4js-Libs

In case of local changes of n4js-libs one way of including them is to use a local verdaccio. The verdaccio is first populated by running maven, and then used when executing npm install in the directory n4js-vscode-extension.

  • Start docker

  • Run maven with: mvn -DnoTests clean verify

  • Start and populate a local verdaccio server with: ./releng/utils/scripts/start-verdaccio.sh

  • Change directory to n4js-vscode-extension

  • Remove node_modules folder and package-lock.json file

  • Install from local verdaccio with: npm install --registry http://localhost:4873