Connected mode configuration VSCode different sub-folders project keys

SonarQube for IDE VS Code
1
  • Operating system: Linux/Ubuntu 22/RedHat 8
  • SonarLint plugin version: latest viscose extension
  • Programming language you’re coding in: C/C++
  • Is connected mode used:
    • Connected to SonarCloud or SonarQube (and which version):

Hi there,

In general, I could manage to connect the Project in VSCode to the SonarQube server. The settings are stored inside the vscode parent folder under .vscode/settings.json.

My problem now is, that the folder setup used in VScode contains sub-folder as git submodules. Each submodule has its own sonar analysis configuration and SonarQube project assigned.

Now, in order to use sonarlint in VSCode, it would be necessary to not just connect the parent folder to SonarQube, instead each sub-folder would require a “Connected Mode” setting in its sub-folder.

Is this somehow possible ?

Can the .vscode/settings.json be extended by several server configurations, each using some kind of “baseDir” with respective sonar project key ?

Thanks for your help
Danny

3

Hello, welcome to the community! And thanks for your question.

For such a setup, I would recommend opening each git submodule as a workspace folder in VSCode, this would allow you to configure separate bindings for each folder.

5

Hi Jean-Baptiste,
this I know. However, this isn’t an option since it would require to switch between workspaces for development all the time.
We have the parent repo opened as a workspace which allows to develop in several sub-repos (submodules) and dereference symbols.
Then I would kindly request such a feature. Would that be possible ?
Danny

6

I don’t see a need to switch workspaces if the 3 submodules are open as folders in the same workspace.

Let’s imagine the following setup, starting with the folder structure:

rootDir
 |- my-project.code-workspace
 |- submodule1
 |   |- .vscode
 |       |- settings.json
 |- submodule2
 |   |- .vscode
 |       |- settings.json
 |- submodule3
     |- .vscode
         |- settings.json

Then in my-project.code-workspace, you would put:

{
  "folders": [
    {
      "path": "submodule1"
    },
    {
      "path": "submodule2"
    },
    {
      "path": "submodule3"
    }
  ]
}

If you then use “File” > “Open Workspace From File…” with this workspace file, you will have the 3 submodules open as workspace folders in the same workspace, and you will be able to bind each folder to a separate project on the server.

2 Likes
7

I didn’t know that :roll_eyes: :thinking:
I’ll tried that of course
Thx for that information

8

I managed to setup the workspace structure as you indicated.
It requires now, however, a compile_command.json to be located somewhere!?

Although, I have the Makefile Extension, it doesn’t seem to support such a workspace organization and I didn’t succeed to configure each .vscode/settings.json for the makefile extension to generate each compile_command.json separately :-/

I’ll continue to try, maybe something else to generate the compile_command.json …

9

Actually, I found the python compiledb module.
Each submodule folder now contains a compile_command.json file which should be used for sonar analysis. However, I’m still stuck, sonar analysis apparently are not triggered :disappointed:
I’ll come back to give more details …

10

The structure is now as you did show but each containing an additional compile_commands.json:

rootDir
 |- my-project.code-workspace
 |- submodule1
 |   |- compile_commands.json
 |   |- .vscode
 |       |- settings.json
 |- submodule2
 |   |- compile_commands.json
 |   |- .vscode
 |       |- settings.json
 |- submodule3
     |- compile_commands.json
     |- .vscode
         |- settings.json

and settings.json with this contents:

{
    "makefile.configurations": [
        {
            "name": "submodule1",
            "problemMatchers": [
                "$gcc"
            ],
            "makeArgs": []
        }
    ],
    "makefile.compileCommandsPath": "${workspaceFolder}/compile_commands.json",
    "sonarlint.connectedMode.project": {
        "connectionId": "<my-connection-id>",
        "projectKey": "<my-project-key>"
    },
    "sonarlint.pathToCompileCommands": "${workspaceFolder}/compile_commands.json"
}

In the SonarLint output I see that the analysis is started but also that other languages are tried:

[Debug - 09:37:00.368] * kubernetes: 6 active rules
[Debug - 09:37:00.368] * cpp: 403 active rules
[Debug - 09:37:00.368] Rule cpp:S5527 is enabled on the server, but not available in SonarLint
[Debug - 09:37:00.369] Rule cpp:S4830 is enabled on the server, but not available in SonarLint
[Debug - 09:37:00.369] * css: 23 active rules
[Debug - 09:37:00.369] Rule css:S4647 is enabled on the server, but not available in SonarLint
...
[Debug - 09:37:00.369] * c: 209 active rules
[Debug - 09:37:00.369] Rule c:S4830 is enabled on the server, but not available in SonarLint
[Debug - 09:37:00.369] Rule c:S5527 is enabled on the server, but not available in SonarLint
[Debug - 09:37:00.369] * go: 25 active rules
[Debug - 09:37:00.369] * js: 234 active rules
[Debug - 09:37:00.369] Rule javascript:S3785 is enabled on the server, but not available in SonarLint
...
[Debug - 09:37:00.369] Rule jssecurity:S5146 is enabled on the server, but not available in SonarLint
...
[stderr] Nov 06, 2023 9:37:01 AM org.eclipse.lsp4j.jsonrpc.RemoteEndpoint handleCancellation
[stderr] WARNING: Unmatched cancel notification for request id 103
...
[Debug - 09:37:00.371] Rule javascript:S6270 is enabled on the server, but not available in SonarLint
[Debug - 09:37:00.371] * py: 206 active rules
[Debug - 09:37:00.371] Rule pythonsecurity:S2091 is enabled on the server, but not available in SonarLint
...
[Debug - 09:37:00.371] Rule pythonbugs:S5633 is enabled on the server, but not available in SonarLint
[Debug - 09:37:00.372] * secrets: 7 active rules
[Debug - 09:37:00.372] * apex: 41 active rules
[Debug - 09:37:00.372] * docker: 7 active rules
[Debug - 09:37:00.372] * plsql: 132 active rules
[Debug - 09:37:00.372] * cs: 117 active rules
[Debug - 09:37:00.372] * java: 506 active rules
[Debug - 09:37:00.372] Rule javasecurity:S6173 is enabled on the server, but not available in SonarLint
...
[Debug - 09:37:00.373] * cobol: 74 active rules
[Debug - 09:37:00.373] * web: 28 active rules
[Debug - 09:37:00.373] * xml: 24 active rules
[Debug - 09:37:00.373] * php: 197 active rules
[Debug - 09:37:00.373] Rule phpsecurity:S2083 is enabled on the server, but not available in SonarLint
...
[Debug - 09:37:00.374] * terraform: 49 active rules
[Debug - 09:37:00.374] * cloudformation: 26 active rules
[Debug - 09:37:00.375] * ts: 223 active rules
[Debug - 09:37:00.375] Rule typescript:S1128 is enabled on the server, but not available in SonarLint
...
[Debug - 09:37:00.411] * yaml: 0 active rules
[Debug - 09:37:00.425] Start analysis

With that I can see now the issues in the Problems view.

Is there a way to switch off all not used/relevant languages ?

11

By my last summary I managed to setup the project structure and analysis.

For the last question of switching off certain language analysis I opened this thread.

1 Like
12

This topic was automatically closed 7 days after the last reply. New replies are no longer allowed.