AvaloniaRider

Install

Development releases (may be unstable)

To install a development release (automatically published for every push into a development 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.

How to Use

Previewer

Make sure your Avalonia project is built, open a XAML file, and you'll see a XAML preview in Rider.

It's possible to interact with the previewer using the mouse, and zoom with Ctrl+Scroll Wheel.

File templates

Right-click a directory or an Avalonia-enabled project, and choose among the available file templates:

• Avalonia User Control
• Avalonia Templated control
• Avalonia Window
• Avalonia Resource Dictionary
• Avalonia Styles

Live templates

Type in editor to use Live templates:

• directProperty
• styledProperty
• attachedAvaloniaProperty

Build

Prerequisites

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

Build

To build the plugin, execute this shell 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

Execute the following shell 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).

Getting Started

If you just want to start developing the plugin and don't want to build it (yet), then execute this shell command:

$ ./gradlew prepare

This will download the initial set of dependencies necessary for the plugin development and set up Rider SDK for .NET part of the project. After that, open either the frontend part of the plugin (the directory containing build.gradle.kts) using IntelliJ IDEA, or the AvaloniaRider.sln using Rider.

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.