Creating new ReSharper and Rider plugin projects is performed using the dedicated dotnet new
template. The generator creates all the necessary project files based on a few template inputs.
Launch the New Project wizard via the action and provide the following information:
Download the plugin template from the GitHub Release page.
Install the plugin template by calling:
dotnet new --install JetBrains.ReSharper.SamplePlugin.*.nupkg
Unpack the template with your preferred plugin name:
dotnet new resharper-rider-plugin --name MyPlugin
If your plugin should only target ReSharper, you can pass the --resharper-only
switch.
If you plan to use GitHub Actions as your continuous integration/deployment (CI/CD) environment, you can pass the --github-actions
switch.
When extracting the template, for instance with --name MyPlugin
, it will create the following directory content:
MyPlugin âââ .github â âââ wrapper â âââ CI.yml â âââ Deploy.yml âââ .run â âââ rdgen (Unix).run.xml â âââ rdgen (Windows).run.xml â âââ rdgen.run.xml â âââ Rider (Unix).run.xml â âââ Rider (Windows).run.xml â âââ Rider - Frontend (Unix).run.xml â âââ Rider - Frontend (Windows).run.xml â âââ Rider.run.xml â âââ VisualStudio.run.xml âââ gradle â âââ wrapper â âââ gradle-wrapper.jar â âââ gradle-wrapper.properties âââ protocol â âââ src/main/kotlin/model/rider â âââ build.gradle âââ src â âââ dotnet â â âââ ReSharperPlugin.MyPlugin â â â âââ IMyPluginZone.cs â â â âââ ReSharperPlugin.MyPlugin.csproj â â â âââ ReSharperPlugin.MyPlugin.Rider.csproj â â âââ ReSharperPlugin.MyPlugin.Tests â â â âââ ReSharperPlugin.MyPlugin.Tests.csproj â â â âââ TestEnvironment.cs â â â âââ test â â â âââ data â â â âââ nuget.config â â âââ Directory.Build.props â â âââ Plugin.props â âââ rider/main â âââ kotlin/com/jetbrains/rider/plugins/myplugin â âââ resources â âââ META-INF â âââ plugin.xml âââ tools â âââ nuget.exe â âââ vswhere.exe âââ .gitattributes âââ .gitignore âââ CHANGELOG.md âââ README.md âââ ReSharperPlugin.MyPlugin.sln âââ build.gradle âââ buildPlugin.ps1 âââ gradle.properties âââ gradlew âââ gradlew.bat âââ publishPlugin.ps1 âââ runVisualStudio.ps1 âââ settings.gradle âââ settings.ps1
The gradlew and gradlew.bat files to bootstrap running Gradle on Windows, macOS, and Linux. These will also automatically install the required Amazon Corretto 11 SDK into the build/gradle-jvm directory.
The build.gradle file to build and deploy the plugin for ReSharper and Rider.
See the IntelliJ SDK help for more information about Gradle-Related Plugin Components.
The buildPlugin.ps1 and publishPlugin.ps1 files to build and deploy only the ReSharper plugin.
The gradle.properties, settings.ps1, plugin.xml, and Plugin.props files, containing information about plugin metadata (id, description, authors), dependency versions (ReSharper/ Rider SDK), and paths to solution and project files.
The Run/debug configurations for Rider/IntelliJ IDEA (.run directory) and the runVisualStudio.ps1 for PowerShell (--resharper-only
template extraction) to launch the plugin in an experimental instance of Rider or Visual Studio with ReSharper.
The src/dotnet directory with basic project files for ReSharper and Rider including a test project. The Directory.Build.props defines all common NuGet references for both.
The README.md and CHANGELOG.md files for documentation about the plugin. The first section of the CHANGELOG.md is automatically included in the plugin metadata. The README.md has predefined Shields.IO badges with RIDER_PLUGIN_ID
and RESHARPER_PLUGIN_ID
as placeholders that can be updated after the first deployment.
The .github/workflow directory (requires --github-actions
during template extraction) with predefined workflows for a continuous build (including Build
and Test
) and a deployment build.
Last modified: 04 July 2023
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4