https://github.com/soloplan/resharper-clt-plugin

SonarQube plugin for ReSharper command line tools.
https://github.com/soloplan/resharper-clt-plugin

csharp inspectcode resharper sonarqube sonarqube-plugin sonarqube-scanner

Last synced: 4 months ago
JSON representation

SonarQube plugin for ReSharper command line tools.

• Host: GitHub
• URL: https://github.com/soloplan/resharper-clt-plugin
• Owner: Soloplan
• License: apache-2.0
• Created: 2018-04-04T14:25:30.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2025-08-12T05:57:48.000Z (5 months ago)
• Last Synced: 2025-08-12T07:23:12.583Z (5 months ago)
• Topics: csharp, inspectcode, resharper, sonarqube, sonarqube-plugin, sonarqube-scanner
• Language: Java
• Size: 425 KB
• Stars: 14
• Watchers: 4
• Forks: 5
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
[![Build Status](https://travis-ci.com/Soloplan/resharper-clt-plugin.svg?branch=master)](https://travis-ci.com/Soloplan/resharper-clt-plugin)

# SonarQube ReSharper CLT Plugin

A SonarQube plugin for the ReSharper Command Line Tools.

## Description

This plugin enables the analysis of C# and VisualBasic.NET source files contained in .NET projects using the output of the InspectCode [JetBrains ReSharper Command Line Tool](https://www.jetbrains.com/resharper/features/command-line.html).

* Supports the most recent version of the [JetBrains ReSharper Command Line Tools](https://www.jetbrains.com/resharper/download/index.html#section=resharper-clt) (at least version 2020.1.3)

* Compatible with [SonarQube 7.9.x (LTS)](https://www.sonarqube.org/downloads/)

* Compatible with the [SonarC# Plugin](https://docs.sonarqube.org/pages/viewpage.action?pageId=1441900) in version 7.5

* Compatible with the [SonarVB Plugin (Visual Basic .NET)](https://docs.sonarqube.org/display/PLUG/SonarVB) in version 5.2

## Properties declared/used by this plugin

|    Property     |   Description  |

| --------------- | -------------- |

| `resharper.clt.solutionFile`     | The path to the Visual Studio solution file (`.sln`) parsed by the InspectCode command line tool. |

| `resharper.clt.cs.reportPath`    | Used when analyzing C# projects. Defines the path to the XML report file generated by the InspectCode command line tool to be parsed by the plugin. |

| `resharper.clt.vbnet.reportPath` | Used when analyzing VisualBasic.NET projects. Defines the path to the XML report file generated by the InspectCode command line tool to be parsed by the plugin. |

| `resharper.clt.xsd.validation`   | Enables XML Schema validation of the XML report file generated by the InspectCode command line tool. (not yet working) |

## How to use

A more in-depth guide on how to analyze projects that are built using MSBuild can be found in article [Analyzing with SonarScanner for MSBuild](https://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner+for+MSBuild) of the official SonarQube documentation.

  1. Install the ReSharper Command Line Tools plugin (see [Installing a Plugin - SonarQube Documentation - Doc SonarQube](https://docs.sonarqube.org/display/SONAR/Installing+a+Plugin) for more details)

  2. Enable at least one of the rules provided by the plugin in your quality profile (see [Quality Profiles](https://docs.sonarqube.org/display/SONAR/Quality+Profiles) for more details)

  3. Open a command prompt, preferably the Developer Command prompt for Visual Studio

  4. Navigate to the root folder of the project/solution you want to build

  5. Execute the following steps:

      1. Begin the SonarQube analysis and provide the values for the required properties \

         `SonarScanner.MSBuild.exe begin /k:"sonarqube_project_key" /n:"sonarqube_project_name" /d:sonar.login="%SONAR_LOGIN_TOKEN%" /d:resharper.clt.cs.reportPath="inspectcode_result.xml" /d:resharper.clt.solutionFile="%SOLUTION_FILE%"`

      2. Build the project \

         `msbuild.exe "%SOLUTION_FILE"`

      3. Run ReSharper Command Line Tool `InspectCode.exe` \

         `inspectcode.exe /output="resharper.xml" "%SOLUTION_FILE%"`

      4. End the SonarQube analysis, which will upload the issues to the server \

         `SonarScanner.MSBuild.exe end /d:sonar.login=%SONAR_LOGIN_TOKEN%`

## Configuration

It's possible to override the SonarSeverity for particular rules by providing a custom `sonarqube_rule_overrides.xml`. This can be either located in the base folder of the application or at a

location specified with the environment variable: `SONAR_PLUGIN_INSPECTCODE_OVERRIDEFILE=C:\config\my-sonar-inspectcode-rule-override.xml`.

## Updating the plugin for a new ReSharper version

The following command can be used to dump the rules into an XML file that is used by this plugin.

```bat

inspectcode.exe -f="xml" --dumpIssuesTypes --output="inspectcode_issue_definitions.xml" --no-buildin-settings 

```

After dumping the new ruleset, it is mandatory to check all the new rules and adjust the `sonarqube_rule_overrides.xml` accordingly, to account for any rules that should be categorized differently by default.

## License

This project is licensed under the Apache License 2.0 - see the [LICENSE](./LICENSE) file for details.