https://github.com/yagoluiz/sonar-dotnet-vscode

Sonar Dotnet is an Visual Studio Code extensions to C#
https://github.com/yagoluiz/sonar-dotnet-vscode

dotnet sonar vscode-extension

Last synced: 3 months ago
JSON representation

Sonar Dotnet is an Visual Studio Code extensions to C#

• Host: GitHub
• URL: https://github.com/yagoluiz/sonar-dotnet-vscode
• Owner: yagoluiz
• License: mit
• Created: 2020-06-07T02:52:25.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2022-12-30T20:34:10.000Z (almost 3 years ago)
• Last Synced: 2024-05-03T03:44:25.874Z (over 1 year ago)
• Topics: dotnet, sonar, vscode-extension
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=yagoluiz.sonar-dotnet-vscode
• Size: 219 KB
• Stars: 3
• Watchers: 0
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Sonar Dotnet for Visual Studio Code

Sonar Dotnet is an Visual Studio Code extensions that helps you detect and fix quality issues as you write code in C#.

## Features

Open the **Command Palette** and search *Sonar Dotnet*.

![Lint](./img/sonar-dotnet-palette.png)

## How to Use

### Lint

1. Set your desired path in terminal

2. Select **Sonar Dotnet: Lint** in Command Palette

**Result:**

![Lint](./img/sonar-dotnet-lint.png)

3. Execute *dotnet build* command

**Result:**

![Lint](./img/sonar-dotnet-build.png)

Once configured in the project it is no longer necessary to run the lint again.

## Requirements

1. The Sonar Dotnet needs a [.NET Core 2.0+](https://dotnet.microsoft.com/download).

2. Install tool [dotnet-sonarscanner](https://docs.sonarqube.org/latest/analysis/scan/sonarscanner-for-msbuild/).

> *dotnet tool install --global dotnet-sonarscanner*

## Extension Settings

Configure *organizationKey, token and serverUrl* properties in user settings:

![Settings](./img/sonar-dotnet-settings.png)

Field *organizationKey* and *serverUrl* is **optional**. Server url default is SonarCloud: https://sonarcloud.io.

```json

{

    "sonar-dotnet-vscode.connection.sonar": {

        "organizationKey": "",

        "token": "",

        "serverUrl": ""

    }

}

```

Configure *project key* in configuration file **.vscode/settings.json**.

```json

{

    "sonar-dotnet-vscode.connection.project": {

        "projectKey": ""

    }

}

```

## Release Notes

See the [CHANGELOG](./CHANGELOG) for more information.

## License

Licensed under the [MIT](./License).