Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/adisreyaj/vscode-sonarqube-status

Get the result of the Sonar Qube analysis from your CICD pipeline right inside VSCode.
https://github.com/adisreyaj/vscode-sonarqube-status

Last synced: 3 days ago
JSON representation

Get the result of the Sonar Qube analysis from your CICD pipeline right inside VSCode.

Awesome Lists containing this project

README

        



Logo

SonarQube Project Status


VSCode extension to view SonarQube results right inside your favorite IDE - VSCode

SonarQube is a static code analyzer for your project. It makes sure your code is up to the mark and will not break in
production.

![SonarQube Status Results](https://raw.githubusercontent.com/adisreyaj/vscode-sonarqube-status/master/images/sonarqube-vscode-status.jpg)

## How to Use

1. Install the Extension and Make sure it is activated.
2. Click on the SonarQube logo on the activity bar or run the command from Command Palette:

```
SonarQube: Get Report
```

3. This will create a `project.json` file in `.vscode` folder.
4. Make sure to add the details:

### Using Password Auth

```json
{
"project": "adisreyaj_compito",
"sonarURL": "https://sonarcloud.io",
"auth": {
"username": "",
"password": ""
}
}
```

### Using Token Auth

```json
{
"project": "adisreyaj_compito",
"sonarURL": "https://sonarcloud.io",
"auth": {
"token": ""
}
}
```

The `auth` is optional property. It's only required for private SonarQube projects. You can etither use the **
username/password** based authentication or **token-based** authentication.

5. Run the command again and you should see the report on the SonarQube section in the activity bar.

## Features

1. Status bar item added for quickly knowing the Quality Gate Status without having to click elsewhere.

![Sonarqube passed](https://raw.githubusercontent.com/adisreyaj/vscode-sonarqube-status/master/images/sonar-passed.png)

![Sonarqube failed](https://raw.githubusercontent.com/adisreyaj/vscode-sonarqube-status/master/images/sonar-failed.png)

2. Full details in the Sonarqube Dedicated section

![Sonarqube Full Result](https://raw.githubusercontent.com/adisreyaj/vscode-sonarqube-status/master/images/sonar-full-details.png)

3. Refresh button to quickly refresh the results.

## Roadmap

See the [open issues](https://github.com/adisreyaj/vscode-sonarqube-status/issues) for a list of proposed features (and
known issues).

## License

Distributed under the MIT License. See `LICENSE` for more information.

## Show your support

Please ⭐️ this repository if this project helped you!