Extensions
JetBrains Rider Plugin
The GauntletCI plugin for JetBrains Rider surfaces behavioral change risk findings as inline editor annotations - red and yellow squiggles with tooltip links to the full rule documentation.
Requirements
- JetBrains Rider 2024.2 or later
- GauntletCI CLI:
dotnet tool install -g GauntletCI
Install
Via the JetBrains Marketplace
- Open Rider and go to Settings > Plugins.
- Select the Marketplace tab.
- Search for GauntletCI and click Install.
- Restart Rider when prompted.
Via .zip (manual)
- Download the latest plugin
.zipfrom GitHub Releases. - Go to Settings > Plugins > gear icon > Install Plugin from Disk.
- Select the downloaded
.zipand restart Rider.
How to use
With a .NET project open, run the analysis from the menu:
Inline annotation mockup
Hovering over an annotated line shows the finding message and a link to the rule documentation on gauntletci.com. Block findings render as red squiggles, Warn as yellow squiggles, and Advisory as grey weak-warning underlines.
Annotation severity mapping
| GauntletCI severity | Rider annotation | Color |
|---|---|---|
| Block | Error | Red squiggle |
| Warn | Warning | Yellow squiggle |
| Advisory | Weak Warning | Grey underline |
Troubleshooting
No annotations appear after analysis
Analysis runs against the latest commit. Ensure you have committed your changes. Check the Event Log in Rider for any errors from the GauntletCI process.
CLI not found
Verify gauntletci is on your PATH by running it in a terminal. On macOS, Rider may not inherit the full user PATH - use the full path in plugin settings or add it to ~/.zshrc and restart Rider.
Source and releases
Source code and releases are at EricCogen/GauntletCI-Rider.
