AvaloniaRider

Install

Development releases (may be unstable)

To install a development release (automatically published for every push into the master branch), first add the custom plugin repository into your IDE (see the documentation on how to do that).

Custom plugin repository address: https://plugins.jetbrains.com/plugins/dev/14839

Then, install the plugin as usual via the IDE plugin settings screen.

Install from GitHub (any build from the master branch or PR; may be unstable)

To install a plugin distribution built by GitHub Actions, open the Actions page for the commit you want to install (e.g. here's a build list for the master branch), and then download the artifact named avaloniarider-{version}.

After that, open Rider, and go to the Rider Settings → Plugins. Click a gear icon, choose Install Plugin from Disk action, and then point it to the ZIP file you've downloaded.

Build

Prerequisites

• OpenJDK-compatible JDK version 8 or later (will be downloaded automatically during build), should include JavaFX
• .NET Core SDK 3.1 or later

Build

To build from terminal, execute this command:

$ ./gradlew buildPlugin

This action will use Gradle JVM Wrapper to automatically download the recommended JDK version that's used for builds, and will download a required Gradle version. If this isn't necessary, you could use your own versions of Gradle and JRE by running the build task with gradle buildPlugin.

After that, the plugin ZIP distribution will be created in the build/distributions directory.

Run

The following command will build the plugin and run it using a sandboxed instance of Rider (set the required version via build.gradle).

$ ./gradlew runIde

Test

First, set LOCAL_ENV_RUN and NO_FS_ROOTS_ACCESS_CHECK environment variables to true (to prevent downloading of test environment from JetBrains servers, and allow tests to access locally-installed tools), and then execute the following command:

$ ./gradlew test

Development

Architecture

This plugin consists of two parts: the backend one (written in C#) and the frontend one (written in Kotlin). Each part requires a corresponding IDE. To develop a backend, it's recommended to open AvaloniaRider.sln with JetBrains Rider. To develop a frontend, it's recommended to use IntelliJ IDEA (Community edition should be enough).

IDE Setup

After running ./gradlew at least once, set up your project SDK to the folder build/gradle-jvm/<sdk-name>/<subdirectory>. This JDK is guaranteed to contain all the components necessary to build the plugin.