Requirements#

It is highly recommended to use the Eclipse framework to develop on the XSMP modeler.

The Eclipse IDE for Java and DSL Developers package can be downloaded from here.

Import XSMP projects into your workspace#

File → Imports… → Projects from Git (with smart import) → Clone URI and specify the URI of this repository. All XSMP projects should be imported in your workspace.

Configure the Target platform#

The XSMP modeler comes with a target platform that defines all the required plugins for development.

Select the org.eclipse.xsmp.target in the Window → Preferences → Plug-in Development → Target Platform page (the plugins resolution should take a while).

Configure the Java Formatter#

All the XSMP code should be formatted with the provided Profile. Import the formatter-java-eclipse.xml file in Window → Preferences → Java → Code Style → Formatter and select the XSMP profile.

Build the project#

Many files are generated by the build process. To build the project, execute mvn install in the command line interface. Additionally, run ./gradlew updateVersion build vscodeExtension` to ensure a comprehensive build process.

Check in the console that the build is a success.

Now, all the projects in the Project Explorer should be valid.

Plugins architecture#

  • org.eclipse.xsmp: The core plugin for Xsmp language

  • org.eclipse.xsmp.lib: The runtime library for Xsmp projects

  • org.eclipse.xsmp.ide: The ide plugin for eclipse

  • org.eclipse.xsmp.ui: The Eclipse UI for Xsmp: editors, wizards, …

  • org.eclipse.xsmp.target: The Eclipse target Platform to use for development

  • org.eclipse.xsmp.test: Tests for the core plugin

  • org.eclipse.xsmp.ui.test: Tests for the ui plugin

  • org.eclipse.xsmp.feature: Eclipse feature for Xsmp

  • org.eclipse.xsmp.repository: Xsmp Eclipse repository

Test your local changes#

A Launch configuration is provided to run an Eclipse Application with all your local changes: Run → Run Configurations… → Eclipse Application → Launch Runtime Eclipse → Run