SonarQube support for Visual Studio Code extension

SonarQube support for Visual Studio Code that provides on-the-fly feedback to developers on new bugs and quality issues injected into their code.
Non-official realization of SonarLint for VS Code.

TLDR: Quick Setup for Standalone mode

• Just open your project dir
• Don't create a project config
• Supported languages: JS, PHP, Python and Java

TLDR: Quick Setup for Connected mode

• Create global config via SonarQube Inject: Create global config with credentials to servers and fill the values
• Create project config via SonarQube Inject: Create local sonarlint config with project binding and fill the values
• Update project bindings via SonarQube Inject: Update bindings to SonarQube server - it can take a lot of time (~1-2 min) on first binding

Connected mode

You can run analysis with connection to your SonarQube server. To do this you need to create two small config files.

Create and edit first file - global config - via SonarQube Inject: Create global config with credentials to servers command. In this file you need to define your SonarQube servers - id's, url, credentials (auth token or login and password pair) and organizationKey, if your SonarQube server has enabled Organization mode.

Example:

{
  "$schema": "https://gist.github.com/nixel2007/18b4e86ef1d98fb60b901ca4fcecb0e9/raw/bca2e6d461143f11aabe825deb596755893efbf9/global.json",
  "servers": [
    {
      "id": "localhost",
      "url": "http://localhost:9000",
      "token": "fe299234962a304f63386db4ffa0cbdb22367b52"
    }
  ]
}

Create and edit second file - project config - via SonarQube Inject: Create local sonarlint config with project binding command. In this file you need to define the serverId (id from global.json file) and projectKey - key of project at your SonarQube server.

Example:

{
    "$schema": "https://raw.githubusercontent.com/silverbulleters/sonarqube-inject-vsc/master/schemas/sonarlint.json",
    "serverId": "localhost",
    "projectKey": "my-project"
}

Don't forget to run SonarQube Inject: Update bindings to SonarQube server command in VSCode to update server bindings.

If you have any troubles or questions please start discussion in Issues page or Gitter.

SonarQube server with enabled Organization mode (eg. SonarCloud.io)

To analyze projects on SonarQube servers with Organizations you need to add organizationKey property in your global.json configuration file.

{
    "servers": [
        {
            "id": "localhost",
            "url": "http://localhost:9000",
            "token": "c8ecbc03f615ddbc1d97ad478ee024b45b6784c1",
            "organizationKey": "my-organization-key"
        }
    ]
}

You need to add new entry to servers array for every organization you want to add.

Extension settings

• sonarqube-inject.enableLinter
  Enables linting projects through SonarLint.
  Type: Boolean
  Default value: true.

• sonarqube-inject.sonarlintPath
  Full path to sonarlint binary. Fill this only if you use custom version of sonarlint.
  Type: String
  Format: relative (from workspace root) or absulute to sonarlint executable.
  Default value: tools/sonarlint-cli/bin/sonarlint (relative to the extension path).

• sonarqube-inject.sourcePath
  GLOB pattern to identify source files.
  Type: String
  Format: GLOB syntax is close to regexp and can be found on Wikipedia article.
  Default value: src/**/*.*.
  Example: src/main/**/*.java

• sonarqube-inject.testsPath
  GLOB pattern to identify test files.
  Type: String
  Format: GLOB syntax is close to regexp and can be found on Wikipedia article.
  Default value: empty.
  Example: src/test/**/*.java

• sonarqube-inject.exclude
  GLOB pattern to exclude files.
  Type: String
  Format: GLOB syntax is close to regexp and can be found on Wikipedia article.
  Default value: empty.
  Example: **/*.properties

• sonarqube-inject.sourceEncoding
  Character encoding of the source files.
  Type: String
  Default value: UTF-8.

• sonarqube-inject.windowsConsoleEncoding
  Output encoding of Windows command line. Used only on Windows.
  Type: String
  Default value: windows-1251.

• sonarqube-inject.unixConsoleEncoding
  Output encoding of command line on *nix systems.
  Type: String
  Default value: utf8.

Hint:
If you need to specify multiply paths in GLOB patterns, you can use `{path1,path2}' notation.

Extension commands

• SonarQube Inject: Analyze current project
  Runs full analysis on current project

• SonarQube Inject: Analyze current file
  Runs analysis on current file

• SonarQube Inject: Create global config with credentials to servers
  Creates and opens a global config file to set server and credentials info

• SonarQube Inject: Create local sonarlint config with project binding
  Creates and opens a local config file with current project info

• SonarQube Inject: Update bindings to SonarQube server
  Reconnects to SonarQube server and updates all links.

Limitations

Currently works only with special sonarlint-cli version bundled with the extension. Source code can be found here.

Supported languages

• java
• javascript
• php
• python
• cobol
• abap
• plsql
• swift
• bsl

Screenshot