Refinery

How to contribute

With Eclipse IDE

1. Download and install a Java 17 compatible JDK. For Windows, prefer OpenJDK builds from Adoptium.

2. Download and extract the Eclipse IDE for Java and DSL Developers 2022-09 package.

3. Launch Eclipse and create a new workspace.

4. Open Help > Install New Software... and install the following software from the 2022-09 update site:

   • Modeling > Ecore Diagram Editor (SDK)

5. Open Help > Eclipse Marketplace and install the following software:

   • EclEmma Java Code Coverage
   • SonarLint

6. Open Window > Preferences and set the following preferences:

   • General > Workspace > Text file encoding should be UTF-8.
   • General > Workspace > New text file line delimiter should be Unix.
   • Add the JDK 17 to Java > Installed JREs.
   • Make sure JDK 17 is selected for JavaSE-17 at Java > Installed JREs > Execution Environments.
   • Set Gradle > Java home to the JAVA_HOME directory (the directory which contains the bin directory) of JDK 17. Here, Buildship will show a yellow warning sign, which can be safely ignored.
   • Set Java > Compiler > JDK Compliance > Compiler compliance level to 17.

7. Clone the project Git repository but do not import it into Eclipse yet.

8. Open a new terminal an run ./gradlew prepareEclipse (.\gradlew prepareEclipse on Windows) in the cloned repository.

   • This should complete without any compilation errors.
   • If you get any errors about the JVM version, check whether the JAVA_HOME environment variable is set to the location of JDK. You can query the variable with echo $JAVA_HOME on Linux and echo $Env:JAVA_HOME in PowerShell on Windows. To set it, use export JAVA_HOME=/java/path/here or $Env:JAVA_HOME="C:\java\path\here", respectively.
   • If the build fails with a Host name must not be empty error, you might need to remove the empty proxy configuration from your global gradle.properties file.

9. Select File > Import... > Gradle > Existing Gradle Project and import the cloned repository in Eclipse.

   • Make sure to select the root of the repository (containing this file) as the Project root directory and that the Gradle distribution is Gradle wrapper.
   • If you have previously imported the project into Eclipse, this step will likely fail. In that case, you should remove the projects from Eclipse, run git clean -fxd in the repository, and start over from step 8.

With IntelliJ IDEA

It is possible to import the project into IntelliJ IDEA, but it gives no editing help for Xtext (*.xtext), MWE2 (*.mwe2), and Xtend (*.xtend) and Ecore class diagrams (*.aird, *.ecore, *.genmodel).

License

Copyright (c) 2021-2023 The Refinery Authors

Refinery is available under the Eclipse Public License - v 2.0.

Refinery complies with the REUSE Specification – Version 3.0 to provide copyright and licensing information to each file, including files available under other licenses. For more information, see the comments headers in each file and the license texts in the LICENSES directory.