Getting Started Requirements
Page Item: Requirements SLUG: getting-started-requirements
Lorum ipsum
Lorum ipsum
PLACE ECLIPSE CONTENT HERE TO ENTERED INTO THE KONTENT.AI-SPECIFIC ASSET
Here are the requirements for SonarLint to work properly.
- Eclipse Platform Requirement: the minimal version of the Eclipse platform that SonarLint supports. If you are not familiar with Eclipse versioning scheme, see here.
- JVM requirement: the minimal version of the JVM that is used to run Eclipse.
- Node.js requirement: only for JavaScript analysis
- SonarQube minimal requirement: only if using connected mode. Usually means that the next LTS is also supported.
| SonarLint Version | Eclipse Platform Requirement | JVM Requirement | Node.js Requirement | SonarQube Min Requirement (for connected mode) |
|---|---|---|---|---|
| 6.x | 4.6+ (Neon+) | 1.8+ | 7.9+ | |
| 7.x | 4.8+ (Photon+) | 11+ | 7.9+ | |
| 7.4 | 4.8+ (Photon+) | 11+ | 12.22+ | 7.9+ |
- Analysis of Java code requires JDT
- Analysis of C and C++ requires CDT
- Analysis of Cobol requires specific integration provided only by some Cobol IDEs, like IBM Developer for z Systems (IDz) or BMC Compuware Topaz Workbench.
Please also note that recent versions of SonarLint and of our analyzers require a JRE 11+ in order to run. To this date, IBM IDz has not yet added support to Java 11 (see a request ticket here). This means that for the moment, you can only run Cobol analysis in IDz by using the following versions of Sonar products:
- SonarQube 8.9 LTS
- SonarLint for Eclipse v6.2 (download link here)
PLACE INTELLIJ CONTENT HERE TO ENTERED INTO THE KONTENT.AI-SPECIFIC ASSET
Node.js >= 8.x is required to perform JavaScript or TypeScript analysis.
NOTE: ARE THERE MORE REQUIREMENTS? THE ABOVE WAS FOUND ON THE README PAGE
PLACE VISUAL STUDIO CONTENT HERE TO ENTERED INTO THE KONTENT.AI-SPECIFIC ASSET
The only thing you need to install is the VSIX (in versions prior to v4.34, additional steps were required for some languages).
Sonar’s JavaScript and TypeScript analyzers require specific Node.js versions to be installed on the machine. If no compatible version is found, the analysis will not be performed. See the table below for minimal required Node.js version per SonarLint version:
| SonarLint for Visual Studio Version | Minimal Required Node.js Version |
|---|---|
| v6.9 | Node.js v14.17 and higher |
| v6.8 | Node.js v12.22 and higher |
| v6.7 and earlier | Node.js v10 and higher, excluding Node.js v11 |
SonarLint for Visual will attempt to locate a compatible Node.js version on the machine by searching on the %PATH%. It will also check whether there is a Node.js installation as part of the current Visual Studio installation.
If SonarLint cannot find a compatible Node.js version, it will show a notification in a gold bar like the following:
The Output Window will contain additional information about the Node.js versions that were located:
You can also set the environment variable SONAR_NODEJS_PATH to specify a custom location. The value should be the full file path to the node executable e.g. c:\custom\node.exe.
The environment variable takes precedence over the automatic detection. You will need to restart Visual Studio after setting or changing the environment variable.
If the machine does not have a compatible version of Node.js, you can manually install one.
Node.js versions can be downloaded from the official website nodejs.org.
Both the 32-bit and 64-bit versions are supported.
The simplest installation method on Windows is to use the appropriate .msi.
From time to time the Sonar JavaScript/TypeScript analyzer will increase the minimum required Node.js version as older versions go out of support. The dropping of support will be announced in advance in the Community Forum (e.g. this post regarding the deprecation of Node.js v12 and dropping of support for Node.js vs10).
This page will be updated as the minimum required Node.js version changes.
PLACE VISUAL STUDIO CONTENT HERE TO ENTERED INTO THE KONTENT.AI-SPECIFIC ASSET