https://github.com/fornever/rider-plugin-template
JetBrains Rider plugin template
https://github.com/fornever/rider-plugin-template
Last synced: 3 months ago
JSON representation
JetBrains Rider plugin template
- Host: GitHub
- URL: https://github.com/fornever/rider-plugin-template
- Owner: ForNeVeR
- License: apache-2.0
- Created: 2024-05-09T15:09:22.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-06-17T00:19:18.000Z (about 1 year ago)
- Last Synced: 2025-06-17T01:27:34.034Z (about 1 year ago)
- Language: Kotlin
- Size: 2.55 MB
- Stars: 7
- Watchers: 1
- Forks: 3
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
JetBrains Rider Plugin Template [![NuGet package][nuget.badge]][nuget.page] [![JetBrains Team][badge.jetbrains-team]][jetbrains.opensource]
===============================
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
```console
$ dotnet new install FVNever.Rider.Plugin.Template
```
If you need a preview version, then specify a version explicitly, e.g.
```console
$ 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:
```console
$ dotnet pack -o ./output
```
Your NuGet package will be generated in the `./output/` folder.
3. Install the template:
```console
$ dotnet new install ./output/FVNever.Rider.Plugin.Template.*.nupkg
```
Using the Template
------------------
Create a project from the template:
```console
$ dotnet new jetbrains-rider-plugin [--name YourNewPlugin] [--output YourNewPluginPath]
```
Execute the following shell command in the plugin directory. It will prepare it for work:
```console
$ ./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][semver]: `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][docs.changelog]
- [Template Contributor Guide][docs.contributing]
- [Template Maintainer Guide][docs.maintaining]
License
-------
Apache 2 License, see [the `LICENSE` file][docs.license].
Copyright 2024-2026 rider-plugin-template contributors.
[badge.jetbrains-team]: https://jb.gg/badges/team.svg
[docs.changelog]: CHANGELOG.md
[docs.contributing]: CONTRIBUTING.md
[docs.license]: LICENSE
[docs.maintaining]: MAINTAINING.md
[jetbrains.opensource]: https://github.com/JetBrains/
[nuget.badge]: https://img.shields.io/nuget/v/FVNever.Rider.Plugin.Template
[nuget.page]: https://www.nuget.org/packages/FVNever.Rider.Plugin.Template
[semver]: https://semver.org/spec/v2.0.0.html