JetBrains Rider Plugin Template

This is a template of plugin for JetBrains Rider, including:

• a backend part,
• a frontend part,
• a protocol to connect between those,
• an integration test example.

Installing Template

From NuGet

$ dotnet new install FVNever.Rider.Plugin.Template

If you need a preview version, then specify a version explicitly, e.g.

$ dotnet new install FVNever.Rider.Plugin.Template::251.0.0-eap08

From Sources

1. Fork or clone the repository.
2. Create a local NuGet package:

   $ dotnet pack -o ./output

   Your NuGet package will be generated in the ./output/ folder.
3. Install the template:

   $ dotnet new install ./output/FVNever.Rider.Plugin.Template.*.nupkg

Using the Template

Create a project from the template:

$ dotnet new jetbrains-rider-plugin [--name YourNewPlugin] [--output YourNewPluginPath]

Execute the following shell command in the plugin directory. It will prepare it for work:

$ ./gradlew prepare

After that, the plugin is ready for work. See the README.md file among the generated sources to learn how to build, test, and run the plugin.

Versioning

The template follows the Rider internal version schema: e.g. a version of the template corresponding to Rider 2024.2 would have a version 242.x.y, where x.y partially follows Semantic Versioning 2.0.0: y is incremented for bugfix releases, x is incremented for everything else.

Preview versions of Rider (if any) are targeted by the preview versions of the template.

Documentation

• Changelog
• Template Contributor Guide
• Template Maintainer Guide

License

Apache 2 License, see the LICENSE file.

Copyright 2024-2026 rider-plugin-template contributors.