Listen to build solution event in Rider

Implement something like this:

class BuildRunListener : SolutionExtListener<BuildModel> {

  override fun extensionCreated(lifetime: Lifetime, session: ClientProjectSession, model: BuildModel) {
    model.buildSession.viewNotNull(lifetime) { buildSessionLt, buildSession ->
      // Do your custom logic here
    }
  }
}

and then register in your plugin.xml like this:

<idea-plugin>
  <extensions defaultExtensionNs="com.intellij">
    <rd.solutionExtListener endpoint="IDE Frontend"
                            listener="your.package.BuildRunListener"/>

  </extensions>
</idea-plugin>

The buildSession object has properties such as result that you may subscribe and analyze.

 “SolutionExtListener” is not found in my code, I basically simply created a new “IDE Plugin” project in IntelliJ IDEA with no additional setup, and this extension point “rd.solutionExtListener” is also sending errors of not found.

 What version of Rider SDK do you use?

I am using Rider 2024.1.1, I do not know about any Rider SDK, I opened Intellij IDEA 2024.1, clicked on new “IDE Plugin” and that is it.

If you want to use Rider API, you are supposed to use Rider SDK. Take a look at the plugin template.

(Actually, it's the same process as for all the other IntelliJ-based IDEs: you set up the product name in your Gradle settings, and the APIs are available.)

Alright I set up the Rider SDK and now it is working the code you sent above.

How to subscribe to the buildSession.result to receive the compile start, compile success and compile fail events?

Try this:

buildSession.result.advise(buildSessionLt) {
  when (it.kind) {
    BuildResultKind.Successful, BuildResultKind.HasWarnings -> // build success
    BuildResultKind.HasErrors -> // build error
    BuildResultKind.Canceled -> // user cancellation
    BuildResultKind.Crashed -> // critical build error, MSBuild crashed
  }
}

Note that this event will be delivered asynchronously. Also, it may also be emitted on certain other operations, such as NuGet restore and publish/deployment.

If you are only interested in actual build operations, add a check for buildSession.operation is BuildTarget.

Great, my plugin is working exactly as I wanted, all I wanted is to play sounds during these events as I like to hear feedback from the compilation progress, amazing support.

Although the documentation leaves a lot to be desired, I was able to create this plugin in about 3 hours for Visual Studio but it took me days to create the same thing for Rider due to the extreme amount of noise I found in the process and the result was just 46 lines of code, if you did not tell me about this very obscure “SolutionExtListener<BuildModel>” I would probably just give up because this would be impossible for me to know this is the right listener to hear build events.