Skip to content

update sonarqube setup details #773

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gtryus merged 1 commit into from
Oct 21, 2026
Merged

update sonarqube setup details #773

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 43 additions & 3 deletions docs/full-scan.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,47 @@ docker run -d --name sonarqube -p 9000:9000 sonarqube:community

3. Choose Create project → Local project, use the key `apm-vite`, and generate a token.

4. Add a `sonar-project.properties` file at the repo root:
4. Setup a admin token on Administration, Security, User.

Put the token in your environment SONAR_TOKEN

5. Local settings `code` (and `cursor`) settings

Set up using the `SonarQube` side panel settings.

Check your settings file C:\Users\<Your user>\AppData\Roaming\<Code or Cursor>\User\settings.json

```json
"sonarlint.pathToNodeExecutable": "C:\\Users\\<your user>\\AppData\\Local\\mise\\installs\\node\\22.23.3\\node.exe",
"sonarlint.connectedMode.connections.sonarqube": [
{
"serverUrl": "http://localhost:9000",
"token": "squ_<your token>",
"connectionId": "http-localhost-9000",
},
],
```

6. Setup `SonarQube-mcp` (likely in C:\Users\<Your user>\AppData\Roaming\<Code or Cursor>\User\mcp.json)

```json
"sonarqube": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"SONARQUBE_TOKEN",
"sonarsource/sonarqube-mcp"
],
"env": {
"SONARQUBE_TOKEN": "squ_<your token>"
}
}
```

7. Add a `sonar-project.properties` file at the repo root:

```json
sonar.projectKey=apm-vite
Expand All @@ -33,14 +73,14 @@ sonar.javascript.lcov.reportPaths=web/coverage/lcov.info

The two localization files are excluded because they're generated.

5. Run the scanner. It needs no install because it runs through npx. The token is the `env:SONAR_TOKEN` environment variable (`${env:SONAR_TOKEN}`):
8. Run the scanner. It needs no install because it runs through npx. The token is the `env:SONAR_TOKEN` environment variable (`${env:SONAR_TOKEN}`):

```powershell
cd web; npm run test:coverage; cd .. \# optional: adds coverage data to the report
npx sonarqube-scanner "-Dsonar.host.url=http://localhost:9000" "-Dsonar.token=${env:SONAR_TOKEN}"
```

6. Look at the results under Issues, filtered by Type = Code Smell (newer versions call it "Maintainability"). You can sort by severity, rule or file.
9. Look at the results under Issues, filtered by Type = Code Smell (newer versions call it "Maintainability"). You can sort by severity, rule or file.

I've updated [sonar-project.properties](vscode-webview://1vvl62agp8nmso4u3onasscp49436tio9t463rhlr0pga78gsjbi/sonar-project.properties) but haven't run the scan, so it's not confirmed that this fixes the error. I changed three things:

Expand Down
Loading